当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
46 Star 179 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.net.http.d.ts 172.60 KB
一键复制 编辑 原始数据 按行查看 历史
pjie131 提交于 24天前 . support gmssl
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289
/*
* Copyright (c) 2021-2023 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
*/
import type { AsyncCallback, Callback } from './@ohos.base';
import type connection from './@ohos.net.connection';
/**
* Provides http related APIs.
* @namespace http
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Provides http related APIs.
* @namespace http
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Provides http related APIs.
* @namespace http
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace http {
/**
* Http Proxy Configuration Information.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Http Proxy Configuration Information.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 11
*/
/**
* Http Proxy Configuration Information.
* @typedef { connection.HttpProxy }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
type HttpProxy = connection.HttpProxy;
/**
* Creates an HTTP request task.
* @returns { HttpRequest } the HttpRequest of the createHttp.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Creates an HTTP request task.
* @returns { HttpRequest } the HttpRequest of the createHttp.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Creates an HTTP request task.
* @returns { HttpRequest } the HttpRequest of the createHttp.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
function createHttp(): HttpRequest;
/**
* Enum for Address Family
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @since 15
*/
export enum AddressFamily {
/**
* Default, can use addresses of all IP versions that your system allows.
* @syscap SystemCapability.Communication.NetStack
* @since 15
*/
DEFAULT = 'CURL_IPRESOLVE_WHATEVER',
/**
* ONLYV4 Uses only IPv4 addresses.
* @syscap SystemCapability.Communication.NetStack
* @since 15
*/
ONLY_V4 = 'CURL_IPRESOLVE_V4',
/**
* ONLYV6 Uses only IPv6 addresses.
* @syscap SystemCapability.Communication.NetStack
* @since 15
*/
ONLY_V6 = 'CURL_IPRESOLVE_V6'
}
/**
* Specifies the type and value range of the optional parameters in the HTTP request.
* @interface HttpRequestOptions
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Specifies the type and value range of the optional parameters in the HTTP request.
* @interface HttpRequestOptions
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Specifies the type and value range of the optional parameters in the HTTP request.
* @interface HttpRequestOptions
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export interface HttpRequestOptions {
/**
* Request method,default is GET.
* @type {?RequestMethod}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Request method,default is GET.
* @type {?RequestMethod}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Request method,default is GET.
* @type {?RequestMethod}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
method?: RequestMethod;
/**
* Additional data of the request.
* extraData can be a string or an Object (API 6) or an ArrayBuffer(API 8).
* @type {?string | Object | ArrayBuffer}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Additional data of the request.
* extraData can be a string or an Object (API 6) or an ArrayBuffer(API 8).
* @type {?string | Object | ArrayBuffer}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Additional data of the request.
* extraData can be a string or an Object (API 6) or an ArrayBuffer(API 8).
* @type { ?(string | Object | ArrayBuffer) }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
extraData?: string | Object | ArrayBuffer;
/**
* Data type to be returned. If this parameter is set, the system preferentially returns the specified type.
* @type {?HttpDataType}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Data type to be returned. If this parameter is set, the system preferentially returns the specified type.
* @type {?HttpDataType}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Data type to be returned. If this parameter is set, the system preferentially returns the specified type.
* @type {?HttpDataType}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
expectDataType?: HttpDataType;
/**
* default is true
* @type {?boolean}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* default is true
* @type {?boolean}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* default is true
* @type {?boolean}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
usingCache?: boolean;
/**
* [1, 1000], default is 1.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* [1, 1000], default is 1.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* [1, 1000], default is 1.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
priority?: number;
/**
* HTTP request header. default is 'content-type': 'application/json'
* @type {?Object}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* HTTP request header. default is 'content-type': 'application/json'
* @type {?Object}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* HTTP request header. default is 'content-type': 'application/json'
* @type {?Object}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
header?: Object;
/**
* Read timeout period. The default value is 60,000, in ms.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Read timeout period. The default value is 60,000, in ms.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Read timeout period. The default value is 60,000, in ms.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
readTimeout?: number;
/**
* Connection timeout interval. The default value is 60,000, in ms.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Connection timeout interval. The default value is 60,000, in ms.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Connection timeout interval. The default value is 60,000, in ms.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
connectTimeout?: number;
/**
* default is automatically specified by the system.
* @type {?HttpProtocol}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* default is automatically specified by the system.
* @type {?HttpProtocol}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* default is automatically specified by the system.
* @type {?HttpProtocol}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
usingProtocol?: HttpProtocol;
/**
* If this parameter is set as type of boolean, the system will use default proxy or not use proxy.
* If this parameter is set as type of HttpProxy, the system will use the specified HttpProxy.
* @type {?boolean | HttpProxy}
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* If this parameter is set as type of boolean, the system will use default proxy or not use proxy.
* If this parameter is set as type of HttpProxy, the system will use the specified HttpProxy.
* @type { ?(boolean | HttpProxy) }
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 11
*/
/**
* If this parameter is set as type of boolean, the system will use default proxy or not use proxy.
* If this parameter is set as type of HttpProxy, the system will use the specified HttpProxy.
* @type { ?(boolean | HttpProxy) }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
usingProxy?: boolean | HttpProxy;
/**
* If this parameter is set, the system will use ca path specified by user, or else use preset ca by the system.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* If this parameter is set, the system will use ca path specified by user, or else use preset ca by the system.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 11
*/
/**
* If this parameter is set, the system will use ca path specified by user, or else use preset ca by the system.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
caPath?: string;
/**
* A PEM representation of a certificate. The system will create an X.509 certificate object in the SSL process.
* If the caPath option is set, the caData option will be ignored.
* Certificate chain is not supported.
* Maxium length is 8000 Bytes.
* @type { ?string }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 20
*/
caData?: string;
/**
* Which secure communication protocol is used, TLS (by defaul) or TLCP.
* If TLCP is used, all TLS related options, such as caPath, caData and clientCert, are ignored.
* @type { ?SslType }
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 20
*/
sslType?: SslType;
/**
* Support the application to pass in client certificates, allowing the server to verify the
* client's encryption identity.
* @type { ?ClientCert }
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 20
*/
clientEncCert?: ClientCert;
/**
* Used to set to uploading or downloading the start bytes. The default value is 0.
* HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests.
* For HTTP PUT uploads this option should not be used, since it may conflict with other options.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Used to set to uploading or downloading the start bytes. The default value is 0.
* HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests.
* For HTTP PUT uploads this option should not be used, since it may conflict with other options.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
resumeFrom?: number;
/**
* Used to set to uploading or downloading the end bytes. Translate to the end if not set.
* HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests.
* For HTTP PUT uploads this option should not be used, since it may conflict with other options.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Used to set to uploading or downloading the end bytes. Translate to the end if not set.
* HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests.
* For HTTP PUT uploads this option should not be used, since it may conflict with other options.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
resumeTo?: number;
/**
* Support the application to pass in client certificates, allowing the server to verify the client's identity.
* @type {?ClientCert}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Support the application to pass in client certificates, allowing the server to verify the client's identity.
* @type {?ClientCert}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
clientCert?: ClientCert;
/**
* If this parameter is set, incoming DNS resolution server URL for the DoH server to use for name resolving.
* The parameter must be URL-encoded in the following format: "https://host:port/path".
* It MUST specify an HTTPS URL.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* If this parameter is set, incoming DNS resolution server URL for the DoH server to use for name resolving.
* The parameter must be URL-encoded in the following format: "https://host:port/path".
* It MUST specify an HTTPS URL.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
dnsOverHttps?: string;
/**
* If this parameter is set, use the specified DNS server for DNS resolution.
* Multiple DNS resolution servers can be set up, with a maximum of 3 servers.
* Only take the first three if there are more than three.
* @type {?Array<string>}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* If this parameter is set, use the specified DNS server for DNS resolution.
* Multiple DNS resolution servers can be set up, with a maximum of 3 servers.
* Only take the first three if there are more than three.
* @type {?Array<string>}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
dnsServers?: Array<string>;
/**
* The maximum limit of the response body. The default value is 5 * 1024 * 1024, in Byte.
* The maximum value is 100 * 1024 *1024, in Byte.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The maximum limit of the response body. The default value is 5 * 1024 * 1024, in Byte.
* The maximum value is 100 * 1024 *1024, in Byte.
* @type {?number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
maxLimit?: number;
/**
* The data fields which is supported by the HTTP protocol to post
* forms and by the SMTP and IMAP protocols to provide
* the email data to send/upload.
* @type {?Array<MultiFormData>}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The data fields which is supported by the HTTP protocol to post
* forms and by the SMTP and IMAP protocols to provide
* the email data to send/upload.
* @type {?Array<MultiFormData>}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
multiFormDataList?: Array<MultiFormData>;
/**
* Certificate pinning option. If server certificate's digest does not match
* {@link CertificatePinning.publicKeyHash}, request will fail.
* @type {?(CertificatePinning | CertificatePinning[])}
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
certificatePinning?: CertificatePinning | CertificatePinning[];
/**
* Certificate authority(CA) which is used to verify the remote server's identification.
* @type {?RemoteValidation}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
remoteValidation?: RemoteValidation;
/**
* TLS option.
* @type {?TlsOptions}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
tlsOptions?: TlsOptions;
/**
* HTTP server authentication settings. No authentication by default.
* @type {?ServerAuthentication}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
serverAuthentication?: ServerAuthentication;
/**
* Address family option.
* @type {?AddressFamily}
* @syscap SystemCapability.Communication.NetStack
* @since 15
*/
addressFamily?: AddressFamily;
}
/**
* HTTP server authentication.
* @typedef ServerAuthentication
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export interface ServerAuthentication {
/**
* Credential of server.
* @type {Credential}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
credential: Credential;
/**
* Authentication type of server. If not set, negotiate with the server.
* @type {?AuthenticationType}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
authenticationType?: AuthenticationType;
}
/**
* TlsOptions.
* 'system': use system tls configuration.
* TlsOption: tls version range, and specify cipher suite.
* @typedef {'system' | TlsConfig}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsOptions = 'system' | TlsConfig;
/**
* Remote Validation Type.
* @typedef {'system' | 'skip'}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type RemoteValidation = 'system' | 'skip';
/**
* The server's authentication type.
* @typedef {'basic' | 'ntlm' | 'digest'}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type AuthenticationType = 'basic' | 'ntlm' | 'digest';
/**
* The secure communication protocol.
* @typedef { 'TLS' | 'TLCP'}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 20
*/
export type SslType = 'TLS' | 'TLCP';
/**
* HTTP credential. Some server or proxy server need this.
* @typedef Credential
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export interface Credential {
/**
* Username of credential. Default is ''.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
username: string;
/**
* Password of credential. Default is ''.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
password: string;
}
/**
* TLS config.
* @typedef TlsConfig
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export interface TlsConfig {
/**
* Minimum version num of Tls protocol.
* @type {TlsVersion}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
tlsVersionMin: TlsVersion;
/**
* Maximum version num of Tls protocol.
* @type {TlsVersion}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
tlsVersionMax: TlsVersion;
/**
* CipherSuites, cipherSuits must match tsl version, otherswise will set all system-supported cipherSuits.
* @type {?CipherSuite[]}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
cipherSuites?: CipherSuite[];
}
/**
* Cipher suite which TLS1.3+ support.
* The framework has a built-in preference order, but your choice will be recorded.
* @typedef {'TLS_AES_128_GCM_SHA256' | 'TLS_AES_256_GCM_SHA384' | 'TLS_CHACHA20_POLY1305_SHA256'}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV13SpecificCipherSuite = 'TLS_AES_128_GCM_SHA256' | 'TLS_AES_256_GCM_SHA384' | 'TLS_CHACHA20_POLY1305_SHA256';
/**
* Cipher suite which TLS1.2+ support.
* @typedef {'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384'}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV12SpecificCipherSuite = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384';
/**
* Cipher suite which TLS1.0+ support.
* @typedef {'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV10SpecificCipherSuite = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA';
/**
* Include all cipher suite.
* @typedef {TlsV13CipherSuite}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type CipherSuite = TlsV13CipherSuite;
/**
* TLS1.3 cipher suite should include TLS1.2 cipher suite.
* @typedef {TlsV12CipherSuite | TlsV13SpecificCipherSuite}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV13CipherSuite = TlsV12CipherSuite | TlsV13SpecificCipherSuite;
/**
* TLS1.2 cipher suite should include TLS1.1 cipher suite.
* @typedef {TlsV11CipherSuite | TlsV12SpecificCipherSuite}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV12CipherSuite = TlsV11CipherSuite | TlsV12SpecificCipherSuite;
/**
* TLS1.1 cipher suite is same as TLS1.0 cipher suite.
* @typedef {TlsV10CipherSuite}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV11CipherSuite = TlsV10CipherSuite;
/**
* TLS1.0 cipher suite.
* @typedef {TlsV10SpecificCipherSuite}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export type TlsV10CipherSuite = TlsV10SpecificCipherSuite;
/**
* Enum for Tls version
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
export enum TlsVersion {
/**
* Tls version 1.0
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
TLS_V_1_0 = 4,
/**
* Tls version 1.1
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
TLS_V_1_1 = 5,
/**
* Tls version 1.2
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
TLS_V_1_2 = 6,
/**
* Tls version 1.3
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 18
*/
TLS_V_1_3 = 7
}
/**
* Represents the properties of a form object.
* @interface MultiFormData
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Represents the properties of a form object.
* @interface MultiFormData
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
export interface MultiFormData {
/**
* MIME name for the data field.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* MIME name for the data field.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
name: string;
/**
* Content type of the data field.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Content type of the data field.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
contentType: string;
/**
* Remote file name for the data field.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Remote file name for the data field.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
remoteFileName?: string;
/**
* This parameter sets a mime part's body content from memory data.
* @type {?(string | Object | ArrayBuffer)}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* This parameter sets a mime part's body content from memory data.
* @type {?(string | Object | ArrayBuffer)}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
data?: string | Object | ArrayBuffer;
/**
* This parameter sets a mime part's body content from the file's contents.
* This is an alternative to curl_mime_data for setting data to a mime part.
* If data is empty, filePath must be set.
* If data has a value, filePath does not take effect.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* This parameter sets a mime part's body content from the file's contents.
* This is an alternative to curl_mime_data for setting data to a mime part.
* If data is empty, filePath must be set.
* If data has a value, filePath does not take effect.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
filePath?: string;
}
/**
* Enum for certificate types
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Enum for certificate types
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
export enum CertType {
/**
* PEM format certificate
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* PEM format certificate
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
PEM = 'PEM',
/**
* DER format certificate
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* DER format certificate
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
DER = 'DER',
/**
* P12 format certificate
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* P12 format certificate
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
P12 = 'P12'
}
/**
* The clientCert field of the client certificate, which includes 4 attributes:
* client certificate (cert), client certificate type (certType), certificate private key (key), and passphrase (keyPassword).
* @interface ClientCert
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The clientCert field of the client certificate, which includes 4 attributes:
* client certificate (cert), client certificate type (certType), certificate private key (key), and passphrase (keyPassword).
* @interface ClientCert
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
export interface ClientCert {
/**
* The path to the client certificate file.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The path to the client certificate file.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
certPath: string;
/**
* The type of the client certificate.
* @type {?CertType}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The type of the client certificate.
* @type {?CertType}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
certType?: CertType;
/**
* The path of the client certificate private key file.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The path of the client certificate private key file.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
keyPath: string;
/**
* Password required to use the client certificate private key.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Password required to use the client certificate private key.
* @type {?string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
keyPassword?: string;
}
/**
* Certificate pinning option.
* @interface CertificatePinning
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
interface CertificatePinning {
/**
* Public key hash.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
publicKeyHash: string;
/**
* Certificate public key hash algorithm.
* @type {'SHA-256'}
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
hashAlgorithm: 'SHA-256';
}
/**
* <p>Defines an HTTP request task. Before invoking APIs provided by HttpRequest,
* you must call createHttp() to create an HttpRequestTask object.</p>
* @interface HttpRequest
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* <p>Defines an HTTP request task. Before invoking APIs provided by HttpRequest,
* you must call createHttp() to create an HttpRequestTask object.</p>
* @interface HttpRequest
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* <p>Defines an HTTP request task. Before invoking APIs provided by HttpRequest,
* you must call createHttp() to create an HttpRequestTask object.</p>
* @interface HttpRequest
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export interface HttpRequest {
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300997 - Cleartext traffic not permitted.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
request(url: string, callback: AsyncCallback<HttpResponse>): void;
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request..
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<HttpResponse> } callback - the callback of request.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300997 - Cleartext traffic not permitted.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
request(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpResponse>): void;
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<HttpResponse> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<HttpResponse> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<HttpResponse> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<HttpResponse> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
/**
* Initiates an HTTP request to a given URL.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<HttpResponse> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300997 - Cleartext traffic not permitted.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
request(url: string, options?: HttpRequestOptions): Promise<HttpResponse>;
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<number> } callback - Returns the callback of requestInStream {@link ResponseCode},
* should use on_headersReceive and on_dataReceive to get http response.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<number> } callback - Returns the callback of requestInStream {@link ResponseCode},
* should use on_headersReceive and on_dataReceive to get http response.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<number> } callback - Returns the callback of requestInStream {@link ResponseCode},
* should use on_headersReceive and on_dataReceive to get http response.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { AsyncCallback<number> } callback - Returns the callback of requestInStream {@link ResponseCode},
* should use on_headersReceive and on_dataReceive to get http response.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300997 - Cleartext traffic not permitted.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
requestInStream(url: string, callback: AsyncCallback<number>): void;
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<number> } callback - the callback of requestInStream.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<number> } callback - the callback of requestInStream.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<number> } callback - the callback of requestInStream.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}.
* @param { AsyncCallback<number> } callback - the callback of requestInStream.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300997 - Cleartext traffic not permitted.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback<number>): void;
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<number> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<number> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @since 12
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<number> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming.
* @permission ohos.permission.INTERNET
* @param { string } url - URL for initiating an HTTP request.
* @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}.
* @returns { Promise<number> } the promise returned by the function.
* @throws { BusinessError } 401 - Parameter error.
* @throws { BusinessError } 201 - Permission denied.
* @throws { BusinessError } 2300001 - Unsupported protocol.
* @throws { BusinessError } 2300003 - Invalid URL format or missing URL.
* @throws { BusinessError } 2300005 - Failed to resolve the proxy name.
* @throws { BusinessError } 2300006 - Failed to resolve the host name.
* @throws { BusinessError } 2300007 - Failed to connect to the server.
* @throws { BusinessError } 2300008 - Invalid server response.
* @throws { BusinessError } 2300009 - Access to the remote resource denied.
* @throws { BusinessError } 2300016 - Error in the HTTP2 framing layer.
* @throws { BusinessError } 2300018 - Transferred a partial file.
* @throws { BusinessError } 2300023 - Failed to write the received data to the disk or application.
* @throws { BusinessError } 2300025 - Upload failed.
* @throws { BusinessError } 2300026 - Failed to open or read local data from the file or application.
* @throws { BusinessError } 2300027 - Out of memory.
* @throws { BusinessError } 2300028 - Operation timeout.
* @throws { BusinessError } 2300047 - The number of redirections reaches the maximum allowed.
* @throws { BusinessError } 2300052 - The server returned nothing (no header or data).
* @throws { BusinessError } 2300055 - Failed to send data to the peer.
* @throws { BusinessError } 2300056 - Failed to receive data from the peer.
* @throws { BusinessError } 2300058 - Local SSL certificate error.
* @throws { BusinessError } 2300059 - The specified SSL cipher cannot be used.
* @throws { BusinessError } 2300060 - Invalid SSL peer certificate or SSH remote key.
* @throws { BusinessError } 2300061 - Invalid HTTP encoding format.
* @throws { BusinessError } 2300063 - Maximum file size exceeded.
* @throws { BusinessError } 2300070 - Remote disk full.
* @throws { BusinessError } 2300073 - Remote file already exists.
* @throws { BusinessError } 2300077 - The SSL CA certificate does not exist or is inaccessible.
* @throws { BusinessError } 2300078 - Remote file not found.
* @throws { BusinessError } 2300094 - Authentication error.
* @throws { BusinessError } 2300997 - Cleartext traffic not permitted.
* @throws { BusinessError } 2300998 - It is not allowed to access this domain.
* @throws { BusinessError } 2300999 - Internal error.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
requestInStream(url: string, options?: HttpRequestOptions): Promise<number>;
/**
* Destroys an HTTP request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Destroys an HTTP request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Destroys an HTTP request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
destroy(): void;
/**
* Registers an observer for HTTP Response Header events.
* @param { "headerReceive" } type - Indicates Event name.
* @param { AsyncCallback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 6
* @deprecated since 8
* @useinstead on_headersReceive
*/
on(type: "headerReceive", callback: AsyncCallback<Object>): void;
/**
* Unregisters the observer for HTTP Response Header events.
* @param { "headerReceive" } type - Indicates Event name.
* @param { AsyncCallback<Object> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 6
* @deprecated since 8
* @useinstead off_headersReceive
*/
off(type: "headerReceive", callback?: AsyncCallback<Object>): void;
/**
* Registers an observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 8
*/
/**
* Registers an observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Registers an observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
on(type: "headersReceive", callback: Callback<Object>): void;
/**
* Unregisters the observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 8
*/
/**
* Unregisters the observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Unregisters the observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
off(type: "headersReceive", callback?: Callback<Object>): void;
/**
* Registers a one-time observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 8
*/
/**
* Registers a one-time observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Registers a one-time observer for HTTP Response Header events.
* @param { "headersReceive" } type - Indicates Event name.
* @param { Callback<Object> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
once(type: "headersReceive", callback: Callback<Object>): void;
/**
* Registers an observer for receiving HTTP Response data events continuously.
* @param { "dataReceive" } type - Indicates Event name.
* @param { Callback<ArrayBuffer> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Registers an observer for receiving HTTP Response data events continuously.
* @param { "dataReceive" } type - Indicates Event name.
* @param { Callback<ArrayBuffer> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Registers an observer for receiving HTTP Response data events continuously.
* @param { "dataReceive" } type - Indicates Event name.
* @param { Callback<ArrayBuffer> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
on(type: "dataReceive", callback: Callback<ArrayBuffer>): void;
/**
* Unregisters an observer for receiving HTTP Response data events continuously.
* @param { "dataReceive" } type - Indicates Event name.
* @param { Callback<ArrayBuffer> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Unregisters an observer for receiving HTTP Response data events continuously.
* @param { "dataReceive" } type - Indicates Event name.
* @param { Callback<ArrayBuffer> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Unregisters an observer for receiving HTTP Response data events continuously.
* @param { "dataReceive" } type - Indicates Event name.
* @param { Callback<ArrayBuffer> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
off(type: "dataReceive", callback?: Callback<ArrayBuffer>): void;
/**
* Registers an observer for receiving HTTP Response data ends events.
* @param { "dataEnd" } type - Indicates Event name.
* @param { Callback<void> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Registers an observer for receiving HTTP Response data ends events.
* @param { "dataEnd" } type - Indicates Event name.
* @param { Callback<void> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Registers an observer for receiving HTTP Response data ends events.
* @param { "dataEnd" } type - Indicates Event name.
* @param { Callback<void> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
on(type: "dataEnd", callback: Callback<void>): void;
/**
* Unregisters an observer for receiving HTTP Response data ends events.
* @param { "dataEnd" } type - Indicates Event name.
* @param { Callback<void> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Unregisters an observer for receiving HTTP Response data ends events.
* @param { "dataEnd" } type - Indicates Event name.
* @param { Callback<void> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @atomicservice
* @since 15
*/
/**
* Unregisters an observer for receiving HTTP Response data ends events.
* @param { "dataEnd" } type - Indicates Event name.
* @param { Callback<void> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 18
*/
off(type: "dataEnd", callback?: Callback<void>): void;
/**
* Registers an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<{ receiveSize: number, totalSize: number }> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Registers an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<DataReceiveProgressInfo> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Registers an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<DataReceiveProgressInfo> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Registers an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<DataReceiveProgressInfo> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
on(type: 'dataReceiveProgress', callback: Callback<DataReceiveProgressInfo>): void;
/**
* Unregisters an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<{ receiveSize: number, totalSize: number }> } [callback] - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
/**
* Unregisters an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<DataReceiveProgressInfo> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Unregisters an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<DataReceiveProgressInfo> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Unregisters an observer for progress of receiving HTTP Response data events.
* @param { 'dataReceiveProgress' } type - Indicates Event name.
* @param { Callback<DataReceiveProgressInfo> } callback - the callback used to return the result.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
off(type: 'dataReceiveProgress', callback?: Callback<DataReceiveProgressInfo>): void;
/**
* Registers an observer for progress of sendSize HTTP Response data events.
* @param { 'dataSendProgress' } type - Indicates Event name.
* @param { Callback<DataSendProgressInfo> } callback - the callback of on.
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Registers an observer for progress of sendSize HTTP Response data events.
* @param { 'dataSendProgress' } type - Indicates Event name.
* @param { Callback<DataSendProgressInfo> } callback - the callback of on.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Registers an observer for progress of sendSize HTTP Response data events.
* @param { 'dataSendProgress' } type - Indicates Event name.
* @param { Callback<DataSendProgressInfo> } callback - the callback of on.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
on(type: 'dataSendProgress', callback: Callback<DataSendProgressInfo>): void
/**
* Unregisters an observer for progress of sendSize HTTP Response data events.
* @param { 'dataSendProgress' } type - Indicates Event name.
* @param { Callback<DataSendProgressInfo> } [callback] - the callback of off.
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Unregisters an observer for progress of sendSize HTTP Response data events.
* @param { 'dataSendProgress' } type - Indicates Event name.
* @param { Callback<DataSendProgressInfo> } [callback] - the callback of off.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Unregisters an observer for progress of sendSize HTTP Response data events.
* @param { 'dataSendProgress' } type - Indicates Event name.
* @param { Callback<DataSendProgressInfo> } [callback] - the callback of off.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
off(type: 'dataSendProgress', callback?: Callback<DataSendProgressInfo>): void
}
/**
* Defines an HTTP request method.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Defines an HTTP request method.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Defines an HTTP request method.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export enum RequestMethod {
/**
* OPTIONS method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* OPTIONS method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* OPTIONS method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
OPTIONS = "OPTIONS",
/**
* GET method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* GET method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* GET method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
GET = "GET",
/**
* HEAD method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* HEAD method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* HEAD method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
HEAD = "HEAD",
/**
* POST method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* POST method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* POST method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
POST = "POST",
/**
* PUT method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* PUT method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* PUT method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
PUT = "PUT",
/**
* DELETE method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* DELETE method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* DELETE method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
DELETE = "DELETE",
/**
* TRACE method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* TRACE method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* TRACE method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
TRACE = "TRACE",
/**
* CONNECT method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* CONNECT method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* CONNECT method.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
CONNECT = "CONNECT"
}
/**
* Enumerates the response codes for an HTTP request.
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Enumerates the response codes for an HTTP request.
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Enumerates the response codes for an HTTP request.
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export enum ResponseCode {
/**
* The request was successful. Typically used for GET and POST requests.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The request was successful. Typically used for GET and POST requests.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The request was successful. Typically used for GET and POST requests.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
OK = 200,
/**
* Successfully requested and created a new resource.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Successfully requested and created a new resource.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Successfully requested and created a new resource.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
CREATED,
/**
* The request has been accepted but has not been processed completely.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The request has been accepted but has not been processed completely.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The request has been accepted but has not been processed completely.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
ACCEPTED,
/**
* Unauthorized information. The request was successful.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Unauthorized information. The request was successful.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Unauthorized information. The request was successful.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
NOT_AUTHORITATIVE,
/**
* No content. The server successfully processed, but did not return content.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* No content. The server successfully processed, but did not return content.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* No content. The server successfully processed, but did not return content.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
NO_CONTENT,
/**
* Reset the content.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Reset the content.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Reset the content.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
RESET,
/**
* Partial content. The server successfully processed some GET requests.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Partial content. The server successfully processed some GET requests.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Partial content. The server successfully processed some GET requests.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
PARTIAL,
/**
* Multiple options.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Multiple options.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Multiple options.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
MULT_CHOICE = 300,
/**
* <p>Permanently move. The requested resource has been permanently moved to a new URI,
* and the returned information will include the new URI. The browser will automatically redirect to the new URI.</p>
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* <p>Permanently move. The requested resource has been permanently moved to a new URI,
* and the returned information will include the new URI. The browser will automatically redirect to the new URI.</p>
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* <p>Permanently move. The requested resource has been permanently moved to a new URI,
* and the returned information will include the new URI. The browser will automatically redirect to the new URI.</p>
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
MOVED_PERM,
/**
* Temporary movement.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Temporary movement.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Temporary movement.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
MOVED_TEMP,
/**
* View other addresses.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* View other addresses.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* View other addresses.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
SEE_OTHER,
/**
* Not modified.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Not modified.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Not modified.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
NOT_MODIFIED,
/**
* Using proxies.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Using proxies.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Using proxies.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
USE_PROXY,
/**
* The server cannot understand the syntax error error requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server cannot understand the syntax error error requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server cannot understand the syntax error error requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
BAD_REQUEST = 400,
/**
* Request for user authentication.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Request for user authentication.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Request for user authentication.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
UNAUTHORIZED,
/**
* Reserved for future use.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Reserved for future use.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Reserved for future use.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
PAYMENT_REQUIRED,
/**
* The server understands the request from the requesting client, but refuses to execute it.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server understands the request from the requesting client, but refuses to execute it.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server understands the request from the requesting client, but refuses to execute it.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
FORBIDDEN,
/**
* The server was unable to find resources (web pages) based on the client's request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server was unable to find resources (web pages) based on the client's request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server was unable to find resources (web pages) based on the client's request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
NOT_FOUND,
/**
* The method in the client request is prohibited.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The method in the client request is prohibited.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The method in the client request is prohibited.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
BAD_METHOD,
/**
* The server is unable to complete the request based on the content characteristics requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server is unable to complete the request based on the content characteristics requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server is unable to complete the request based on the content characteristics requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
NOT_ACCEPTABLE,
/**
* Request authentication of the proxy's identity.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Request authentication of the proxy's identity.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Request authentication of the proxy's identity.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
PROXY_AUTH,
/**
* The request took too long and timed out.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The request took too long and timed out.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The request took too long and timed out.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
CLIENT_TIMEOUT,
/**
* <p>The server may have returned this code when completing the client's PUT request,
* as there was a conflict when the server was processing the request.</p>
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* <p>The server may have returned this code when completing the client's PUT request,
* as there was a conflict when the server was processing the request.</p>
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* <p>The server may have returned this code when completing the client's PUT request,
* as there was a conflict when the server was processing the request.</p>
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
CONFLICT,
/**
* The resource requested by the client no longer exists.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The resource requested by the client no longer exists.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The resource requested by the client no longer exists.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
GONE,
/**
* The server is unable to process request information sent by the client without Content Length.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server is unable to process request information sent by the client without Content Length.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server is unable to process request information sent by the client without Content Length.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
LENGTH_REQUIRED,
/**
* The prerequisite for requesting information from the client is incorrect.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The prerequisite for requesting information from the client is incorrect.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The prerequisite for requesting information from the client is incorrect.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
PRECON_FAILED,
/**
* The request was rejected because the requested entity was too large for the server to process.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The request was rejected because the requested entity was too large for the server to process.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The request was rejected because the requested entity was too large for the server to process.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
ENTITY_TOO_LARGE,
/**
* The requested URI is too long (usually a URL) and the server cannot process it.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The requested URI is too long (usually a URL) and the server cannot process it.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The requested URI is too long (usually a URL) and the server cannot process it.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
REQ_TOO_LONG,
/**
* The server is unable to process the requested format.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server is unable to process the requested format.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server is unable to process the requested format.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
UNSUPPORTED_TYPE,
/**
* The server cannot process the requested data range.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 12
*/
RANGE_NOT_SATISFIABLE,
/**
* Internal server error, unable to complete the request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Internal server error, unable to complete the request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Internal server error, unable to complete the request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
INTERNAL_ERROR = 500,
/**
* The server does not support the requested functionality and cannot complete the request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server does not support the requested functionality and cannot complete the request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server does not support the requested functionality and cannot complete the request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
NOT_IMPLEMENTED,
/**
* The server acting as a gateway or proxy received an invalid request from the remote server.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server acting as a gateway or proxy received an invalid request from the remote server.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server acting as a gateway or proxy received an invalid request from the remote server.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
BAD_GATEWAY,
/**
* Due to overload or system maintenance, the server is temporarily unable to process client requests.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Due to overload or system maintenance, the server is temporarily unable to process client requests.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Due to overload or system maintenance, the server is temporarily unable to process client requests.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
UNAVAILABLE,
/**
* The server acting as a gateway or proxy did not obtain requests from the remote server in a timely manner.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The server acting as a gateway or proxy did not obtain requests from the remote server in a timely manner.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The server acting as a gateway or proxy did not obtain requests from the remote server in a timely manner.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
GATEWAY_TIMEOUT,
/**
* The version of the HTTP protocol requested by the server.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* The version of the HTTP protocol requested by the server.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The version of the HTTP protocol requested by the server.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
VERSION
}
/**
* Supported protocols.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Supported protocols.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Supported protocols.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export enum HttpProtocol {
/**
* Protocol http1.1
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Protocol http1.1
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Protocol http1.1
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
HTTP1_1,
/**
* Protocol http2
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Protocol http2
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Protocol http2
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
HTTP2,
/**
* Protocol http3 for https only.
* Cause error if using http only or not supporting http3 on this device.
* Fallback to http2 or http1.1 if needed.
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Protocol http3 for https only.
* Cause error if using http only or not supporting http3 on this device.
* Fallback to http2 or http1.1 if needed.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
HTTP3
}
/**
* Indicates the type of the returned data.
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Indicates the type of the returned data.
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Indicates the type of the returned data.
* @enum {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export enum HttpDataType {
/**
* The returned type is string.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* The returned type is string.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The returned type is string.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
STRING,
/**
* The returned type is Object.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* The returned type is Object.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The returned type is Object.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
OBJECT = 1,
/**
* The returned type is ArrayBuffer.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* The returned type is ArrayBuffer.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* The returned type is ArrayBuffer.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
ARRAY_BUFFER = 2
}
/**
* Defines the response to an HTTP request.
* @interface HttpResponse
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Defines the response to an HTTP request.
* @interface HttpResponse
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Defines the response to an HTTP request.
* @interface HttpResponse
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export interface HttpResponse {
/**
* result can be a string (API 6) or an ArrayBuffer(API 8). Object is deprecated from API 8.
* If {@link HttpRequestOptions#expectDataType} is set, the system preferentially returns this parameter.
* @type {string | Object | ArrayBuffer}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* result can be a string (API 6) or an ArrayBuffer(API 8). Object is deprecated from API 8.
* If {@link HttpRequestOptions#expectDataType} is set, the system preferentially returns this parameter.
* @type {string | Object | ArrayBuffer}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* result can be a string (API 6) or an ArrayBuffer(API 8). Object is deprecated from API 8.
* If {@link HttpRequestOptions#expectDataType} is set, the system preferentially returns this parameter.
* @type {string | Object | ArrayBuffer}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
result: string | Object | ArrayBuffer;
/**
* If the resultType is string, you can get result directly.
* If the resultType is Object, you can get result such as this: result['key'].
* If the resultType is ArrayBuffer, you can use ArrayBuffer to create the binary objects.
* @type {HttpDataType}
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* If the resultType is string, you can get result directly.
* If the resultType is Object, you can get result such as this: result['key'].
* If the resultType is ArrayBuffer, you can use ArrayBuffer to create the binary objects.
* @type {HttpDataType}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* If the resultType is string, you can get result directly.
* If the resultType is Object, you can get result such as this: result['key'].
* If the resultType is ArrayBuffer, you can use ArrayBuffer to create the binary objects.
* @type {HttpDataType}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
resultType: HttpDataType;
/**
* Server status code.
* @type {ResponseCode | number}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* Server status code.
* @type {ResponseCode | number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Server status code.
* @type {ResponseCode | number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
responseCode: ResponseCode | number;
/**
* All headers in the response from the server.
* @type {Object}
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
/**
* All headers in the response from the server.
* @type {Object}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* All headers in the response from the server.
* @type {Object}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
header: Object;
/**
* Cookies returned by the server.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @since 8
*/
/**
* Cookies returned by the server.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Cookies returned by the server.
* @type {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
cookies: string;
/**
* The time taken of various stages of HTTP request.
* @type {PerformanceTiming}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* The time taken of various stages of HTTP request.
* @type {PerformanceTiming}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
performanceTiming: PerformanceTiming;
}
/**
* Counting the time taken of various stages of HTTP request.
* @interface PerformanceTiming
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Counting the time taken of various stages of HTTP request.
* @interface PerformanceTiming
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
export interface PerformanceTiming {
/**
* Time taken from startup to DNS resolution completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to DNS resolution completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
dnsTiming: number;
/**
* Time taken from startup to TCP connection completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to TCP connection completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
tcpTiming: number;
/**
* Time taken from startup to TLS connection completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to TLS connection completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
tlsTiming: number;
/**
* Time taken from startup to start sending the first byte, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to start sending the first byte, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
firstSendTiming: number;
/**
* Time taken from startup to receiving the first byte, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to receiving the first byte, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
firstReceiveTiming: number;
/**
* Time taken from startup to the completion of the request, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to the completion of the request, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
totalFinishTiming: number;
/**
* Time taken from startup to completion of all redirection steps, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from startup to completion of all redirection steps, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
redirectTiming: number;
/**
* Time taken from HTTP request to header completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from HTTP request to header completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
responseHeaderTiming: number;
/**
* Time taken from HTTP Request to body completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from HTTP Request to body completion, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
responseBodyTiming: number;
/**
* Time taken from HTTP Request to callback to the application, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Time taken from HTTP Request to callback to the application, in milliseconds.
* @type {number}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
totalTiming: number;
}
/**
* This interface is used to obtain the progress information of file upload or download.
* @interface DataReceiveProgressInfo
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* This interface is used to obtain the progress information of file upload or download.
* @interface DataReceiveProgressInfo
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* This interface is used to obtain the progress information of file upload or download.
* @interface DataReceiveProgressInfo
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
export interface DataReceiveProgressInfo {
/**
* Number of data bytes received.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Number of data bytes received.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Number of data bytes received.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
receiveSize: number;
/**
* Total number of bytes to receive.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Total number of bytes to receive.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Total number of bytes to receive.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
totalSize: number;
}
/**
* This interface is used to monitor the progress of sending data.
* @interface DataSendProgressInfo
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* This interface is used to monitor the progress of sending data.
* @interface DataSendProgressInfo
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* This interface is used to monitor the progress of sending data.
* @interface DataSendProgressInfo
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
export interface DataSendProgressInfo {
/**
* Used to specify the data size to be sent.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Used to specify the data size to be sent.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Used to specify the data size to be sent.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
sendSize: number;
/**
* Total number of bytes to receive.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @since 11
*/
/**
* Total number of bytes to receive.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 12
*/
/**
* Total number of bytes to receive.
* @type { number }
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 15
*/
totalSize: number;
}
/**
* Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests.
* @param { number } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB).
* @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests.
* @param { number } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB).
* @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests.
* @param { number } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB).
* @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
function createHttpResponseCache(cacheSize?: number): HttpResponseCache;
/**
* Defines an object that stores the response to an HTTP request.
* @interface HttpResponseCache
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Defines an object that stores the response to an HTTP request.
* @interface HttpResponseCache
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Defines an object that stores the response to an HTTP request.
* @interface HttpResponseCache
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
export interface HttpResponseCache {
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @param { AsyncCallback<void> } callback - the callback of flush.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @param { AsyncCallback<void> } callback - the callback of flush.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @param { AsyncCallback<void> } callback - the callback of flush.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
flush(callback: AsyncCallback<void>): void;
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @returns { Promise<void> } The promise returned by the flush.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @returns { Promise<void> } The promise returned by the flush.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @returns { Promise<void> } The promise returned by the flush.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
flush(): Promise<void>;
/**
* Disables a cache and deletes the data in it.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Disables a cache and deletes the data in it.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Disables a cache and deletes the data in it.
* @param { AsyncCallback<void> } callback - the callback of delete.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
delete(callback: AsyncCallback<void>): void;
/**
* Disables a cache and deletes the data in it.
* @returns { Promise<void> } The promise returned by the delete.
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
/**
* Disables a cache and deletes the data in it.
* @returns { Promise<void> } The promise returned by the delete.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 10
*/
/**
* Disables a cache and deletes the data in it.
* @returns { Promise<void> } The promise returned by the delete.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @atomicservice
* @since 11
*/
delete(): Promise<void>;
}
}
export default http;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助