browser_protocol.pdl 385 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194
  1. # Copyright 2017 The Chromium Authors
  2. # Use of this source code is governed by a BSD-style license that can be
  3. # found in the LICENSE file.
  4. #
  5. # Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
  6. version
  7. major 1
  8. minor 3
  9. experimental domain Accessibility
  10. depends on DOM
  11. # Unique accessibility node identifier.
  12. type AXNodeId extends string
  13. # Enum of possible property types.
  14. type AXValueType extends string
  15. enum
  16. boolean
  17. tristate
  18. booleanOrUndefined
  19. idref
  20. idrefList
  21. integer
  22. node
  23. nodeList
  24. number
  25. string
  26. computedString
  27. token
  28. tokenList
  29. domRelation
  30. role
  31. internalRole
  32. valueUndefined
  33. # Enum of possible property sources.
  34. type AXValueSourceType extends string
  35. enum
  36. attribute
  37. implicit
  38. style
  39. contents
  40. placeholder
  41. relatedElement
  42. # Enum of possible native property sources (as a subtype of a particular AXValueSourceType).
  43. type AXValueNativeSourceType extends string
  44. enum
  45. description
  46. figcaption
  47. label
  48. labelfor
  49. labelwrapped
  50. legend
  51. rubyannotation
  52. tablecaption
  53. title
  54. other
  55. # A single source for a computed AX property.
  56. type AXValueSource extends object
  57. properties
  58. # What type of source this is.
  59. AXValueSourceType type
  60. # The value of this property source.
  61. optional AXValue value
  62. # The name of the relevant attribute, if any.
  63. optional string attribute
  64. # The value of the relevant attribute, if any.
  65. optional AXValue attributeValue
  66. # Whether this source is superseded by a higher priority source.
  67. optional boolean superseded
  68. # The native markup source for this value, e.g. a <label> element.
  69. optional AXValueNativeSourceType nativeSource
  70. # The value, such as a node or node list, of the native source.
  71. optional AXValue nativeSourceValue
  72. # Whether the value for this property is invalid.
  73. optional boolean invalid
  74. # Reason for the value being invalid, if it is.
  75. optional string invalidReason
  76. type AXRelatedNode extends object
  77. properties
  78. # The BackendNodeId of the related DOM node.
  79. DOM.BackendNodeId backendDOMNodeId
  80. # The IDRef value provided, if any.
  81. optional string idref
  82. # The text alternative of this node in the current context.
  83. optional string text
  84. type AXProperty extends object
  85. properties
  86. # The name of this property.
  87. AXPropertyName name
  88. # The value of this property.
  89. AXValue value
  90. # A single computed AX property.
  91. type AXValue extends object
  92. properties
  93. # The type of this value.
  94. AXValueType type
  95. # The computed value of this property.
  96. optional any value
  97. # One or more related nodes, if applicable.
  98. optional array of AXRelatedNode relatedNodes
  99. # The sources which contributed to the computation of this property.
  100. optional array of AXValueSource sources
  101. # Values of AXProperty name:
  102. # - from 'busy' to 'roledescription': states which apply to every AX node
  103. # - from 'live' to 'root': attributes which apply to nodes in live regions
  104. # - from 'autocomplete' to 'valuetext': attributes which apply to widgets
  105. # - from 'checked' to 'selected': states which apply to widgets
  106. # - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
  107. type AXPropertyName extends string
  108. enum
  109. busy
  110. disabled
  111. editable
  112. focusable
  113. focused
  114. hidden
  115. hiddenRoot
  116. invalid
  117. keyshortcuts
  118. settable
  119. roledescription
  120. live
  121. atomic
  122. relevant
  123. root
  124. autocomplete
  125. hasPopup
  126. level
  127. multiselectable
  128. orientation
  129. multiline
  130. readonly
  131. required
  132. valuemin
  133. valuemax
  134. valuetext
  135. checked
  136. expanded
  137. modal
  138. pressed
  139. selected
  140. activedescendant
  141. controls
  142. describedby
  143. details
  144. errormessage
  145. flowto
  146. labelledby
  147. owns
  148. # A node in the accessibility tree.
  149. type AXNode extends object
  150. properties
  151. # Unique identifier for this node.
  152. AXNodeId nodeId
  153. # Whether this node is ignored for accessibility
  154. boolean ignored
  155. # Collection of reasons why this node is hidden.
  156. optional array of AXProperty ignoredReasons
  157. # This `Node`'s role, whether explicit or implicit.
  158. optional AXValue role
  159. # This `Node`'s Chrome raw role.
  160. optional AXValue chromeRole
  161. # The accessible name for this `Node`.
  162. optional AXValue name
  163. # The accessible description for this `Node`.
  164. optional AXValue description
  165. # The value for this `Node`.
  166. optional AXValue value
  167. # All other properties
  168. optional array of AXProperty properties
  169. # ID for this node's parent.
  170. optional AXNodeId parentId
  171. # IDs for each of this node's child nodes.
  172. optional array of AXNodeId childIds
  173. # The backend ID for the associated DOM node, if any.
  174. optional DOM.BackendNodeId backendDOMNodeId
  175. # The frame ID for the frame associated with this nodes document.
  176. optional Page.FrameId frameId
  177. # Disables the accessibility domain.
  178. command disable
  179. # Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
  180. # This turns on accessibility for the page, which can impact performance until accessibility is disabled.
  181. command enable
  182. # Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
  183. experimental command getPartialAXTree
  184. parameters
  185. # Identifier of the node to get the partial accessibility tree for.
  186. optional DOM.NodeId nodeId
  187. # Identifier of the backend node to get the partial accessibility tree for.
  188. optional DOM.BackendNodeId backendNodeId
  189. # JavaScript object id of the node wrapper to get the partial accessibility tree for.
  190. optional Runtime.RemoteObjectId objectId
  191. # Whether to fetch this node's ancestors, siblings and children. Defaults to true.
  192. optional boolean fetchRelatives
  193. returns
  194. # The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and
  195. # children, if requested.
  196. array of AXNode nodes
  197. # Fetches the entire accessibility tree for the root Document
  198. experimental command getFullAXTree
  199. parameters
  200. # The maximum depth at which descendants of the root node should be retrieved.
  201. # If omitted, the full tree is returned.
  202. optional integer depth
  203. # The frame for whose document the AX tree should be retrieved.
  204. # If omited, the root frame is used.
  205. optional Page.FrameId frameId
  206. returns
  207. array of AXNode nodes
  208. # Fetches the root node.
  209. # Requires `enable()` to have been called previously.
  210. experimental command getRootAXNode
  211. parameters
  212. # The frame in whose document the node resides.
  213. # If omitted, the root frame is used.
  214. optional Page.FrameId frameId
  215. returns
  216. AXNode node
  217. # Fetches a node and all ancestors up to and including the root.
  218. # Requires `enable()` to have been called previously.
  219. experimental command getAXNodeAndAncestors
  220. parameters
  221. # Identifier of the node to get.
  222. optional DOM.NodeId nodeId
  223. # Identifier of the backend node to get.
  224. optional DOM.BackendNodeId backendNodeId
  225. # JavaScript object id of the node wrapper to get.
  226. optional Runtime.RemoteObjectId objectId
  227. returns
  228. array of AXNode nodes
  229. # Fetches a particular accessibility node by AXNodeId.
  230. # Requires `enable()` to have been called previously.
  231. experimental command getChildAXNodes
  232. parameters
  233. AXNodeId id
  234. # The frame in whose document the node resides.
  235. # If omitted, the root frame is used.
  236. optional Page.FrameId frameId
  237. returns
  238. array of AXNode nodes
  239. # Query a DOM node's accessibility subtree for accessible name and role.
  240. # This command computes the name and role for all nodes in the subtree, including those that are
  241. # ignored for accessibility, and returns those that mactch the specified name and role. If no DOM
  242. # node is specified, or the DOM node does not exist, the command returns an error. If neither
  243. # `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree.
  244. experimental command queryAXTree
  245. parameters
  246. # Identifier of the node for the root to query.
  247. optional DOM.NodeId nodeId
  248. # Identifier of the backend node for the root to query.
  249. optional DOM.BackendNodeId backendNodeId
  250. # JavaScript object id of the node wrapper for the root to query.
  251. optional Runtime.RemoteObjectId objectId
  252. # Find nodes with this computed name.
  253. optional string accessibleName
  254. # Find nodes with this computed role.
  255. optional string role
  256. returns
  257. # A list of `Accessibility.AXNode` matching the specified attributes,
  258. # including nodes that are ignored for accessibility.
  259. array of AXNode nodes
  260. # The loadComplete event mirrors the load complete event sent by the browser to assistive
  261. # technology when the web page has finished loading.
  262. experimental event loadComplete
  263. parameters
  264. # New document root node.
  265. AXNode root
  266. # The nodesUpdated event is sent every time a previously requested node has changed the in tree.
  267. experimental event nodesUpdated
  268. parameters
  269. # Updated node data.
  270. array of AXNode nodes
  271. experimental domain Animation
  272. depends on Runtime
  273. depends on DOM
  274. # Animation instance.
  275. type Animation extends object
  276. properties
  277. # `Animation`'s id.
  278. string id
  279. # `Animation`'s name.
  280. string name
  281. # `Animation`'s internal paused state.
  282. boolean pausedState
  283. # `Animation`'s play state.
  284. string playState
  285. # `Animation`'s playback rate.
  286. number playbackRate
  287. # `Animation`'s start time.
  288. number startTime
  289. # `Animation`'s current time.
  290. number currentTime
  291. # Animation type of `Animation`.
  292. enum type
  293. CSSTransition
  294. CSSAnimation
  295. WebAnimation
  296. # `Animation`'s source animation node.
  297. optional AnimationEffect source
  298. # A unique ID for `Animation` representing the sources that triggered this CSS
  299. # animation/transition.
  300. optional string cssId
  301. # AnimationEffect instance
  302. type AnimationEffect extends object
  303. properties
  304. # `AnimationEffect`'s delay.
  305. number delay
  306. # `AnimationEffect`'s end delay.
  307. number endDelay
  308. # `AnimationEffect`'s iteration start.
  309. number iterationStart
  310. # `AnimationEffect`'s iterations.
  311. number iterations
  312. # `AnimationEffect`'s iteration duration.
  313. number duration
  314. # `AnimationEffect`'s playback direction.
  315. string direction
  316. # `AnimationEffect`'s fill mode.
  317. string fill
  318. # `AnimationEffect`'s target node.
  319. optional DOM.BackendNodeId backendNodeId
  320. # `AnimationEffect`'s keyframes.
  321. optional KeyframesRule keyframesRule
  322. # `AnimationEffect`'s timing function.
  323. string easing
  324. # Keyframes Rule
  325. type KeyframesRule extends object
  326. properties
  327. # CSS keyframed animation's name.
  328. optional string name
  329. # List of animation keyframes.
  330. array of KeyframeStyle keyframes
  331. # Keyframe Style
  332. type KeyframeStyle extends object
  333. properties
  334. # Keyframe's time offset.
  335. string offset
  336. # `AnimationEffect`'s timing function.
  337. string easing
  338. # Disables animation domain notifications.
  339. command disable
  340. # Enables animation domain notifications.
  341. command enable
  342. # Returns the current time of the an animation.
  343. command getCurrentTime
  344. parameters
  345. # Id of animation.
  346. string id
  347. returns
  348. # Current time of the page.
  349. number currentTime
  350. # Gets the playback rate of the document timeline.
  351. command getPlaybackRate
  352. returns
  353. # Playback rate for animations on page.
  354. number playbackRate
  355. # Releases a set of animations to no longer be manipulated.
  356. command releaseAnimations
  357. parameters
  358. # List of animation ids to seek.
  359. array of string animations
  360. # Gets the remote object of the Animation.
  361. command resolveAnimation
  362. parameters
  363. # Animation id.
  364. string animationId
  365. returns
  366. # Corresponding remote object.
  367. Runtime.RemoteObject remoteObject
  368. # Seek a set of animations to a particular time within each animation.
  369. command seekAnimations
  370. parameters
  371. # List of animation ids to seek.
  372. array of string animations
  373. # Set the current time of each animation.
  374. number currentTime
  375. # Sets the paused state of a set of animations.
  376. command setPaused
  377. parameters
  378. # Animations to set the pause state of.
  379. array of string animations
  380. # Paused state to set to.
  381. boolean paused
  382. # Sets the playback rate of the document timeline.
  383. command setPlaybackRate
  384. parameters
  385. # Playback rate for animations on page
  386. number playbackRate
  387. # Sets the timing of an animation node.
  388. command setTiming
  389. parameters
  390. # Animation id.
  391. string animationId
  392. # Duration of the animation.
  393. number duration
  394. # Delay of the animation.
  395. number delay
  396. # Event for when an animation has been cancelled.
  397. event animationCanceled
  398. parameters
  399. # Id of the animation that was cancelled.
  400. string id
  401. # Event for each animation that has been created.
  402. event animationCreated
  403. parameters
  404. # Id of the animation that was created.
  405. string id
  406. # Event for animation that has been started.
  407. event animationStarted
  408. parameters
  409. # Animation that was started.
  410. Animation animation
  411. # Audits domain allows investigation of page violations and possible improvements.
  412. experimental domain Audits
  413. depends on Network
  414. # Information about a cookie that is affected by an inspector issue.
  415. type AffectedCookie extends object
  416. properties
  417. # The following three properties uniquely identify a cookie
  418. string name
  419. string path
  420. string domain
  421. # Information about a request that is affected by an inspector issue.
  422. type AffectedRequest extends object
  423. properties
  424. # The unique request id.
  425. Network.RequestId requestId
  426. optional string url
  427. # Information about the frame affected by an inspector issue.
  428. type AffectedFrame extends object
  429. properties
  430. Page.FrameId frameId
  431. type CookieExclusionReason extends string
  432. enum
  433. ExcludeSameSiteUnspecifiedTreatedAsLax
  434. ExcludeSameSiteNoneInsecure
  435. ExcludeSameSiteLax
  436. ExcludeSameSiteStrict
  437. ExcludeInvalidSameParty
  438. ExcludeSamePartyCrossPartyContext
  439. ExcludeDomainNonASCII
  440. ExcludeThirdPartyCookieBlockedInFirstPartySet
  441. type CookieWarningReason extends string
  442. enum
  443. WarnSameSiteUnspecifiedCrossSiteContext
  444. WarnSameSiteNoneInsecure
  445. WarnSameSiteUnspecifiedLaxAllowUnsafe
  446. WarnSameSiteStrictLaxDowngradeStrict
  447. WarnSameSiteStrictCrossDowngradeStrict
  448. WarnSameSiteStrictCrossDowngradeLax
  449. WarnSameSiteLaxCrossDowngradeStrict
  450. WarnSameSiteLaxCrossDowngradeLax
  451. WarnAttributeValueExceedsMaxSize
  452. WarnDomainNonASCII
  453. type CookieOperation extends string
  454. enum
  455. SetCookie
  456. ReadCookie
  457. # This information is currently necessary, as the front-end has a difficult
  458. # time finding a specific cookie. With this, we can convey specific error
  459. # information without the cookie.
  460. type CookieIssueDetails extends object
  461. properties
  462. # If AffectedCookie is not set then rawCookieLine contains the raw
  463. # Set-Cookie header string. This hints at a problem where the
  464. # cookie line is syntactically or semantically malformed in a way
  465. # that no valid cookie could be created.
  466. optional AffectedCookie cookie
  467. optional string rawCookieLine
  468. array of CookieWarningReason cookieWarningReasons
  469. array of CookieExclusionReason cookieExclusionReasons
  470. # Optionally identifies the site-for-cookies and the cookie url, which
  471. # may be used by the front-end as additional context.
  472. CookieOperation operation
  473. optional string siteForCookies
  474. optional string cookieUrl
  475. optional AffectedRequest request
  476. type MixedContentResolutionStatus extends string
  477. enum
  478. MixedContentBlocked
  479. MixedContentAutomaticallyUpgraded
  480. MixedContentWarning
  481. type MixedContentResourceType extends string
  482. enum
  483. AttributionSrc
  484. Audio
  485. Beacon
  486. CSPReport
  487. Download
  488. EventSource
  489. Favicon
  490. Font
  491. Form
  492. Frame
  493. Image
  494. Import
  495. Manifest
  496. Ping
  497. PluginData
  498. PluginResource
  499. Prefetch
  500. Resource
  501. Script
  502. ServiceWorker
  503. SharedWorker
  504. Stylesheet
  505. Track
  506. Video
  507. Worker
  508. XMLHttpRequest
  509. XSLT
  510. type MixedContentIssueDetails extends object
  511. properties
  512. # The type of resource causing the mixed content issue (css, js, iframe,
  513. # form,...). Marked as optional because it is mapped to from
  514. # blink::mojom::RequestContextType, which will be replaced
  515. # by network::mojom::RequestDestination
  516. optional MixedContentResourceType resourceType
  517. # The way the mixed content issue is being resolved.
  518. MixedContentResolutionStatus resolutionStatus
  519. # The unsafe http url causing the mixed content issue.
  520. string insecureURL
  521. # The url responsible for the call to an unsafe url.
  522. string mainResourceURL
  523. # The mixed content request.
  524. # Does not always exist (e.g. for unsafe form submission urls).
  525. optional AffectedRequest request
  526. # Optional because not every mixed content issue is necessarily linked to a frame.
  527. optional AffectedFrame frame
  528. # Enum indicating the reason a response has been blocked. These reasons are
  529. # refinements of the net error BLOCKED_BY_RESPONSE.
  530. type BlockedByResponseReason extends string
  531. enum
  532. CoepFrameResourceNeedsCoepHeader
  533. CoopSandboxedIFrameCannotNavigateToCoopPage
  534. CorpNotSameOrigin
  535. CorpNotSameOriginAfterDefaultedToSameOriginByCoep
  536. CorpNotSameSite
  537. # Details for a request that has been blocked with the BLOCKED_BY_RESPONSE
  538. # code. Currently only used for COEP/COOP, but may be extended to include
  539. # some CSP errors in the future.
  540. type BlockedByResponseIssueDetails extends object
  541. properties
  542. AffectedRequest request
  543. optional AffectedFrame parentFrame
  544. optional AffectedFrame blockedFrame
  545. BlockedByResponseReason reason
  546. type HeavyAdResolutionStatus extends string
  547. enum
  548. HeavyAdBlocked
  549. HeavyAdWarning
  550. type HeavyAdReason extends string
  551. enum
  552. NetworkTotalLimit
  553. CpuTotalLimit
  554. CpuPeakLimit
  555. type HeavyAdIssueDetails extends object
  556. properties
  557. # The resolution status, either blocking the content or warning.
  558. HeavyAdResolutionStatus resolution
  559. # The reason the ad was blocked, total network or cpu or peak cpu.
  560. HeavyAdReason reason
  561. # The frame that was blocked.
  562. AffectedFrame frame
  563. type ContentSecurityPolicyViolationType extends string
  564. enum
  565. kInlineViolation
  566. kEvalViolation
  567. kURLViolation
  568. kTrustedTypesSinkViolation
  569. kTrustedTypesPolicyViolation
  570. kWasmEvalViolation
  571. type SourceCodeLocation extends object
  572. properties
  573. optional Runtime.ScriptId scriptId
  574. string url
  575. integer lineNumber
  576. integer columnNumber
  577. type ContentSecurityPolicyIssueDetails extends object
  578. properties
  579. # The url not included in allowed sources.
  580. optional string blockedURL
  581. # Specific directive that is violated, causing the CSP issue.
  582. string violatedDirective
  583. boolean isReportOnly
  584. ContentSecurityPolicyViolationType contentSecurityPolicyViolationType
  585. optional AffectedFrame frameAncestor
  586. optional SourceCodeLocation sourceCodeLocation
  587. optional DOM.BackendNodeId violatingNodeId
  588. type SharedArrayBufferIssueType extends string
  589. enum
  590. TransferIssue
  591. CreationIssue
  592. # Details for a issue arising from an SAB being instantiated in, or
  593. # transferred to a context that is not cross-origin isolated.
  594. type SharedArrayBufferIssueDetails extends object
  595. properties
  596. SourceCodeLocation sourceCodeLocation
  597. boolean isWarning
  598. SharedArrayBufferIssueType type
  599. type LowTextContrastIssueDetails extends object
  600. properties
  601. DOM.BackendNodeId violatingNodeId
  602. string violatingNodeSelector
  603. number contrastRatio
  604. number thresholdAA
  605. number thresholdAAA
  606. string fontSize
  607. string fontWeight
  608. # Details for a CORS related issue, e.g. a warning or error related to
  609. # CORS RFC1918 enforcement.
  610. type CorsIssueDetails extends object
  611. properties
  612. Network.CorsErrorStatus corsErrorStatus
  613. boolean isWarning
  614. AffectedRequest request
  615. optional SourceCodeLocation location
  616. optional string initiatorOrigin
  617. optional Network.IPAddressSpace resourceIPAddressSpace
  618. optional Network.ClientSecurityState clientSecurityState
  619. type AttributionReportingIssueType extends string
  620. enum
  621. PermissionPolicyDisabled
  622. UntrustworthyReportingOrigin
  623. InsecureContext
  624. # TODO(apaseltiner): Rename this to InvalidRegisterSourceHeader
  625. InvalidHeader
  626. InvalidRegisterTriggerHeader
  627. SourceAndTriggerHeaders
  628. SourceIgnored
  629. TriggerIgnored
  630. OsSourceIgnored
  631. OsTriggerIgnored
  632. InvalidRegisterOsSourceHeader
  633. InvalidRegisterOsTriggerHeader
  634. WebAndOsHeaders
  635. NoWebOrOsSupport
  636. # Details for issues around "Attribution Reporting API" usage.
  637. # Explainer: https://github.com/WICG/attribution-reporting-api
  638. type AttributionReportingIssueDetails extends object
  639. properties
  640. AttributionReportingIssueType violationType
  641. optional AffectedRequest request
  642. optional DOM.BackendNodeId violatingNodeId
  643. optional string invalidParameter
  644. # Details for issues about documents in Quirks Mode
  645. # or Limited Quirks Mode that affects page layouting.
  646. type QuirksModeIssueDetails extends object
  647. properties
  648. # If false, it means the document's mode is "quirks"
  649. # instead of "limited-quirks".
  650. boolean isLimitedQuirksMode
  651. DOM.BackendNodeId documentNodeId
  652. string url
  653. Page.FrameId frameId
  654. Network.LoaderId loaderId
  655. type NavigatorUserAgentIssueDetails extends object
  656. properties
  657. string url
  658. optional SourceCodeLocation location
  659. type GenericIssueErrorType extends string
  660. enum
  661. CrossOriginPortalPostMessageError
  662. FormLabelForNameError
  663. FormDuplicateIdForInputError
  664. FormInputWithNoLabelError
  665. FormAutocompleteAttributeEmptyError
  666. FormEmptyIdAndNameAttributesForInputError
  667. FormAriaLabelledByToNonExistingId
  668. FormInputAssignedAutocompleteValueToIdOrNameAttributeError
  669. FormLabelHasNeitherForNorNestedInput
  670. FormLabelForMatchesNonExistingIdError
  671. FormInputHasWrongButWellIntendedAutocompleteValueError
  672. # Depending on the concrete errorType, different properties are set.
  673. type GenericIssueDetails extends object
  674. properties
  675. # Issues with the same errorType are aggregated in the frontend.
  676. GenericIssueErrorType errorType
  677. optional Page.FrameId frameId
  678. optional DOM.BackendNodeId violatingNodeId
  679. optional string violatingNodeAttribute
  680. # This issue tracks information needed to print a deprecation message.
  681. # https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md
  682. type DeprecationIssueDetails extends object
  683. properties
  684. optional AffectedFrame affectedFrame
  685. SourceCodeLocation sourceCodeLocation
  686. # One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5
  687. string type
  688. # This issue warns about sites in the redirect chain of a finished navigation
  689. # that may be flagged as trackers and have their state cleared if they don't
  690. # receive a user interaction. Note that in this context 'site' means eTLD+1.
  691. # For example, if the URL `https://example.test:80/bounce` was in the
  692. # redirect chain, the site reported would be `example.test`.
  693. type BounceTrackingIssueDetails extends object
  694. properties
  695. array of string trackingSites
  696. type ClientHintIssueReason extends string
  697. enum
  698. # Items in the accept-ch meta tag allow list must be valid origins.
  699. # No special values (e.g. self, none, and *) are permitted.
  700. MetaTagAllowListInvalidOrigin
  701. # Only accept-ch meta tags in the original HTML sent from the server
  702. # are respected. Any injected via javascript (or other means) are ignored.
  703. MetaTagModifiedHTML
  704. type FederatedAuthRequestIssueDetails extends object
  705. properties
  706. FederatedAuthRequestIssueReason federatedAuthRequestIssueReason
  707. # Represents the failure reason when a federated authentication reason fails.
  708. # Should be updated alongside RequestIdTokenStatus in
  709. # third_party/blink/public/mojom/devtools/inspector_issue.mojom to include
  710. # all cases except for success.
  711. type FederatedAuthRequestIssueReason extends string
  712. enum
  713. ShouldEmbargo
  714. TooManyRequests
  715. WellKnownHttpNotFound
  716. WellKnownNoResponse
  717. WellKnownInvalidResponse
  718. WellKnownListEmpty
  719. WellKnownInvalidContentType
  720. ConfigNotInWellKnown
  721. WellKnownTooBig
  722. ConfigHttpNotFound
  723. ConfigNoResponse
  724. ConfigInvalidResponse
  725. ConfigInvalidContentType
  726. ClientMetadataHttpNotFound
  727. ClientMetadataNoResponse
  728. ClientMetadataInvalidResponse
  729. ClientMetadataInvalidContentType
  730. DisabledInSettings
  731. ErrorFetchingSignin
  732. InvalidSigninResponse
  733. AccountsHttpNotFound
  734. AccountsNoResponse
  735. AccountsInvalidResponse
  736. AccountsListEmpty
  737. AccountsInvalidContentType
  738. IdTokenHttpNotFound
  739. IdTokenNoResponse
  740. IdTokenInvalidResponse
  741. IdTokenInvalidRequest
  742. IdTokenInvalidContentType
  743. ErrorIdToken
  744. Canceled
  745. RpPageNotVisible
  746. SilentMediationFailure
  747. # This issue tracks client hints related issues. It's used to deprecate old
  748. # features, encourage the use of new ones, and provide general guidance.
  749. type ClientHintIssueDetails extends object
  750. properties
  751. SourceCodeLocation sourceCodeLocation
  752. ClientHintIssueReason clientHintIssueReason
  753. # A unique identifier for the type of issue. Each type may use one of the
  754. # optional fields in InspectorIssueDetails to convey more specific
  755. # information about the kind of issue.
  756. type InspectorIssueCode extends string
  757. enum
  758. CookieIssue
  759. MixedContentIssue
  760. BlockedByResponseIssue
  761. HeavyAdIssue
  762. ContentSecurityPolicyIssue
  763. SharedArrayBufferIssue
  764. LowTextContrastIssue
  765. CorsIssue
  766. AttributionReportingIssue
  767. QuirksModeIssue
  768. NavigatorUserAgentIssue
  769. GenericIssue
  770. DeprecationIssue
  771. ClientHintIssue
  772. FederatedAuthRequestIssue
  773. BounceTrackingIssue
  774. # This struct holds a list of optional fields with additional information
  775. # specific to the kind of issue. When adding a new issue code, please also
  776. # add a new optional field to this type.
  777. type InspectorIssueDetails extends object
  778. properties
  779. optional CookieIssueDetails cookieIssueDetails
  780. optional MixedContentIssueDetails mixedContentIssueDetails
  781. optional BlockedByResponseIssueDetails blockedByResponseIssueDetails
  782. optional HeavyAdIssueDetails heavyAdIssueDetails
  783. optional ContentSecurityPolicyIssueDetails contentSecurityPolicyIssueDetails
  784. optional SharedArrayBufferIssueDetails sharedArrayBufferIssueDetails
  785. optional LowTextContrastIssueDetails lowTextContrastIssueDetails
  786. optional CorsIssueDetails corsIssueDetails
  787. optional AttributionReportingIssueDetails attributionReportingIssueDetails
  788. optional QuirksModeIssueDetails quirksModeIssueDetails
  789. optional NavigatorUserAgentIssueDetails navigatorUserAgentIssueDetails
  790. optional GenericIssueDetails genericIssueDetails
  791. optional DeprecationIssueDetails deprecationIssueDetails
  792. optional ClientHintIssueDetails clientHintIssueDetails
  793. optional FederatedAuthRequestIssueDetails federatedAuthRequestIssueDetails
  794. optional BounceTrackingIssueDetails bounceTrackingIssueDetails
  795. # A unique id for a DevTools inspector issue. Allows other entities (e.g.
  796. # exceptions, CDP message, console messages, etc.) to reference an issue.
  797. type IssueId extends string
  798. # An inspector issue reported from the back-end.
  799. type InspectorIssue extends object
  800. properties
  801. InspectorIssueCode code
  802. InspectorIssueDetails details
  803. # A unique id for this issue. May be omitted if no other entity (e.g.
  804. # exception, CDP message, etc.) is referencing this issue.
  805. optional IssueId issueId
  806. # Returns the response body and size if it were re-encoded with the specified settings. Only
  807. # applies to images.
  808. command getEncodedResponse
  809. parameters
  810. # Identifier of the network request to get content for.
  811. Network.RequestId requestId
  812. # The encoding to use.
  813. enum encoding
  814. webp
  815. jpeg
  816. png
  817. # The quality of the encoding (0-1). (defaults to 1)
  818. optional number quality
  819. # Whether to only return the size information (defaults to false).
  820. optional boolean sizeOnly
  821. returns
  822. # The encoded body as a base64 string. Omitted if sizeOnly is true.
  823. optional binary body
  824. # Size before re-encoding.
  825. integer originalSize
  826. # Size after re-encoding.
  827. integer encodedSize
  828. # Disables issues domain, prevents further issues from being reported to the client.
  829. command disable
  830. # Enables issues domain, sends the issues collected so far to the client by means of the
  831. # `issueAdded` event.
  832. command enable
  833. # Runs the contrast check for the target page. Found issues are reported
  834. # using Audits.issueAdded event.
  835. command checkContrast
  836. parameters
  837. # Whether to report WCAG AAA level issues. Default is false.
  838. optional boolean reportAAA
  839. # Runs the form issues check for the target page. Found issues are reported
  840. # using Audits.issueAdded event.
  841. command checkFormsIssues
  842. returns
  843. array of GenericIssueDetails formIssues
  844. event issueAdded
  845. parameters
  846. InspectorIssue issue
  847. # Defines commands and events for Autofill.
  848. experimental domain Autofill
  849. type CreditCard extends object
  850. properties
  851. # 16-digit credit card number.
  852. string number
  853. # Name of the credit card owner.
  854. string name
  855. # 2-digit expiry month.
  856. string expiryMonth
  857. # 4-digit expiry year.
  858. string expiryYear
  859. # 3-digit card verification code.
  860. string cvc
  861. # Trigger autofill on a form identified by the fieldId.
  862. # If the field and related form cannot be autofilled, returns an error.
  863. command trigger
  864. parameters
  865. # Identifies a field that serves as an anchor for autofill.
  866. DOM.BackendNodeId fieldId
  867. # Identifies the frame that field belongs to.
  868. optional Page.FrameId frameId
  869. # Credit card information to fill out the form. Credit card data is not saved.
  870. CreditCard card
  871. # Defines events for background web platform features.
  872. experimental domain BackgroundService
  873. # The Background Service that will be associated with the commands/events.
  874. # Every Background Service operates independently, but they share the same
  875. # API.
  876. type ServiceName extends string
  877. enum
  878. backgroundFetch
  879. backgroundSync
  880. pushMessaging
  881. notifications
  882. paymentHandler
  883. periodicBackgroundSync
  884. # Enables event updates for the service.
  885. command startObserving
  886. parameters
  887. ServiceName service
  888. # Disables event updates for the service.
  889. command stopObserving
  890. parameters
  891. ServiceName service
  892. # Set the recording state for the service.
  893. command setRecording
  894. parameters
  895. boolean shouldRecord
  896. ServiceName service
  897. # Clears all stored data for the service.
  898. command clearEvents
  899. parameters
  900. ServiceName service
  901. # Called when the recording state for the service has been updated.
  902. event recordingStateChanged
  903. parameters
  904. boolean isRecording
  905. ServiceName service
  906. # A key-value pair for additional event information to pass along.
  907. type EventMetadata extends object
  908. properties
  909. string key
  910. string value
  911. type BackgroundServiceEvent extends object
  912. properties
  913. # Timestamp of the event (in seconds).
  914. Network.TimeSinceEpoch timestamp
  915. # The origin this event belongs to.
  916. string origin
  917. # The Service Worker ID that initiated the event.
  918. ServiceWorker.RegistrationID serviceWorkerRegistrationId
  919. # The Background Service this event belongs to.
  920. ServiceName service
  921. # A description of the event.
  922. string eventName
  923. # An identifier that groups related events together.
  924. string instanceId
  925. # A list of event-specific information.
  926. array of EventMetadata eventMetadata
  927. # Storage key this event belongs to.
  928. string storageKey
  929. # Called with all existing backgroundServiceEvents when enabled, and all new
  930. # events afterwards if enabled and recording.
  931. event backgroundServiceEventReceived
  932. parameters
  933. BackgroundServiceEvent backgroundServiceEvent
  934. # The Browser domain defines methods and events for browser managing.
  935. domain Browser
  936. experimental type BrowserContextID extends string
  937. experimental type WindowID extends integer
  938. # The state of the browser window.
  939. experimental type WindowState extends string
  940. enum
  941. normal
  942. minimized
  943. maximized
  944. fullscreen
  945. # Browser window bounds information
  946. experimental type Bounds extends object
  947. properties
  948. # The offset from the left edge of the screen to the window in pixels.
  949. optional integer left
  950. # The offset from the top edge of the screen to the window in pixels.
  951. optional integer top
  952. # The window width in pixels.
  953. optional integer width
  954. # The window height in pixels.
  955. optional integer height
  956. # The window state. Default to normal.
  957. optional WindowState windowState
  958. experimental type PermissionType extends string
  959. enum
  960. accessibilityEvents
  961. audioCapture
  962. backgroundSync
  963. backgroundFetch
  964. clipboardReadWrite
  965. clipboardSanitizedWrite
  966. displayCapture
  967. durableStorage
  968. flash
  969. geolocation
  970. idleDetection
  971. localFonts
  972. midi
  973. midiSysex
  974. nfc
  975. notifications
  976. paymentHandler
  977. periodicBackgroundSync
  978. protectedMediaIdentifier
  979. sensors
  980. storageAccess
  981. topLevelStorageAccess
  982. videoCapture
  983. videoCapturePanTiltZoom
  984. wakeLockScreen
  985. wakeLockSystem
  986. windowManagement
  987. experimental type PermissionSetting extends string
  988. enum
  989. granted
  990. denied
  991. prompt
  992. # Definition of PermissionDescriptor defined in the Permissions API:
  993. # https://w3c.github.io/permissions/#dictdef-permissiondescriptor.
  994. experimental type PermissionDescriptor extends object
  995. properties
  996. # Name of permission.
  997. # See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
  998. string name
  999. # For "midi" permission, may also specify sysex control.
  1000. optional boolean sysex
  1001. # For "push" permission, may specify userVisibleOnly.
  1002. # Note that userVisibleOnly = true is the only currently supported type.
  1003. optional boolean userVisibleOnly
  1004. # For "clipboard" permission, may specify allowWithoutSanitization.
  1005. optional boolean allowWithoutSanitization
  1006. # For "camera" permission, may specify panTiltZoom.
  1007. optional boolean panTiltZoom
  1008. # Browser command ids used by executeBrowserCommand.
  1009. experimental type BrowserCommandId extends string
  1010. enum
  1011. openTabSearch
  1012. closeTabSearch
  1013. # Set permission settings for given origin.
  1014. experimental command setPermission
  1015. parameters
  1016. # Descriptor of permission to override.
  1017. PermissionDescriptor permission
  1018. # Setting of the permission.
  1019. PermissionSetting setting
  1020. # Origin the permission applies to, all origins if not specified.
  1021. optional string origin
  1022. # Context to override. When omitted, default browser context is used.
  1023. optional BrowserContextID browserContextId
  1024. # Grant specific permissions to the given origin and reject all others.
  1025. experimental command grantPermissions
  1026. parameters
  1027. array of PermissionType permissions
  1028. # Origin the permission applies to, all origins if not specified.
  1029. optional string origin
  1030. # BrowserContext to override permissions. When omitted, default browser context is used.
  1031. optional BrowserContextID browserContextId
  1032. # Reset all permission management for all origins.
  1033. experimental command resetPermissions
  1034. parameters
  1035. # BrowserContext to reset permissions. When omitted, default browser context is used.
  1036. optional BrowserContextID browserContextId
  1037. # Set the behavior when downloading a file.
  1038. experimental command setDownloadBehavior
  1039. parameters
  1040. # Whether to allow all or deny all download requests, or use default Chrome behavior if
  1041. # available (otherwise deny). |allowAndName| allows download and names files according to
  1042. # their dowmload guids.
  1043. enum behavior
  1044. deny
  1045. allow
  1046. allowAndName
  1047. default
  1048. # BrowserContext to set download behavior. When omitted, default browser context is used.
  1049. optional BrowserContextID browserContextId
  1050. # The default path to save downloaded files to. This is required if behavior is set to 'allow'
  1051. # or 'allowAndName'.
  1052. optional string downloadPath
  1053. # Whether to emit download events (defaults to false).
  1054. optional boolean eventsEnabled
  1055. # Cancel a download if in progress
  1056. experimental command cancelDownload
  1057. parameters
  1058. # Global unique identifier of the download.
  1059. string guid
  1060. # BrowserContext to perform the action in. When omitted, default browser context is used.
  1061. optional BrowserContextID browserContextId
  1062. # Fired when page is about to start a download.
  1063. experimental event downloadWillBegin
  1064. parameters
  1065. # Id of the frame that caused the download to begin.
  1066. Page.FrameId frameId
  1067. # Global unique identifier of the download.
  1068. string guid
  1069. # URL of the resource being downloaded.
  1070. string url
  1071. # Suggested file name of the resource (the actual name of the file saved on disk may differ).
  1072. string suggestedFilename
  1073. # Fired when download makes progress. Last call has |done| == true.
  1074. experimental event downloadProgress
  1075. parameters
  1076. # Global unique identifier of the download.
  1077. string guid
  1078. # Total expected bytes to download.
  1079. number totalBytes
  1080. # Total bytes received.
  1081. number receivedBytes
  1082. # Download status.
  1083. enum state
  1084. inProgress
  1085. completed
  1086. canceled
  1087. # Close browser gracefully.
  1088. command close
  1089. # Crashes browser on the main thread.
  1090. experimental command crash
  1091. # Crashes GPU process.
  1092. experimental command crashGpuProcess
  1093. # Returns version information.
  1094. command getVersion
  1095. returns
  1096. # Protocol version.
  1097. string protocolVersion
  1098. # Product name.
  1099. string product
  1100. # Product revision.
  1101. string revision
  1102. # User-Agent.
  1103. string userAgent
  1104. # V8 version.
  1105. string jsVersion
  1106. # Returns the command line switches for the browser process if, and only if
  1107. # --enable-automation is on the commandline.
  1108. experimental command getBrowserCommandLine
  1109. returns
  1110. # Commandline parameters
  1111. array of string arguments
  1112. # Chrome histogram bucket.
  1113. experimental type Bucket extends object
  1114. properties
  1115. # Minimum value (inclusive).
  1116. integer low
  1117. # Maximum value (exclusive).
  1118. integer high
  1119. # Number of samples.
  1120. integer count
  1121. # Chrome histogram.
  1122. experimental type Histogram extends object
  1123. properties
  1124. # Name.
  1125. string name
  1126. # Sum of sample values.
  1127. integer sum
  1128. # Total number of samples.
  1129. integer count
  1130. # Buckets.
  1131. array of Bucket buckets
  1132. # Get Chrome histograms.
  1133. experimental command getHistograms
  1134. parameters
  1135. # Requested substring in name. Only histograms which have query as a
  1136. # substring in their name are extracted. An empty or absent query returns
  1137. # all histograms.
  1138. optional string query
  1139. # If true, retrieve delta since last delta call.
  1140. optional boolean delta
  1141. returns
  1142. # Histograms.
  1143. array of Histogram histograms
  1144. # Get a Chrome histogram by name.
  1145. experimental command getHistogram
  1146. parameters
  1147. # Requested histogram name.
  1148. string name
  1149. # If true, retrieve delta since last delta call.
  1150. optional boolean delta
  1151. returns
  1152. # Histogram.
  1153. Histogram histogram
  1154. # Get position and size of the browser window.
  1155. experimental command getWindowBounds
  1156. parameters
  1157. # Browser window id.
  1158. WindowID windowId
  1159. returns
  1160. # Bounds information of the window. When window state is 'minimized', the restored window
  1161. # position and size are returned.
  1162. Bounds bounds
  1163. # Get the browser window that contains the devtools target.
  1164. experimental command getWindowForTarget
  1165. parameters
  1166. # Devtools agent host id. If called as a part of the session, associated targetId is used.
  1167. optional Target.TargetID targetId
  1168. returns
  1169. # Browser window id.
  1170. WindowID windowId
  1171. # Bounds information of the window. When window state is 'minimized', the restored window
  1172. # position and size are returned.
  1173. Bounds bounds
  1174. # Set position and/or size of the browser window.
  1175. experimental command setWindowBounds
  1176. parameters
  1177. # Browser window id.
  1178. WindowID windowId
  1179. # New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
  1180. # with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
  1181. Bounds bounds
  1182. # Set dock tile details, platform-specific.
  1183. experimental command setDockTile
  1184. parameters
  1185. optional string badgeLabel
  1186. # Png encoded image.
  1187. optional binary image
  1188. # Invoke custom browser commands used by telemetry.
  1189. experimental command executeBrowserCommand
  1190. parameters
  1191. BrowserCommandId commandId
  1192. # Allows a site to use privacy sandbox features that require enrollment
  1193. # without the site actually being enrolled. Only supported on page targets.
  1194. command addPrivacySandboxEnrollmentOverride
  1195. parameters
  1196. string url
  1197. # This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
  1198. # have an associated `id` used in subsequent operations on the related object. Each object type has
  1199. # a specific `id` structure, and those are not interchangeable between objects of different kinds.
  1200. # CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
  1201. # can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
  1202. # subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
  1203. experimental domain CSS
  1204. depends on DOM
  1205. depends on Page
  1206. type StyleSheetId extends string
  1207. # Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
  1208. # stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
  1209. # inspector" rules), "regular" for regular stylesheets.
  1210. type StyleSheetOrigin extends string
  1211. enum
  1212. injected
  1213. user-agent
  1214. inspector
  1215. regular
  1216. # CSS rule collection for a single pseudo style.
  1217. type PseudoElementMatches extends object
  1218. properties
  1219. # Pseudo element type.
  1220. DOM.PseudoType pseudoType
  1221. # Pseudo element custom ident.
  1222. optional string pseudoIdentifier
  1223. # Matches of CSS rules applicable to the pseudo style.
  1224. array of RuleMatch matches
  1225. # Inherited CSS rule collection from ancestor node.
  1226. type InheritedStyleEntry extends object
  1227. properties
  1228. # The ancestor node's inline style, if any, in the style inheritance chain.
  1229. optional CSSStyle inlineStyle
  1230. # Matches of CSS rules matching the ancestor node in the style inheritance chain.
  1231. array of RuleMatch matchedCSSRules
  1232. # Inherited pseudo element matches from pseudos of an ancestor node.
  1233. type InheritedPseudoElementMatches extends object
  1234. properties
  1235. # Matches of pseudo styles from the pseudos of an ancestor node.
  1236. array of PseudoElementMatches pseudoElements
  1237. # Match data for a CSS rule.
  1238. type RuleMatch extends object
  1239. properties
  1240. # CSS rule in the match.
  1241. CSSRule rule
  1242. # Matching selector indices in the rule's selectorList selectors (0-based).
  1243. array of integer matchingSelectors
  1244. # Data for a simple selector (these are delimited by commas in a selector list).
  1245. type Value extends object
  1246. properties
  1247. # Value text.
  1248. string text
  1249. # Value range in the underlying resource (if available).
  1250. optional SourceRange range
  1251. # Specificity of the selector.
  1252. experimental optional Specificity specificity
  1253. # Specificity:
  1254. # https://drafts.csswg.org/selectors/#specificity-rules
  1255. experimental type Specificity extends object
  1256. properties
  1257. # The a component, which represents the number of ID selectors.
  1258. integer a
  1259. # The b component, which represents the number of class selectors, attributes selectors, and
  1260. # pseudo-classes.
  1261. integer b
  1262. # The c component, which represents the number of type selectors and pseudo-elements.
  1263. integer c
  1264. # Selector list data.
  1265. type SelectorList extends object
  1266. properties
  1267. # Selectors in the list.
  1268. array of Value selectors
  1269. # Rule selector text.
  1270. string text
  1271. # CSS stylesheet metainformation.
  1272. type CSSStyleSheetHeader extends object
  1273. properties
  1274. # The stylesheet identifier.
  1275. StyleSheetId styleSheetId
  1276. # Owner frame identifier.
  1277. Page.FrameId frameId
  1278. # Stylesheet resource URL. Empty if this is a constructed stylesheet created using
  1279. # new CSSStyleSheet() (but non-empty if this is a constructed sylesheet imported
  1280. # as a CSS module script).
  1281. string sourceURL
  1282. # URL of source map associated with the stylesheet (if any).
  1283. optional string sourceMapURL
  1284. # Stylesheet origin.
  1285. StyleSheetOrigin origin
  1286. # Stylesheet title.
  1287. string title
  1288. # The backend id for the owner node of the stylesheet.
  1289. optional DOM.BackendNodeId ownerNode
  1290. # Denotes whether the stylesheet is disabled.
  1291. boolean disabled
  1292. # Whether the sourceURL field value comes from the sourceURL comment.
  1293. optional boolean hasSourceURL
  1294. # Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
  1295. # document.written STYLE tags.
  1296. boolean isInline
  1297. # Whether this stylesheet is mutable. Inline stylesheets become mutable
  1298. # after they have been modified via CSSOM API.
  1299. # <link> element's stylesheets become mutable only if DevTools modifies them.
  1300. # Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
  1301. boolean isMutable
  1302. # True if this stylesheet is created through new CSSStyleSheet() or imported as a
  1303. # CSS module script.
  1304. boolean isConstructed
  1305. # Line offset of the stylesheet within the resource (zero based).
  1306. number startLine
  1307. # Column offset of the stylesheet within the resource (zero based).
  1308. number startColumn
  1309. # Size of the content (in characters).
  1310. number length
  1311. # Line offset of the end of the stylesheet within the resource (zero based).
  1312. number endLine
  1313. # Column offset of the end of the stylesheet within the resource (zero based).
  1314. number endColumn
  1315. # If the style sheet was loaded from a network resource, this indicates when the resource failed to load
  1316. experimental optional boolean loadingFailed
  1317. # CSS rule representation.
  1318. type CSSRule extends object
  1319. properties
  1320. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1321. # stylesheet rules) this rule came from.
  1322. optional StyleSheetId styleSheetId
  1323. # Rule selector data.
  1324. SelectorList selectorList
  1325. # Array of selectors from ancestor style rules, sorted by distance from the current rule.
  1326. experimental optional array of string nestingSelectors
  1327. # Parent stylesheet's origin.
  1328. StyleSheetOrigin origin
  1329. # Associated style declaration.
  1330. CSSStyle style
  1331. # Media list array (for rules involving media queries). The array enumerates media queries
  1332. # starting with the innermost one, going outwards.
  1333. optional array of CSSMedia media
  1334. # Container query list array (for rules involving container queries).
  1335. # The array enumerates container queries starting with the innermost one, going outwards.
  1336. experimental optional array of CSSContainerQuery containerQueries
  1337. # @supports CSS at-rule array.
  1338. # The array enumerates @supports at-rules starting with the innermost one, going outwards.
  1339. experimental optional array of CSSSupports supports
  1340. # Cascade layer array. Contains the layer hierarchy that this rule belongs to starting
  1341. # with the innermost layer and going outwards.
  1342. experimental optional array of CSSLayer layers
  1343. # @scope CSS at-rule array.
  1344. # The array enumerates @scope at-rules starting with the innermost one, going outwards.
  1345. experimental optional array of CSSScope scopes
  1346. # CSS coverage information.
  1347. type RuleUsage extends object
  1348. properties
  1349. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1350. # stylesheet rules) this rule came from.
  1351. StyleSheetId styleSheetId
  1352. # Offset of the start of the rule (including selector) from the beginning of the stylesheet.
  1353. number startOffset
  1354. # Offset of the end of the rule body from the beginning of the stylesheet.
  1355. number endOffset
  1356. # Indicates whether the rule was actually used by some element in the page.
  1357. boolean used
  1358. # Text range within a resource. All numbers are zero-based.
  1359. type SourceRange extends object
  1360. properties
  1361. # Start line of range.
  1362. integer startLine
  1363. # Start column of range (inclusive).
  1364. integer startColumn
  1365. # End line of range
  1366. integer endLine
  1367. # End column of range (exclusive).
  1368. integer endColumn
  1369. type ShorthandEntry extends object
  1370. properties
  1371. # Shorthand name.
  1372. string name
  1373. # Shorthand value.
  1374. string value
  1375. # Whether the property has "!important" annotation (implies `false` if absent).
  1376. optional boolean important
  1377. type CSSComputedStyleProperty extends object
  1378. properties
  1379. # Computed style property name.
  1380. string name
  1381. # Computed style property value.
  1382. string value
  1383. # CSS style representation.
  1384. type CSSStyle extends object
  1385. properties
  1386. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1387. # stylesheet rules) this rule came from.
  1388. optional StyleSheetId styleSheetId
  1389. # CSS properties in the style.
  1390. array of CSSProperty cssProperties
  1391. # Computed values for all shorthands found in the style.
  1392. array of ShorthandEntry shorthandEntries
  1393. # Style declaration text (if available).
  1394. optional string cssText
  1395. # Style declaration range in the enclosing stylesheet (if available).
  1396. optional SourceRange range
  1397. # CSS property declaration data.
  1398. type CSSProperty extends object
  1399. properties
  1400. # The property name.
  1401. string name
  1402. # The property value.
  1403. string value
  1404. # Whether the property has "!important" annotation (implies `false` if absent).
  1405. optional boolean important
  1406. # Whether the property is implicit (implies `false` if absent).
  1407. optional boolean implicit
  1408. # The full property text as specified in the style.
  1409. optional string text
  1410. # Whether the property is understood by the browser (implies `true` if absent).
  1411. optional boolean parsedOk
  1412. # Whether the property is disabled by the user (present for source-based properties only).
  1413. optional boolean disabled
  1414. # The entire property range in the enclosing style declaration (if available).
  1415. optional SourceRange range
  1416. # Parsed longhand components of this property if it is a shorthand.
  1417. # This field will be empty if the given property is not a shorthand.
  1418. experimental optional array of CSSProperty longhandProperties
  1419. # CSS media rule descriptor.
  1420. type CSSMedia extends object
  1421. properties
  1422. # Media query text.
  1423. string text
  1424. # Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
  1425. # specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
  1426. # stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
  1427. # stylesheet's STYLE tag.
  1428. enum source
  1429. mediaRule
  1430. importRule
  1431. linkedSheet
  1432. inlineSheet
  1433. # URL of the document containing the media query description.
  1434. optional string sourceURL
  1435. # The associated rule (@media or @import) header range in the enclosing stylesheet (if
  1436. # available).
  1437. optional SourceRange range
  1438. # Identifier of the stylesheet containing this object (if exists).
  1439. optional StyleSheetId styleSheetId
  1440. # Array of media queries.
  1441. optional array of MediaQuery mediaList
  1442. # Media query descriptor.
  1443. type MediaQuery extends object
  1444. properties
  1445. # Array of media query expressions.
  1446. array of MediaQueryExpression expressions
  1447. # Whether the media query condition is satisfied.
  1448. boolean active
  1449. # Media query expression descriptor.
  1450. type MediaQueryExpression extends object
  1451. properties
  1452. # Media query expression value.
  1453. number value
  1454. # Media query expression units.
  1455. string unit
  1456. # Media query expression feature.
  1457. string feature
  1458. # The associated range of the value text in the enclosing stylesheet (if available).
  1459. optional SourceRange valueRange
  1460. # Computed length of media query expression (if applicable).
  1461. optional number computedLength
  1462. # CSS container query rule descriptor.
  1463. experimental type CSSContainerQuery extends object
  1464. properties
  1465. # Container query text.
  1466. string text
  1467. # The associated rule header range in the enclosing stylesheet (if
  1468. # available).
  1469. optional SourceRange range
  1470. # Identifier of the stylesheet containing this object (if exists).
  1471. optional StyleSheetId styleSheetId
  1472. # Optional name for the container.
  1473. optional string name
  1474. # Optional physical axes queried for the container.
  1475. optional DOM.PhysicalAxes physicalAxes
  1476. # Optional logical axes queried for the container.
  1477. optional DOM.LogicalAxes logicalAxes
  1478. # CSS Supports at-rule descriptor.
  1479. experimental type CSSSupports extends object
  1480. properties
  1481. # Supports rule text.
  1482. string text
  1483. # Whether the supports condition is satisfied.
  1484. boolean active
  1485. # The associated rule header range in the enclosing stylesheet (if
  1486. # available).
  1487. optional SourceRange range
  1488. # Identifier of the stylesheet containing this object (if exists).
  1489. optional StyleSheetId styleSheetId
  1490. # CSS Scope at-rule descriptor.
  1491. experimental type CSSScope extends object
  1492. properties
  1493. # Scope rule text.
  1494. string text
  1495. # The associated rule header range in the enclosing stylesheet (if
  1496. # available).
  1497. optional SourceRange range
  1498. # Identifier of the stylesheet containing this object (if exists).
  1499. optional StyleSheetId styleSheetId
  1500. # CSS Layer at-rule descriptor.
  1501. experimental type CSSLayer extends object
  1502. properties
  1503. # Layer name.
  1504. string text
  1505. # The associated rule header range in the enclosing stylesheet (if
  1506. # available).
  1507. optional SourceRange range
  1508. # Identifier of the stylesheet containing this object (if exists).
  1509. optional StyleSheetId styleSheetId
  1510. # CSS Layer data.
  1511. experimental type CSSLayerData extends object
  1512. properties
  1513. # Layer name.
  1514. string name
  1515. # Direct sub-layers
  1516. optional array of CSSLayerData subLayers
  1517. # Layer order. The order determines the order of the layer in the cascade order.
  1518. # A higher number has higher priority in the cascade order.
  1519. number order
  1520. # Information about amount of glyphs that were rendered with given font.
  1521. type PlatformFontUsage extends object
  1522. properties
  1523. # Font's family name reported by platform.
  1524. string familyName
  1525. # Indicates if the font was downloaded or resolved locally.
  1526. boolean isCustomFont
  1527. # Amount of glyphs that were rendered with this font.
  1528. number glyphCount
  1529. # Information about font variation axes for variable fonts
  1530. type FontVariationAxis extends object
  1531. properties
  1532. # The font-variation-setting tag (a.k.a. "axis tag").
  1533. string tag
  1534. # Human-readable variation name in the default language (normally, "en").
  1535. string name
  1536. # The minimum value (inclusive) the font supports for this tag.
  1537. number minValue
  1538. # The maximum value (inclusive) the font supports for this tag.
  1539. number maxValue
  1540. # The default value.
  1541. number defaultValue
  1542. # Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
  1543. # and additional information such as platformFontFamily and fontVariationAxes.
  1544. type FontFace extends object
  1545. properties
  1546. # The font-family.
  1547. string fontFamily
  1548. # The font-style.
  1549. string fontStyle
  1550. # The font-variant.
  1551. string fontVariant
  1552. # The font-weight.
  1553. string fontWeight
  1554. # The font-stretch.
  1555. string fontStretch
  1556. # The font-display.
  1557. string fontDisplay
  1558. # The unicode-range.
  1559. string unicodeRange
  1560. # The src.
  1561. string src
  1562. # The resolved platform font family
  1563. string platformFontFamily
  1564. # Available variation settings (a.k.a. "axes").
  1565. optional array of FontVariationAxis fontVariationAxes
  1566. # CSS try rule representation.
  1567. type CSSTryRule extends object
  1568. properties
  1569. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1570. # stylesheet rules) this rule came from.
  1571. optional StyleSheetId styleSheetId
  1572. # Parent stylesheet's origin.
  1573. StyleSheetOrigin origin
  1574. # Associated style declaration.
  1575. CSSStyle style
  1576. # CSS position-fallback rule representation.
  1577. type CSSPositionFallbackRule extends object
  1578. properties
  1579. Value name
  1580. # List of keyframes.
  1581. array of CSSTryRule tryRules
  1582. # CSS keyframes rule representation.
  1583. type CSSKeyframesRule extends object
  1584. properties
  1585. # Animation name.
  1586. Value animationName
  1587. # List of keyframes.
  1588. array of CSSKeyframeRule keyframes
  1589. # CSS keyframe rule representation.
  1590. type CSSKeyframeRule extends object
  1591. properties
  1592. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1593. # stylesheet rules) this rule came from.
  1594. optional StyleSheetId styleSheetId
  1595. # Parent stylesheet's origin.
  1596. StyleSheetOrigin origin
  1597. # Associated key text.
  1598. Value keyText
  1599. # Associated style declaration.
  1600. CSSStyle style
  1601. # A descriptor of operation to mutate style declaration text.
  1602. type StyleDeclarationEdit extends object
  1603. properties
  1604. # The css style sheet identifier.
  1605. StyleSheetId styleSheetId
  1606. # The range of the style text in the enclosing stylesheet.
  1607. SourceRange range
  1608. # New style text.
  1609. string text
  1610. # Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
  1611. # position specified by `location`.
  1612. command addRule
  1613. parameters
  1614. # The css style sheet identifier where a new rule should be inserted.
  1615. StyleSheetId styleSheetId
  1616. # The text of a new rule.
  1617. string ruleText
  1618. # Text position of a new rule in the target style sheet.
  1619. SourceRange location
  1620. returns
  1621. # The newly created rule.
  1622. CSSRule rule
  1623. # Returns all class names from specified stylesheet.
  1624. command collectClassNames
  1625. parameters
  1626. StyleSheetId styleSheetId
  1627. returns
  1628. # Class name list.
  1629. array of string classNames
  1630. # Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
  1631. command createStyleSheet
  1632. parameters
  1633. # Identifier of the frame where "via-inspector" stylesheet should be created.
  1634. Page.FrameId frameId
  1635. returns
  1636. # Identifier of the created "via-inspector" stylesheet.
  1637. StyleSheetId styleSheetId
  1638. # Disables the CSS agent for the given page.
  1639. command disable
  1640. # Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
  1641. # enabled until the result of this command is received.
  1642. command enable
  1643. # Ensures that the given node will have specified pseudo-classes whenever its style is computed by
  1644. # the browser.
  1645. command forcePseudoState
  1646. parameters
  1647. # The element id for which to force the pseudo state.
  1648. DOM.NodeId nodeId
  1649. # Element pseudo classes to force when computing the element's style.
  1650. array of string forcedPseudoClasses
  1651. command getBackgroundColors
  1652. parameters
  1653. # Id of the node to get background colors for.
  1654. DOM.NodeId nodeId
  1655. returns
  1656. # The range of background colors behind this element, if it contains any visible text. If no
  1657. # visible text is present, this will be undefined. In the case of a flat background color,
  1658. # this will consist of simply that color. In the case of a gradient, this will consist of each
  1659. # of the color stops. For anything more complicated, this will be an empty array. Images will
  1660. # be ignored (as if the image had failed to load).
  1661. optional array of string backgroundColors
  1662. # The computed font size for this node, as a CSS computed value string (e.g. '12px').
  1663. optional string computedFontSize
  1664. # The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
  1665. # '100').
  1666. optional string computedFontWeight
  1667. # Returns the computed style for a DOM node identified by `nodeId`.
  1668. command getComputedStyleForNode
  1669. parameters
  1670. DOM.NodeId nodeId
  1671. returns
  1672. # Computed style for the specified DOM node.
  1673. array of CSSComputedStyleProperty computedStyle
  1674. # Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
  1675. # attributes) for a DOM node identified by `nodeId`.
  1676. command getInlineStylesForNode
  1677. parameters
  1678. DOM.NodeId nodeId
  1679. returns
  1680. # Inline style for the specified DOM node.
  1681. optional CSSStyle inlineStyle
  1682. # Attribute-defined element style (e.g. resulting from "width=20 height=100%").
  1683. optional CSSStyle attributesStyle
  1684. # Returns requested styles for a DOM node identified by `nodeId`.
  1685. command getMatchedStylesForNode
  1686. parameters
  1687. DOM.NodeId nodeId
  1688. returns
  1689. # Inline style for the specified DOM node.
  1690. optional CSSStyle inlineStyle
  1691. # Attribute-defined element style (e.g. resulting from "width=20 height=100%").
  1692. optional CSSStyle attributesStyle
  1693. # CSS rules matching this node, from all applicable stylesheets.
  1694. optional array of RuleMatch matchedCSSRules
  1695. # Pseudo style matches for this node.
  1696. optional array of PseudoElementMatches pseudoElements
  1697. # A chain of inherited styles (from the immediate node parent up to the DOM tree root).
  1698. optional array of InheritedStyleEntry inherited
  1699. # A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).
  1700. optional array of InheritedPseudoElementMatches inheritedPseudoElements
  1701. # A list of CSS keyframed animations matching this node.
  1702. optional array of CSSKeyframesRule cssKeyframesRules
  1703. # A list of CSS position fallbacks matching this node.
  1704. optional array of CSSPositionFallbackRule cssPositionFallbackRules
  1705. # Id of the first parent element that does not have display: contents.
  1706. experimental optional DOM.NodeId parentLayoutNodeId
  1707. # Returns all media queries parsed by the rendering engine.
  1708. command getMediaQueries
  1709. returns
  1710. array of CSSMedia medias
  1711. # Requests information about platform fonts which we used to render child TextNodes in the given
  1712. # node.
  1713. command getPlatformFontsForNode
  1714. parameters
  1715. DOM.NodeId nodeId
  1716. returns
  1717. # Usage statistics for every employed platform font.
  1718. array of PlatformFontUsage fonts
  1719. # Returns the current textual content for a stylesheet.
  1720. command getStyleSheetText
  1721. parameters
  1722. StyleSheetId styleSheetId
  1723. returns
  1724. # The stylesheet text.
  1725. string text
  1726. # Returns all layers parsed by the rendering engine for the tree scope of a node.
  1727. # Given a DOM element identified by nodeId, getLayersForNode returns the root
  1728. # layer for the nearest ancestor document or shadow root. The layer root contains
  1729. # the full layer tree for the tree scope and their ordering.
  1730. experimental command getLayersForNode
  1731. parameters
  1732. DOM.NodeId nodeId
  1733. returns
  1734. CSSLayerData rootLayer
  1735. # Starts tracking the given computed styles for updates. The specified array of properties
  1736. # replaces the one previously specified. Pass empty array to disable tracking.
  1737. # Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
  1738. # The changes to computed style properties are only tracked for nodes pushed to the front-end
  1739. # by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
  1740. # to the front-end, no updates will be issued for the node.
  1741. experimental command trackComputedStyleUpdates
  1742. parameters
  1743. array of CSSComputedStyleProperty propertiesToTrack
  1744. # Polls the next batch of computed style updates.
  1745. experimental command takeComputedStyleUpdates
  1746. returns
  1747. # The list of node Ids that have their tracked computed styles updated.
  1748. array of DOM.NodeId nodeIds
  1749. # Find a rule with the given active property for the given node and set the new value for this
  1750. # property
  1751. command setEffectivePropertyValueForNode
  1752. parameters
  1753. # The element id for which to set property.
  1754. DOM.NodeId nodeId
  1755. string propertyName
  1756. string value
  1757. # Modifies the keyframe rule key text.
  1758. command setKeyframeKey
  1759. parameters
  1760. StyleSheetId styleSheetId
  1761. SourceRange range
  1762. string keyText
  1763. returns
  1764. # The resulting key text after modification.
  1765. Value keyText
  1766. # Modifies the rule selector.
  1767. command setMediaText
  1768. parameters
  1769. StyleSheetId styleSheetId
  1770. SourceRange range
  1771. string text
  1772. returns
  1773. # The resulting CSS media rule after modification.
  1774. CSSMedia media
  1775. # Modifies the expression of a container query.
  1776. experimental command setContainerQueryText
  1777. parameters
  1778. StyleSheetId styleSheetId
  1779. SourceRange range
  1780. string text
  1781. returns
  1782. # The resulting CSS container query rule after modification.
  1783. CSSContainerQuery containerQuery
  1784. # Modifies the expression of a supports at-rule.
  1785. experimental command setSupportsText
  1786. parameters
  1787. StyleSheetId styleSheetId
  1788. SourceRange range
  1789. string text
  1790. returns
  1791. # The resulting CSS Supports rule after modification.
  1792. CSSSupports supports
  1793. # Modifies the expression of a scope at-rule.
  1794. experimental command setScopeText
  1795. parameters
  1796. StyleSheetId styleSheetId
  1797. SourceRange range
  1798. string text
  1799. returns
  1800. # The resulting CSS Scope rule after modification.
  1801. CSSScope scope
  1802. # Modifies the rule selector.
  1803. command setRuleSelector
  1804. parameters
  1805. StyleSheetId styleSheetId
  1806. SourceRange range
  1807. string selector
  1808. returns
  1809. # The resulting selector list after modification.
  1810. SelectorList selectorList
  1811. # Sets the new stylesheet text.
  1812. command setStyleSheetText
  1813. parameters
  1814. StyleSheetId styleSheetId
  1815. string text
  1816. returns
  1817. # URL of source map associated with script (if any).
  1818. optional string sourceMapURL
  1819. # Applies specified style edits one after another in the given order.
  1820. command setStyleTexts
  1821. parameters
  1822. array of StyleDeclarationEdit edits
  1823. returns
  1824. # The resulting styles after modification.
  1825. array of CSSStyle styles
  1826. # Enables the selector recording.
  1827. command startRuleUsageTracking
  1828. # Stop tracking rule usage and return the list of rules that were used since last call to
  1829. # `takeCoverageDelta` (or since start of coverage instrumentation).
  1830. command stopRuleUsageTracking
  1831. returns
  1832. array of RuleUsage ruleUsage
  1833. # Obtain list of rules that became used since last call to this method (or since start of coverage
  1834. # instrumentation).
  1835. command takeCoverageDelta
  1836. returns
  1837. array of RuleUsage coverage
  1838. # Monotonically increasing time, in seconds.
  1839. number timestamp
  1840. # Enables/disables rendering of local CSS fonts (enabled by default).
  1841. experimental command setLocalFontsEnabled
  1842. parameters
  1843. # Whether rendering of local fonts is enabled.
  1844. boolean enabled
  1845. # Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
  1846. # web font.
  1847. event fontsUpdated
  1848. parameters
  1849. # The web font that has loaded.
  1850. optional FontFace font
  1851. # Fires whenever a MediaQuery result changes (for example, after a browser window has been
  1852. # resized.) The current implementation considers only viewport-dependent media features.
  1853. event mediaQueryResultChanged
  1854. # Fired whenever an active document stylesheet is added.
  1855. event styleSheetAdded
  1856. parameters
  1857. # Added stylesheet metainfo.
  1858. CSSStyleSheetHeader header
  1859. # Fired whenever a stylesheet is changed as a result of the client operation.
  1860. event styleSheetChanged
  1861. parameters
  1862. StyleSheetId styleSheetId
  1863. # Fired whenever an active document stylesheet is removed.
  1864. event styleSheetRemoved
  1865. parameters
  1866. # Identifier of the removed stylesheet.
  1867. StyleSheetId styleSheetId
  1868. experimental domain CacheStorage
  1869. depends on Storage
  1870. # Unique identifier of the Cache object.
  1871. type CacheId extends string
  1872. # type of HTTP response cached
  1873. type CachedResponseType extends string
  1874. enum
  1875. basic
  1876. cors
  1877. default
  1878. error
  1879. opaqueResponse
  1880. opaqueRedirect
  1881. # Data entry.
  1882. type DataEntry extends object
  1883. properties
  1884. # Request URL.
  1885. string requestURL
  1886. # Request method.
  1887. string requestMethod
  1888. # Request headers
  1889. array of Header requestHeaders
  1890. # Number of seconds since epoch.
  1891. number responseTime
  1892. # HTTP response status code.
  1893. integer responseStatus
  1894. # HTTP response status text.
  1895. string responseStatusText
  1896. # HTTP response type
  1897. CachedResponseType responseType
  1898. # Response headers
  1899. array of Header responseHeaders
  1900. # Cache identifier.
  1901. type Cache extends object
  1902. properties
  1903. # An opaque unique id of the cache.
  1904. CacheId cacheId
  1905. # Security origin of the cache.
  1906. string securityOrigin
  1907. # Storage key of the cache.
  1908. string storageKey
  1909. # Storage bucket of the cache.
  1910. optional Storage.StorageBucket storageBucket
  1911. # The name of the cache.
  1912. string cacheName
  1913. type Header extends object
  1914. properties
  1915. string name
  1916. string value
  1917. # Cached response
  1918. type CachedResponse extends object
  1919. properties
  1920. # Entry content, base64-encoded.
  1921. binary body
  1922. # Deletes a cache.
  1923. command deleteCache
  1924. parameters
  1925. # Id of cache for deletion.
  1926. CacheId cacheId
  1927. # Deletes a cache entry.
  1928. command deleteEntry
  1929. parameters
  1930. # Id of cache where the entry will be deleted.
  1931. CacheId cacheId
  1932. # URL spec of the request.
  1933. string request
  1934. # Requests cache names.
  1935. command requestCacheNames
  1936. parameters
  1937. # At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
  1938. # Security origin.
  1939. optional string securityOrigin
  1940. # Storage key.
  1941. optional string storageKey
  1942. # Storage bucket. If not specified, it uses the default bucket.
  1943. optional Storage.StorageBucket storageBucket
  1944. returns
  1945. # Caches for the security origin.
  1946. array of Cache caches
  1947. # Fetches cache entry.
  1948. command requestCachedResponse
  1949. parameters
  1950. # Id of cache that contains the entry.
  1951. CacheId cacheId
  1952. # URL spec of the request.
  1953. string requestURL
  1954. # headers of the request.
  1955. array of Header requestHeaders
  1956. returns
  1957. # Response read from the cache.
  1958. CachedResponse response
  1959. # Requests data from cache.
  1960. command requestEntries
  1961. parameters
  1962. # ID of cache to get entries from.
  1963. CacheId cacheId
  1964. # Number of records to skip.
  1965. optional integer skipCount
  1966. # Number of records to fetch.
  1967. optional integer pageSize
  1968. # If present, only return the entries containing this substring in the path
  1969. optional string pathFilter
  1970. returns
  1971. # Array of object store data entries.
  1972. array of DataEntry cacheDataEntries
  1973. # Count of returned entries from this storage. If pathFilter is empty, it
  1974. # is the count of all entries from this storage.
  1975. number returnCount
  1976. # A domain for interacting with Cast, Presentation API, and Remote Playback API
  1977. # functionalities.
  1978. experimental domain Cast
  1979. type Sink extends object
  1980. properties
  1981. string name
  1982. string id
  1983. # Text describing the current session. Present only if there is an active
  1984. # session on the sink.
  1985. optional string session
  1986. # Starts observing for sinks that can be used for tab mirroring, and if set,
  1987. # sinks compatible with |presentationUrl| as well. When sinks are found, a
  1988. # |sinksUpdated| event is fired.
  1989. # Also starts observing for issue messages. When an issue is added or removed,
  1990. # an |issueUpdated| event is fired.
  1991. command enable
  1992. parameters
  1993. optional string presentationUrl
  1994. # Stops observing for sinks and issues.
  1995. command disable
  1996. # Sets a sink to be used when the web page requests the browser to choose a
  1997. # sink via Presentation API, Remote Playback API, or Cast SDK.
  1998. command setSinkToUse
  1999. parameters
  2000. string sinkName
  2001. # Starts mirroring the desktop to the sink.
  2002. command startDesktopMirroring
  2003. parameters
  2004. string sinkName
  2005. # Starts mirroring the tab to the sink.
  2006. command startTabMirroring
  2007. parameters
  2008. string sinkName
  2009. # Stops the active Cast session on the sink.
  2010. command stopCasting
  2011. parameters
  2012. string sinkName
  2013. # This is fired whenever the list of available sinks changes. A sink is a
  2014. # device or a software surface that you can cast to.
  2015. event sinksUpdated
  2016. parameters
  2017. array of Sink sinks
  2018. # This is fired whenever the outstanding issue/error message changes.
  2019. # |issueMessage| is empty if there is no issue.
  2020. event issueUpdated
  2021. parameters
  2022. string issueMessage
  2023. # This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
  2024. # that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
  2025. # the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
  2026. # nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
  2027. # and never sends the same node twice. It is client's responsibility to collect information about
  2028. # the nodes that were sent to the client.<p>Note that `iframe` owner elements will return
  2029. # corresponding document elements as their child nodes.</p>
  2030. domain DOM
  2031. depends on Runtime
  2032. # Unique DOM node identifier.
  2033. type NodeId extends integer
  2034. # Unique DOM node identifier used to reference a node that may not have been pushed to the
  2035. # front-end.
  2036. type BackendNodeId extends integer
  2037. # Backend node with a friendly name.
  2038. type BackendNode extends object
  2039. properties
  2040. # `Node`'s nodeType.
  2041. integer nodeType
  2042. # `Node`'s nodeName.
  2043. string nodeName
  2044. BackendNodeId backendNodeId
  2045. # Pseudo element type.
  2046. type PseudoType extends string
  2047. enum
  2048. first-line
  2049. first-letter
  2050. before
  2051. after
  2052. marker
  2053. backdrop
  2054. selection
  2055. target-text
  2056. spelling-error
  2057. grammar-error
  2058. highlight
  2059. first-line-inherited
  2060. scrollbar
  2061. scrollbar-thumb
  2062. scrollbar-button
  2063. scrollbar-track
  2064. scrollbar-track-piece
  2065. scrollbar-corner
  2066. resizer
  2067. input-list-button
  2068. view-transition
  2069. view-transition-group
  2070. view-transition-image-pair
  2071. view-transition-old
  2072. view-transition-new
  2073. # Shadow root type.
  2074. type ShadowRootType extends string
  2075. enum
  2076. user-agent
  2077. open
  2078. closed
  2079. # Document compatibility mode.
  2080. type CompatibilityMode extends string
  2081. enum
  2082. QuirksMode
  2083. LimitedQuirksMode
  2084. NoQuirksMode
  2085. # ContainerSelector physical axes
  2086. type PhysicalAxes extends string
  2087. enum
  2088. Horizontal
  2089. Vertical
  2090. Both
  2091. # ContainerSelector logical axes
  2092. type LogicalAxes extends string
  2093. enum
  2094. Inline
  2095. Block
  2096. Both
  2097. # DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
  2098. # DOMNode is a base node mirror type.
  2099. type Node extends object
  2100. properties
  2101. # Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
  2102. # will only push node with given `id` once. It is aware of all requested nodes and will only
  2103. # fire DOM events for nodes known to the client.
  2104. NodeId nodeId
  2105. # The id of the parent node if any.
  2106. optional NodeId parentId
  2107. # The BackendNodeId for this node.
  2108. BackendNodeId backendNodeId
  2109. # `Node`'s nodeType.
  2110. integer nodeType
  2111. # `Node`'s nodeName.
  2112. string nodeName
  2113. # `Node`'s localName.
  2114. string localName
  2115. # `Node`'s nodeValue.
  2116. string nodeValue
  2117. # Child count for `Container` nodes.
  2118. optional integer childNodeCount
  2119. # Child nodes of this node when requested with children.
  2120. optional array of Node children
  2121. # Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
  2122. optional array of string attributes
  2123. # Document URL that `Document` or `FrameOwner` node points to.
  2124. optional string documentURL
  2125. # Base URL that `Document` or `FrameOwner` node uses for URL completion.
  2126. optional string baseURL
  2127. # `DocumentType`'s publicId.
  2128. optional string publicId
  2129. # `DocumentType`'s systemId.
  2130. optional string systemId
  2131. # `DocumentType`'s internalSubset.
  2132. optional string internalSubset
  2133. # `Document`'s XML version in case of XML documents.
  2134. optional string xmlVersion
  2135. # `Attr`'s name.
  2136. optional string name
  2137. # `Attr`'s value.
  2138. optional string value
  2139. # Pseudo element type for this node.
  2140. optional PseudoType pseudoType
  2141. # Pseudo element identifier for this node. Only present if there is a
  2142. # valid pseudoType.
  2143. optional string pseudoIdentifier
  2144. # Shadow root type.
  2145. optional ShadowRootType shadowRootType
  2146. # Frame ID for frame owner elements.
  2147. optional Page.FrameId frameId
  2148. # Content document for frame owner elements.
  2149. optional Node contentDocument
  2150. # Shadow root list for given element host.
  2151. optional array of Node shadowRoots
  2152. # Content document fragment for template elements.
  2153. optional Node templateContent
  2154. # Pseudo elements associated with this node.
  2155. optional array of Node pseudoElements
  2156. # Deprecated, as the HTML Imports API has been removed (crbug.com/937746).
  2157. # This property used to return the imported document for the HTMLImport links.
  2158. # The property is always undefined now.
  2159. deprecated optional Node importedDocument
  2160. # Distributed nodes for given insertion point.
  2161. optional array of BackendNode distributedNodes
  2162. # Whether the node is SVG.
  2163. optional boolean isSVG
  2164. optional CompatibilityMode compatibilityMode
  2165. optional BackendNode assignedSlot
  2166. # A structure holding an RGBA color.
  2167. type RGBA extends object
  2168. properties
  2169. # The red component, in the [0-255] range.
  2170. integer r
  2171. # The green component, in the [0-255] range.
  2172. integer g
  2173. # The blue component, in the [0-255] range.
  2174. integer b
  2175. # The alpha component, in the [0-1] range (default: 1).
  2176. optional number a
  2177. # An array of quad vertices, x immediately followed by y for each point, points clock-wise.
  2178. type Quad extends array of number
  2179. # Box model.
  2180. type BoxModel extends object
  2181. properties
  2182. # Content box
  2183. Quad content
  2184. # Padding box
  2185. Quad padding
  2186. # Border box
  2187. Quad border
  2188. # Margin box
  2189. Quad margin
  2190. # Node width
  2191. integer width
  2192. # Node height
  2193. integer height
  2194. # Shape outside coordinates
  2195. optional ShapeOutsideInfo shapeOutside
  2196. # CSS Shape Outside details.
  2197. type ShapeOutsideInfo extends object
  2198. properties
  2199. # Shape bounds
  2200. Quad bounds
  2201. # Shape coordinate details
  2202. array of any shape
  2203. # Margin shape bounds
  2204. array of any marginShape
  2205. # Rectangle.
  2206. type Rect extends object
  2207. properties
  2208. # X coordinate
  2209. number x
  2210. # Y coordinate
  2211. number y
  2212. # Rectangle width
  2213. number width
  2214. # Rectangle height
  2215. number height
  2216. type CSSComputedStyleProperty extends object
  2217. properties
  2218. # Computed style property name.
  2219. string name
  2220. # Computed style property value.
  2221. string value
  2222. # Collects class names for the node with given id and all of it's child nodes.
  2223. experimental command collectClassNamesFromSubtree
  2224. parameters
  2225. # Id of the node to collect class names.
  2226. NodeId nodeId
  2227. returns
  2228. # Class name list.
  2229. array of string classNames
  2230. # Creates a deep copy of the specified node and places it into the target container before the
  2231. # given anchor.
  2232. experimental command copyTo
  2233. parameters
  2234. # Id of the node to copy.
  2235. NodeId nodeId
  2236. # Id of the element to drop the copy into.
  2237. NodeId targetNodeId
  2238. # Drop the copy before this node (if absent, the copy becomes the last child of
  2239. # `targetNodeId`).
  2240. optional NodeId insertBeforeNodeId
  2241. returns
  2242. # Id of the node clone.
  2243. NodeId nodeId
  2244. # Describes node given its id, does not require domain to be enabled. Does not start tracking any
  2245. # objects, can be used for automation.
  2246. command describeNode
  2247. parameters
  2248. # Identifier of the node.
  2249. optional NodeId nodeId
  2250. # Identifier of the backend node.
  2251. optional BackendNodeId backendNodeId
  2252. # JavaScript object id of the node wrapper.
  2253. optional Runtime.RemoteObjectId objectId
  2254. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  2255. # entire subtree or provide an integer larger than 0.
  2256. optional integer depth
  2257. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  2258. # (default is false).
  2259. optional boolean pierce
  2260. returns
  2261. # Node description.
  2262. Node node
  2263. # Scrolls the specified rect of the given node into view if not already visible.
  2264. # Note: exactly one between nodeId, backendNodeId and objectId should be passed
  2265. # to identify the node.
  2266. experimental command scrollIntoViewIfNeeded
  2267. parameters
  2268. # Identifier of the node.
  2269. optional NodeId nodeId
  2270. # Identifier of the backend node.
  2271. optional BackendNodeId backendNodeId
  2272. # JavaScript object id of the node wrapper.
  2273. optional Runtime.RemoteObjectId objectId
  2274. # The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
  2275. # When omitted, center of the node will be used, similar to Element.scrollIntoView.
  2276. optional Rect rect
  2277. # Disables DOM agent for the given page.
  2278. command disable
  2279. # Discards search results from the session with the given id. `getSearchResults` should no longer
  2280. # be called for that search.
  2281. experimental command discardSearchResults
  2282. parameters
  2283. # Unique search session identifier.
  2284. string searchId
  2285. # Enables DOM agent for the given page.
  2286. command enable
  2287. parameters
  2288. # Whether to include whitespaces in the children array of returned Nodes.
  2289. experimental optional enum includeWhitespace
  2290. # Strip whitespaces from child arrays (default).
  2291. none
  2292. # Return all children including block-level whitespace nodes.
  2293. all
  2294. # Focuses the given element.
  2295. command focus
  2296. parameters
  2297. # Identifier of the node.
  2298. optional NodeId nodeId
  2299. # Identifier of the backend node.
  2300. optional BackendNodeId backendNodeId
  2301. # JavaScript object id of the node wrapper.
  2302. optional Runtime.RemoteObjectId objectId
  2303. # Returns attributes for the specified node.
  2304. command getAttributes
  2305. parameters
  2306. # Id of the node to retrieve attibutes for.
  2307. NodeId nodeId
  2308. returns
  2309. # An interleaved array of node attribute names and values.
  2310. array of string attributes
  2311. # Returns boxes for the given node.
  2312. command getBoxModel
  2313. parameters
  2314. # Identifier of the node.
  2315. optional NodeId nodeId
  2316. # Identifier of the backend node.
  2317. optional BackendNodeId backendNodeId
  2318. # JavaScript object id of the node wrapper.
  2319. optional Runtime.RemoteObjectId objectId
  2320. returns
  2321. # Box model for the node.
  2322. BoxModel model
  2323. # Returns quads that describe node position on the page. This method
  2324. # might return multiple quads for inline nodes.
  2325. experimental command getContentQuads
  2326. parameters
  2327. # Identifier of the node.
  2328. optional NodeId nodeId
  2329. # Identifier of the backend node.
  2330. optional BackendNodeId backendNodeId
  2331. # JavaScript object id of the node wrapper.
  2332. optional Runtime.RemoteObjectId objectId
  2333. returns
  2334. # Quads that describe node layout relative to viewport.
  2335. array of Quad quads
  2336. # Returns the root DOM node (and optionally the subtree) to the caller.
  2337. # Implicitly enables the DOM domain events for the current target.
  2338. command getDocument
  2339. parameters
  2340. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  2341. # entire subtree or provide an integer larger than 0.
  2342. optional integer depth
  2343. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  2344. # (default is false).
  2345. optional boolean pierce
  2346. returns
  2347. # Resulting node.
  2348. Node root
  2349. # Returns the root DOM node (and optionally the subtree) to the caller.
  2350. # Deprecated, as it is not designed to work well with the rest of the DOM agent.
  2351. # Use DOMSnapshot.captureSnapshot instead.
  2352. deprecated command getFlattenedDocument
  2353. parameters
  2354. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  2355. # entire subtree or provide an integer larger than 0.
  2356. optional integer depth
  2357. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  2358. # (default is false).
  2359. optional boolean pierce
  2360. returns
  2361. # Resulting node.
  2362. array of Node nodes
  2363. # Finds nodes with a given computed style in a subtree.
  2364. experimental command getNodesForSubtreeByStyle
  2365. parameters
  2366. # Node ID pointing to the root of a subtree.
  2367. NodeId nodeId
  2368. # The style to filter nodes by (includes nodes if any of properties matches).
  2369. array of CSSComputedStyleProperty computedStyles
  2370. # Whether or not iframes and shadow roots in the same target should be traversed when returning the
  2371. # results (default is false).
  2372. optional boolean pierce
  2373. returns
  2374. # Resulting nodes.
  2375. array of NodeId nodeIds
  2376. # Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
  2377. # either returned or not.
  2378. command getNodeForLocation
  2379. parameters
  2380. # X coordinate.
  2381. integer x
  2382. # Y coordinate.
  2383. integer y
  2384. # False to skip to the nearest non-UA shadow root ancestor (default: false).
  2385. optional boolean includeUserAgentShadowDOM
  2386. # Whether to ignore pointer-events: none on elements and hit test them.
  2387. optional boolean ignorePointerEventsNone
  2388. returns
  2389. # Resulting node.
  2390. BackendNodeId backendNodeId
  2391. # Frame this node belongs to.
  2392. Page.FrameId frameId
  2393. # Id of the node at given coordinates, only when enabled and requested document.
  2394. optional NodeId nodeId
  2395. # Returns node's HTML markup.
  2396. command getOuterHTML
  2397. parameters
  2398. # Identifier of the node.
  2399. optional NodeId nodeId
  2400. # Identifier of the backend node.
  2401. optional BackendNodeId backendNodeId
  2402. # JavaScript object id of the node wrapper.
  2403. optional Runtime.RemoteObjectId objectId
  2404. returns
  2405. # Outer HTML markup.
  2406. string outerHTML
  2407. # Returns the id of the nearest ancestor that is a relayout boundary.
  2408. experimental command getRelayoutBoundary
  2409. parameters
  2410. # Id of the node.
  2411. NodeId nodeId
  2412. returns
  2413. # Relayout boundary node id for the given node.
  2414. NodeId nodeId
  2415. # Returns search results from given `fromIndex` to given `toIndex` from the search with the given
  2416. # identifier.
  2417. experimental command getSearchResults
  2418. parameters
  2419. # Unique search session identifier.
  2420. string searchId
  2421. # Start index of the search result to be returned.
  2422. integer fromIndex
  2423. # End index of the search result to be returned.
  2424. integer toIndex
  2425. returns
  2426. # Ids of the search result nodes.
  2427. array of NodeId nodeIds
  2428. # Hides any highlight.
  2429. command hideHighlight
  2430. # Use 'Overlay.hideHighlight' instead
  2431. redirect Overlay
  2432. # Highlights DOM node.
  2433. command highlightNode
  2434. # Use 'Overlay.highlightNode' instead
  2435. redirect Overlay
  2436. # Highlights given rectangle.
  2437. command highlightRect
  2438. # Use 'Overlay.highlightRect' instead
  2439. redirect Overlay
  2440. # Marks last undoable state.
  2441. experimental command markUndoableState
  2442. # Moves node into the new container, places it before the given anchor.
  2443. command moveTo
  2444. parameters
  2445. # Id of the node to move.
  2446. NodeId nodeId
  2447. # Id of the element to drop the moved node into.
  2448. NodeId targetNodeId
  2449. # Drop node before this one (if absent, the moved node becomes the last child of
  2450. # `targetNodeId`).
  2451. optional NodeId insertBeforeNodeId
  2452. returns
  2453. # New id of the moved node.
  2454. NodeId nodeId
  2455. # Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
  2456. # `cancelSearch` to end this search session.
  2457. experimental command performSearch
  2458. parameters
  2459. # Plain text or query selector or XPath search query.
  2460. string query
  2461. # True to search in user agent shadow DOM.
  2462. optional boolean includeUserAgentShadowDOM
  2463. returns
  2464. # Unique search session identifier.
  2465. string searchId
  2466. # Number of search results.
  2467. integer resultCount
  2468. # Requests that the node is sent to the caller given its path. // FIXME, use XPath
  2469. experimental command pushNodeByPathToFrontend
  2470. parameters
  2471. # Path to node in the proprietary format.
  2472. string path
  2473. returns
  2474. # Id of the node for given path.
  2475. NodeId nodeId
  2476. # Requests that a batch of nodes is sent to the caller given their backend node ids.
  2477. experimental command pushNodesByBackendIdsToFrontend
  2478. parameters
  2479. # The array of backend node ids.
  2480. array of BackendNodeId backendNodeIds
  2481. returns
  2482. # The array of ids of pushed nodes that correspond to the backend ids specified in
  2483. # backendNodeIds.
  2484. array of NodeId nodeIds
  2485. # Executes `querySelector` on a given node.
  2486. command querySelector
  2487. parameters
  2488. # Id of the node to query upon.
  2489. NodeId nodeId
  2490. # Selector string.
  2491. string selector
  2492. returns
  2493. # Query selector result.
  2494. NodeId nodeId
  2495. # Executes `querySelectorAll` on a given node.
  2496. command querySelectorAll
  2497. parameters
  2498. # Id of the node to query upon.
  2499. NodeId nodeId
  2500. # Selector string.
  2501. string selector
  2502. returns
  2503. # Query selector result.
  2504. array of NodeId nodeIds
  2505. # Returns NodeIds of current top layer elements.
  2506. # Top layer is rendered closest to the user within a viewport, therefore its elements always
  2507. # appear on top of all other content.
  2508. experimental command getTopLayerElements
  2509. returns
  2510. # NodeIds of top layer elements
  2511. array of NodeId nodeIds
  2512. # Re-does the last undone action.
  2513. experimental command redo
  2514. # Removes attribute with given name from an element with given id.
  2515. command removeAttribute
  2516. parameters
  2517. # Id of the element to remove attribute from.
  2518. NodeId nodeId
  2519. # Name of the attribute to remove.
  2520. string name
  2521. # Removes node with given id.
  2522. command removeNode
  2523. parameters
  2524. # Id of the node to remove.
  2525. NodeId nodeId
  2526. # Requests that children of the node with given id are returned to the caller in form of
  2527. # `setChildNodes` events where not only immediate children are retrieved, but all children down to
  2528. # the specified depth.
  2529. command requestChildNodes
  2530. parameters
  2531. # Id of the node to get children for.
  2532. NodeId nodeId
  2533. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  2534. # entire subtree or provide an integer larger than 0.
  2535. optional integer depth
  2536. # Whether or not iframes and shadow roots should be traversed when returning the sub-tree
  2537. # (default is false).
  2538. optional boolean pierce
  2539. # Requests that the node is sent to the caller given the JavaScript node object reference. All
  2540. # nodes that form the path from the node to the root are also sent to the client as a series of
  2541. # `setChildNodes` notifications.
  2542. command requestNode
  2543. parameters
  2544. # JavaScript object id to convert into node.
  2545. Runtime.RemoteObjectId objectId
  2546. returns
  2547. # Node id for given object.
  2548. NodeId nodeId
  2549. # Resolves the JavaScript node object for a given NodeId or BackendNodeId.
  2550. command resolveNode
  2551. parameters
  2552. # Id of the node to resolve.
  2553. optional NodeId nodeId
  2554. # Backend identifier of the node to resolve.
  2555. optional DOM.BackendNodeId backendNodeId
  2556. # Symbolic group name that can be used to release multiple objects.
  2557. optional string objectGroup
  2558. # Execution context in which to resolve the node.
  2559. optional Runtime.ExecutionContextId executionContextId
  2560. returns
  2561. # JavaScript object wrapper for given node.
  2562. Runtime.RemoteObject object
  2563. # Sets attribute for an element with given id.
  2564. command setAttributeValue
  2565. parameters
  2566. # Id of the element to set attribute for.
  2567. NodeId nodeId
  2568. # Attribute name.
  2569. string name
  2570. # Attribute value.
  2571. string value
  2572. # Sets attributes on element with given id. This method is useful when user edits some existing
  2573. # attribute value and types in several attribute name/value pairs.
  2574. command setAttributesAsText
  2575. parameters
  2576. # Id of the element to set attributes for.
  2577. NodeId nodeId
  2578. # Text with a number of attributes. Will parse this text using HTML parser.
  2579. string text
  2580. # Attribute name to replace with new attributes derived from text in case text parsed
  2581. # successfully.
  2582. optional string name
  2583. # Sets files for the given file input element.
  2584. command setFileInputFiles
  2585. parameters
  2586. # Array of file paths to set.
  2587. array of string files
  2588. # Identifier of the node.
  2589. optional NodeId nodeId
  2590. # Identifier of the backend node.
  2591. optional BackendNodeId backendNodeId
  2592. # JavaScript object id of the node wrapper.
  2593. optional Runtime.RemoteObjectId objectId
  2594. # Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
  2595. experimental command setNodeStackTracesEnabled
  2596. parameters
  2597. # Enable or disable.
  2598. boolean enable
  2599. # Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
  2600. experimental command getNodeStackTraces
  2601. parameters
  2602. # Id of the node to get stack traces for.
  2603. NodeId nodeId
  2604. returns
  2605. # Creation stack trace, if available.
  2606. optional Runtime.StackTrace creation
  2607. # Returns file information for the given
  2608. # File wrapper.
  2609. experimental command getFileInfo
  2610. parameters
  2611. # JavaScript object id of the node wrapper.
  2612. Runtime.RemoteObjectId objectId
  2613. returns
  2614. string path
  2615. # Enables console to refer to the node with given id via $x (see Command Line API for more details
  2616. # $x functions).
  2617. experimental command setInspectedNode
  2618. parameters
  2619. # DOM node id to be accessible by means of $x command line API.
  2620. NodeId nodeId
  2621. # Sets node name for a node with given id.
  2622. command setNodeName
  2623. parameters
  2624. # Id of the node to set name for.
  2625. NodeId nodeId
  2626. # New node's name.
  2627. string name
  2628. returns
  2629. # New node's id.
  2630. NodeId nodeId
  2631. # Sets node value for a node with given id.
  2632. command setNodeValue
  2633. parameters
  2634. # Id of the node to set value for.
  2635. NodeId nodeId
  2636. # New node's value.
  2637. string value
  2638. # Sets node HTML markup, returns new node id.
  2639. command setOuterHTML
  2640. parameters
  2641. # Id of the node to set markup for.
  2642. NodeId nodeId
  2643. # Outer HTML markup to set.
  2644. string outerHTML
  2645. # Undoes the last performed action.
  2646. experimental command undo
  2647. # Returns iframe node that owns iframe with the given domain.
  2648. experimental command getFrameOwner
  2649. parameters
  2650. Page.FrameId frameId
  2651. returns
  2652. # Resulting node.
  2653. BackendNodeId backendNodeId
  2654. # Id of the node at given coordinates, only when enabled and requested document.
  2655. optional NodeId nodeId
  2656. # Returns the query container of the given node based on container query
  2657. # conditions: containerName, physical, and logical axes. If no axes are
  2658. # provided, the style container is returned, which is the direct parent or the
  2659. # closest element with a matching container-name.
  2660. experimental command getContainerForNode
  2661. parameters
  2662. NodeId nodeId
  2663. optional string containerName
  2664. optional PhysicalAxes physicalAxes
  2665. optional LogicalAxes logicalAxes
  2666. returns
  2667. # The container node for the given node, or null if not found.
  2668. optional NodeId nodeId
  2669. # Returns the descendants of a container query container that have
  2670. # container queries against this container.
  2671. experimental command getQueryingDescendantsForContainer
  2672. parameters
  2673. # Id of the container node to find querying descendants from.
  2674. NodeId nodeId
  2675. returns
  2676. # Descendant nodes with container queries against the given container.
  2677. array of NodeId nodeIds
  2678. # Fired when `Element`'s attribute is modified.
  2679. event attributeModified
  2680. parameters
  2681. # Id of the node that has changed.
  2682. NodeId nodeId
  2683. # Attribute name.
  2684. string name
  2685. # Attribute value.
  2686. string value
  2687. # Fired when `Element`'s attribute is removed.
  2688. event attributeRemoved
  2689. parameters
  2690. # Id of the node that has changed.
  2691. NodeId nodeId
  2692. # A ttribute name.
  2693. string name
  2694. # Mirrors `DOMCharacterDataModified` event.
  2695. event characterDataModified
  2696. parameters
  2697. # Id of the node that has changed.
  2698. NodeId nodeId
  2699. # New text value.
  2700. string characterData
  2701. # Fired when `Container`'s child node count has changed.
  2702. event childNodeCountUpdated
  2703. parameters
  2704. # Id of the node that has changed.
  2705. NodeId nodeId
  2706. # New node count.
  2707. integer childNodeCount
  2708. # Mirrors `DOMNodeInserted` event.
  2709. event childNodeInserted
  2710. parameters
  2711. # Id of the node that has changed.
  2712. NodeId parentNodeId
  2713. # Id of the previous sibling.
  2714. NodeId previousNodeId
  2715. # Inserted node data.
  2716. Node node
  2717. # Mirrors `DOMNodeRemoved` event.
  2718. event childNodeRemoved
  2719. parameters
  2720. # Parent id.
  2721. NodeId parentNodeId
  2722. # Id of the node that has been removed.
  2723. NodeId nodeId
  2724. # Called when distribution is changed.
  2725. experimental event distributedNodesUpdated
  2726. parameters
  2727. # Insertion point where distributed nodes were updated.
  2728. NodeId insertionPointId
  2729. # Distributed nodes for given insertion point.
  2730. array of BackendNode distributedNodes
  2731. # Fired when `Document` has been totally updated. Node ids are no longer valid.
  2732. event documentUpdated
  2733. # Fired when `Element`'s inline style is modified via a CSS property modification.
  2734. experimental event inlineStyleInvalidated
  2735. parameters
  2736. # Ids of the nodes for which the inline styles have been invalidated.
  2737. array of NodeId nodeIds
  2738. # Called when a pseudo element is added to an element.
  2739. experimental event pseudoElementAdded
  2740. parameters
  2741. # Pseudo element's parent element id.
  2742. NodeId parentId
  2743. # The added pseudo element.
  2744. Node pseudoElement
  2745. # Called when top layer elements are changed.
  2746. experimental event topLayerElementsUpdated
  2747. # Called when a pseudo element is removed from an element.
  2748. experimental event pseudoElementRemoved
  2749. parameters
  2750. # Pseudo element's parent element id.
  2751. NodeId parentId
  2752. # The removed pseudo element id.
  2753. NodeId pseudoElementId
  2754. # Fired when backend wants to provide client with the missing DOM structure. This happens upon
  2755. # most of the calls requesting node ids.
  2756. event setChildNodes
  2757. parameters
  2758. # Parent node id to populate with children.
  2759. NodeId parentId
  2760. # Child nodes array.
  2761. array of Node nodes
  2762. # Called when shadow root is popped from the element.
  2763. experimental event shadowRootPopped
  2764. parameters
  2765. # Host element id.
  2766. NodeId hostId
  2767. # Shadow root id.
  2768. NodeId rootId
  2769. # Called when shadow root is pushed into the element.
  2770. experimental event shadowRootPushed
  2771. parameters
  2772. # Host element id.
  2773. NodeId hostId
  2774. # Shadow root.
  2775. Node root
  2776. # DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
  2777. # execution will stop on these operations as if there was a regular breakpoint set.
  2778. domain DOMDebugger
  2779. depends on DOM
  2780. depends on Debugger
  2781. depends on Runtime
  2782. # DOM breakpoint type.
  2783. type DOMBreakpointType extends string
  2784. enum
  2785. subtree-modified
  2786. attribute-modified
  2787. node-removed
  2788. # CSP Violation type.
  2789. experimental type CSPViolationType extends string
  2790. enum
  2791. trustedtype-sink-violation
  2792. trustedtype-policy-violation
  2793. # Object event listener.
  2794. type EventListener extends object
  2795. properties
  2796. # `EventListener`'s type.
  2797. string type
  2798. # `EventListener`'s useCapture.
  2799. boolean useCapture
  2800. # `EventListener`'s passive flag.
  2801. boolean passive
  2802. # `EventListener`'s once flag.
  2803. boolean once
  2804. # Script id of the handler code.
  2805. Runtime.ScriptId scriptId
  2806. # Line number in the script (0-based).
  2807. integer lineNumber
  2808. # Column number in the script (0-based).
  2809. integer columnNumber
  2810. # Event handler function value.
  2811. optional Runtime.RemoteObject handler
  2812. # Event original handler function value.
  2813. optional Runtime.RemoteObject originalHandler
  2814. # Node the listener is added to (if any).
  2815. optional DOM.BackendNodeId backendNodeId
  2816. # Returns event listeners of the given object.
  2817. command getEventListeners
  2818. parameters
  2819. # Identifier of the object to return listeners for.
  2820. Runtime.RemoteObjectId objectId
  2821. # The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
  2822. # entire subtree or provide an integer larger than 0.
  2823. optional integer depth
  2824. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  2825. # (default is false). Reports listeners for all contexts if pierce is enabled.
  2826. optional boolean pierce
  2827. returns
  2828. # Array of relevant listeners.
  2829. array of EventListener listeners
  2830. # Removes DOM breakpoint that was set using `setDOMBreakpoint`.
  2831. command removeDOMBreakpoint
  2832. parameters
  2833. # Identifier of the node to remove breakpoint from.
  2834. DOM.NodeId nodeId
  2835. # Type of the breakpoint to remove.
  2836. DOMBreakpointType type
  2837. # Removes breakpoint on particular DOM event.
  2838. command removeEventListenerBreakpoint
  2839. parameters
  2840. # Event name.
  2841. string eventName
  2842. # EventTarget interface name.
  2843. experimental optional string targetName
  2844. # Removes breakpoint on particular native event.
  2845. experimental command removeInstrumentationBreakpoint
  2846. parameters
  2847. # Instrumentation name to stop on.
  2848. string eventName
  2849. # Removes breakpoint from XMLHttpRequest.
  2850. command removeXHRBreakpoint
  2851. parameters
  2852. # Resource URL substring.
  2853. string url
  2854. # Sets breakpoint on particular CSP violations.
  2855. experimental command setBreakOnCSPViolation
  2856. parameters
  2857. # CSP Violations to stop upon.
  2858. array of CSPViolationType violationTypes
  2859. # Sets breakpoint on particular operation with DOM.
  2860. command setDOMBreakpoint
  2861. parameters
  2862. # Identifier of the node to set breakpoint on.
  2863. DOM.NodeId nodeId
  2864. # Type of the operation to stop upon.
  2865. DOMBreakpointType type
  2866. # Sets breakpoint on particular DOM event.
  2867. command setEventListenerBreakpoint
  2868. parameters
  2869. # DOM Event name to stop on (any DOM event will do).
  2870. string eventName
  2871. # EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
  2872. # EventTarget.
  2873. experimental optional string targetName
  2874. # Sets breakpoint on particular native event.
  2875. experimental command setInstrumentationBreakpoint
  2876. parameters
  2877. # Instrumentation name to stop on.
  2878. string eventName
  2879. # Sets breakpoint on XMLHttpRequest.
  2880. command setXHRBreakpoint
  2881. parameters
  2882. # Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
  2883. string url
  2884. # EventBreakpoints permits setting breakpoints on particular operations and
  2885. # events in targets that run JavaScript but do not have a DOM.
  2886. # JavaScript execution will stop on these operations as if there was a regular
  2887. # breakpoint set.
  2888. experimental domain EventBreakpoints
  2889. # Sets breakpoint on particular native event.
  2890. command setInstrumentationBreakpoint
  2891. parameters
  2892. # Instrumentation name to stop on.
  2893. string eventName
  2894. # Removes breakpoint on particular native event.
  2895. command removeInstrumentationBreakpoint
  2896. parameters
  2897. # Instrumentation name to stop on.
  2898. string eventName
  2899. # This domain facilitates obtaining document snapshots with DOM, layout, and style information.
  2900. experimental domain DOMSnapshot
  2901. depends on CSS
  2902. depends on DOM
  2903. depends on DOMDebugger
  2904. depends on Page
  2905. # A Node in the DOM tree.
  2906. type DOMNode extends object
  2907. properties
  2908. # `Node`'s nodeType.
  2909. integer nodeType
  2910. # `Node`'s nodeName.
  2911. string nodeName
  2912. # `Node`'s nodeValue.
  2913. string nodeValue
  2914. # Only set for textarea elements, contains the text value.
  2915. optional string textValue
  2916. # Only set for input elements, contains the input's associated text value.
  2917. optional string inputValue
  2918. # Only set for radio and checkbox input elements, indicates if the element has been checked
  2919. optional boolean inputChecked
  2920. # Only set for option elements, indicates if the element has been selected
  2921. optional boolean optionSelected
  2922. # `Node`'s id, corresponds to DOM.Node.backendNodeId.
  2923. DOM.BackendNodeId backendNodeId
  2924. # The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
  2925. # any.
  2926. optional array of integer childNodeIndexes
  2927. # Attributes of an `Element` node.
  2928. optional array of NameValue attributes
  2929. # Indexes of pseudo elements associated with this node in the `domNodes` array returned by
  2930. # `getSnapshot`, if any.
  2931. optional array of integer pseudoElementIndexes
  2932. # The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
  2933. # `getSnapshot`, if any.
  2934. optional integer layoutNodeIndex
  2935. # Document URL that `Document` or `FrameOwner` node points to.
  2936. optional string documentURL
  2937. # Base URL that `Document` or `FrameOwner` node uses for URL completion.
  2938. optional string baseURL
  2939. # Only set for documents, contains the document's content language.
  2940. optional string contentLanguage
  2941. # Only set for documents, contains the document's character set encoding.
  2942. optional string documentEncoding
  2943. # `DocumentType` node's publicId.
  2944. optional string publicId
  2945. # `DocumentType` node's systemId.
  2946. optional string systemId
  2947. # Frame ID for frame owner elements and also for the document node.
  2948. optional Page.FrameId frameId
  2949. # The index of a frame owner element's content document in the `domNodes` array returned by
  2950. # `getSnapshot`, if any.
  2951. optional integer contentDocumentIndex
  2952. # Type of a pseudo element node.
  2953. optional DOM.PseudoType pseudoType
  2954. # Shadow root type.
  2955. optional DOM.ShadowRootType shadowRootType
  2956. # Whether this DOM node responds to mouse clicks. This includes nodes that have had click
  2957. # event listeners attached via JavaScript as well as anchor tags that naturally navigate when
  2958. # clicked.
  2959. optional boolean isClickable
  2960. # Details of the node's event listeners, if any.
  2961. optional array of DOMDebugger.EventListener eventListeners
  2962. # The selected url for nodes with a srcset attribute.
  2963. optional string currentSourceURL
  2964. # The url of the script (if any) that generates this node.
  2965. optional string originURL
  2966. # Scroll offsets, set when this node is a Document.
  2967. optional number scrollOffsetX
  2968. optional number scrollOffsetY
  2969. # Details of post layout rendered text positions. The exact layout should not be regarded as
  2970. # stable and may change between versions.
  2971. type InlineTextBox extends object
  2972. properties
  2973. # The bounding box in document coordinates. Note that scroll offset of the document is ignored.
  2974. DOM.Rect boundingBox
  2975. # The starting index in characters, for this post layout textbox substring. Characters that
  2976. # would be represented as a surrogate pair in UTF-16 have length 2.
  2977. integer startCharacterIndex
  2978. # The number of characters in this post layout textbox substring. Characters that would be
  2979. # represented as a surrogate pair in UTF-16 have length 2.
  2980. integer numCharacters
  2981. # Details of an element in the DOM tree with a LayoutObject.
  2982. type LayoutTreeNode extends object
  2983. properties
  2984. # The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
  2985. integer domNodeIndex
  2986. # The bounding box in document coordinates. Note that scroll offset of the document is ignored.
  2987. DOM.Rect boundingBox
  2988. # Contents of the LayoutText, if any.
  2989. optional string layoutText
  2990. # The post-layout inline text nodes, if any.
  2991. optional array of InlineTextBox inlineTextNodes
  2992. # Index into the `computedStyles` array returned by `getSnapshot`.
  2993. optional integer styleIndex
  2994. # Global paint order index, which is determined by the stacking order of the nodes. Nodes
  2995. # that are painted together will have the same index. Only provided if includePaintOrder in
  2996. # getSnapshot was true.
  2997. optional integer paintOrder
  2998. # Set to true to indicate the element begins a new stacking context.
  2999. optional boolean isStackingContext
  3000. # A subset of the full ComputedStyle as defined by the request whitelist.
  3001. type ComputedStyle extends object
  3002. properties
  3003. # Name/value pairs of computed style properties.
  3004. array of NameValue properties
  3005. # A name/value pair.
  3006. type NameValue extends object
  3007. properties
  3008. # Attribute/property name.
  3009. string name
  3010. # Attribute/property value.
  3011. string value
  3012. # Index of the string in the strings table.
  3013. type StringIndex extends integer
  3014. # Index of the string in the strings table.
  3015. type ArrayOfStrings extends array of StringIndex
  3016. # Data that is only present on rare nodes.
  3017. type RareStringData extends object
  3018. properties
  3019. array of integer index
  3020. array of StringIndex value
  3021. type RareBooleanData extends object
  3022. properties
  3023. array of integer index
  3024. type RareIntegerData extends object
  3025. properties
  3026. array of integer index
  3027. array of integer value
  3028. type Rectangle extends array of number
  3029. # Document snapshot.
  3030. type DocumentSnapshot extends object
  3031. properties
  3032. # Document URL that `Document` or `FrameOwner` node points to.
  3033. StringIndex documentURL
  3034. # Document title.
  3035. StringIndex title
  3036. # Base URL that `Document` or `FrameOwner` node uses for URL completion.
  3037. StringIndex baseURL
  3038. # Contains the document's content language.
  3039. StringIndex contentLanguage
  3040. # Contains the document's character set encoding.
  3041. StringIndex encodingName
  3042. # `DocumentType` node's publicId.
  3043. StringIndex publicId
  3044. # `DocumentType` node's systemId.
  3045. StringIndex systemId
  3046. # Frame ID for frame owner elements and also for the document node.
  3047. StringIndex frameId
  3048. # A table with dom nodes.
  3049. NodeTreeSnapshot nodes
  3050. # The nodes in the layout tree.
  3051. LayoutTreeSnapshot layout
  3052. # The post-layout inline text nodes.
  3053. TextBoxSnapshot textBoxes
  3054. # Horizontal scroll offset.
  3055. optional number scrollOffsetX
  3056. # Vertical scroll offset.
  3057. optional number scrollOffsetY
  3058. # Document content width.
  3059. optional number contentWidth
  3060. # Document content height.
  3061. optional number contentHeight
  3062. # Table containing nodes.
  3063. type NodeTreeSnapshot extends object
  3064. properties
  3065. # Parent node index.
  3066. optional array of integer parentIndex
  3067. # `Node`'s nodeType.
  3068. optional array of integer nodeType
  3069. # Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.
  3070. optional RareStringData shadowRootType
  3071. # `Node`'s nodeName.
  3072. optional array of StringIndex nodeName
  3073. # `Node`'s nodeValue.
  3074. optional array of StringIndex nodeValue
  3075. # `Node`'s id, corresponds to DOM.Node.backendNodeId.
  3076. optional array of DOM.BackendNodeId backendNodeId
  3077. # Attributes of an `Element` node. Flatten name, value pairs.
  3078. optional array of ArrayOfStrings attributes
  3079. # Only set for textarea elements, contains the text value.
  3080. optional RareStringData textValue
  3081. # Only set for input elements, contains the input's associated text value.
  3082. optional RareStringData inputValue
  3083. # Only set for radio and checkbox input elements, indicates if the element has been checked
  3084. optional RareBooleanData inputChecked
  3085. # Only set for option elements, indicates if the element has been selected
  3086. optional RareBooleanData optionSelected
  3087. # The index of the document in the list of the snapshot documents.
  3088. optional RareIntegerData contentDocumentIndex
  3089. # Type of a pseudo element node.
  3090. optional RareStringData pseudoType
  3091. # Pseudo element identifier for this node. Only present if there is a
  3092. # valid pseudoType.
  3093. optional RareStringData pseudoIdentifier
  3094. # Whether this DOM node responds to mouse clicks. This includes nodes that have had click
  3095. # event listeners attached via JavaScript as well as anchor tags that naturally navigate when
  3096. # clicked.
  3097. optional RareBooleanData isClickable
  3098. # The selected url for nodes with a srcset attribute.
  3099. optional RareStringData currentSourceURL
  3100. # The url of the script (if any) that generates this node.
  3101. optional RareStringData originURL
  3102. # Table of details of an element in the DOM tree with a LayoutObject.
  3103. type LayoutTreeSnapshot extends object
  3104. properties
  3105. # Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
  3106. array of integer nodeIndex
  3107. # Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
  3108. array of ArrayOfStrings styles
  3109. # The absolute position bounding box.
  3110. array of Rectangle bounds
  3111. # Contents of the LayoutText, if any.
  3112. array of StringIndex text
  3113. # Stacking context information.
  3114. RareBooleanData stackingContexts
  3115. # Global paint order index, which is determined by the stacking order of the nodes. Nodes
  3116. # that are painted together will have the same index. Only provided if includePaintOrder in
  3117. # captureSnapshot was true.
  3118. optional array of integer paintOrders
  3119. # The offset rect of nodes. Only available when includeDOMRects is set to true
  3120. optional array of Rectangle offsetRects
  3121. # The scroll rect of nodes. Only available when includeDOMRects is set to true
  3122. optional array of Rectangle scrollRects
  3123. # The client rect of nodes. Only available when includeDOMRects is set to true
  3124. optional array of Rectangle clientRects
  3125. # The list of background colors that are blended with colors of overlapping elements.
  3126. experimental optional array of StringIndex blendedBackgroundColors
  3127. # The list of computed text opacities.
  3128. experimental optional array of number textColorOpacities
  3129. # Table of details of the post layout rendered text positions. The exact layout should not be regarded as
  3130. # stable and may change between versions.
  3131. type TextBoxSnapshot extends object
  3132. properties
  3133. # Index of the layout tree node that owns this box collection.
  3134. array of integer layoutIndex
  3135. # The absolute position bounding box.
  3136. array of Rectangle bounds
  3137. # The starting index in characters, for this post layout textbox substring. Characters that
  3138. # would be represented as a surrogate pair in UTF-16 have length 2.
  3139. array of integer start
  3140. # The number of characters in this post layout textbox substring. Characters that would be
  3141. # represented as a surrogate pair in UTF-16 have length 2.
  3142. array of integer length
  3143. # Disables DOM snapshot agent for the given page.
  3144. command disable
  3145. # Enables DOM snapshot agent for the given page.
  3146. command enable
  3147. # Returns a document snapshot, including the full DOM tree of the root node (including iframes,
  3148. # template contents, and imported documents) in a flattened array, as well as layout and
  3149. # white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
  3150. # flattened.
  3151. deprecated command getSnapshot
  3152. parameters
  3153. # Whitelist of computed styles to return.
  3154. array of string computedStyleWhitelist
  3155. # Whether or not to retrieve details of DOM listeners (default false).
  3156. optional boolean includeEventListeners
  3157. # Whether to determine and include the paint order index of LayoutTreeNodes (default false).
  3158. optional boolean includePaintOrder
  3159. # Whether to include UA shadow tree in the snapshot (default false).
  3160. optional boolean includeUserAgentShadowTree
  3161. returns
  3162. # The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
  3163. array of DOMNode domNodes
  3164. # The nodes in the layout tree.
  3165. array of LayoutTreeNode layoutTreeNodes
  3166. # Whitelisted ComputedStyle properties for each node in the layout tree.
  3167. array of ComputedStyle computedStyles
  3168. # Returns a document snapshot, including the full DOM tree of the root node (including iframes,
  3169. # template contents, and imported documents) in a flattened array, as well as layout and
  3170. # white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
  3171. # flattened.
  3172. command captureSnapshot
  3173. parameters
  3174. # Whitelist of computed styles to return.
  3175. array of string computedStyles
  3176. # Whether to include layout object paint orders into the snapshot.
  3177. optional boolean includePaintOrder
  3178. # Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
  3179. optional boolean includeDOMRects
  3180. # Whether to include blended background colors in the snapshot (default: false).
  3181. # Blended background color is achieved by blending background colors of all elements
  3182. # that overlap with the current element.
  3183. experimental optional boolean includeBlendedBackgroundColors
  3184. # Whether to include text color opacity in the snapshot (default: false).
  3185. # An element might have the opacity property set that affects the text color of the element.
  3186. # The final text color opacity is computed based on the opacity of all overlapping elements.
  3187. experimental optional boolean includeTextColorOpacities
  3188. returns
  3189. # The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
  3190. array of DocumentSnapshot documents
  3191. # Shared string table that all string properties refer to with indexes.
  3192. array of string strings
  3193. # Query and modify DOM storage.
  3194. experimental domain DOMStorage
  3195. type SerializedStorageKey extends string
  3196. # DOM Storage identifier.
  3197. type StorageId extends object
  3198. properties
  3199. # Security origin for the storage.
  3200. optional string securityOrigin
  3201. # Represents a key by which DOM Storage keys its CachedStorageAreas
  3202. optional SerializedStorageKey storageKey
  3203. # Whether the storage is local storage (not session storage).
  3204. boolean isLocalStorage
  3205. # DOM Storage item.
  3206. type Item extends array of string
  3207. command clear
  3208. parameters
  3209. StorageId storageId
  3210. # Disables storage tracking, prevents storage events from being sent to the client.
  3211. command disable
  3212. # Enables storage tracking, storage events will now be delivered to the client.
  3213. command enable
  3214. command getDOMStorageItems
  3215. parameters
  3216. StorageId storageId
  3217. returns
  3218. array of Item entries
  3219. command removeDOMStorageItem
  3220. parameters
  3221. StorageId storageId
  3222. string key
  3223. command setDOMStorageItem
  3224. parameters
  3225. StorageId storageId
  3226. string key
  3227. string value
  3228. event domStorageItemAdded
  3229. parameters
  3230. StorageId storageId
  3231. string key
  3232. string newValue
  3233. event domStorageItemRemoved
  3234. parameters
  3235. StorageId storageId
  3236. string key
  3237. event domStorageItemUpdated
  3238. parameters
  3239. StorageId storageId
  3240. string key
  3241. string oldValue
  3242. string newValue
  3243. event domStorageItemsCleared
  3244. parameters
  3245. StorageId storageId
  3246. experimental domain Database
  3247. # Unique identifier of Database object.
  3248. type DatabaseId extends string
  3249. # Database object.
  3250. type Database extends object
  3251. properties
  3252. # Database ID.
  3253. DatabaseId id
  3254. # Database domain.
  3255. string domain
  3256. # Database name.
  3257. string name
  3258. # Database version.
  3259. string version
  3260. # Database error.
  3261. type Error extends object
  3262. properties
  3263. # Error message.
  3264. string message
  3265. # Error code.
  3266. integer code
  3267. # Disables database tracking, prevents database events from being sent to the client.
  3268. command disable
  3269. # Enables database tracking, database events will now be delivered to the client.
  3270. command enable
  3271. command executeSQL
  3272. parameters
  3273. DatabaseId databaseId
  3274. string query
  3275. returns
  3276. optional array of string columnNames
  3277. optional array of any values
  3278. optional Error sqlError
  3279. command getDatabaseTableNames
  3280. parameters
  3281. DatabaseId databaseId
  3282. returns
  3283. array of string tableNames
  3284. event addDatabase
  3285. parameters
  3286. Database database
  3287. experimental domain DeviceOrientation
  3288. # Clears the overridden Device Orientation.
  3289. command clearDeviceOrientationOverride
  3290. # Overrides the Device Orientation.
  3291. command setDeviceOrientationOverride
  3292. parameters
  3293. # Mock alpha
  3294. number alpha
  3295. # Mock beta
  3296. number beta
  3297. # Mock gamma
  3298. number gamma
  3299. # This domain emulates different environments for the page.
  3300. domain Emulation
  3301. depends on DOM
  3302. depends on Page
  3303. depends on Runtime
  3304. # Screen orientation.
  3305. type ScreenOrientation extends object
  3306. properties
  3307. # Orientation type.
  3308. enum type
  3309. portraitPrimary
  3310. portraitSecondary
  3311. landscapePrimary
  3312. landscapeSecondary
  3313. # Orientation angle.
  3314. integer angle
  3315. type DisplayFeature extends object
  3316. properties
  3317. # Orientation of a display feature in relation to screen
  3318. enum orientation
  3319. vertical
  3320. horizontal
  3321. # The offset from the screen origin in either the x (for vertical
  3322. # orientation) or y (for horizontal orientation) direction.
  3323. integer offset
  3324. # A display feature may mask content such that it is not physically
  3325. # displayed - this length along with the offset describes this area.
  3326. # A display feature that only splits content will have a 0 mask_length.
  3327. integer maskLength
  3328. type MediaFeature extends object
  3329. properties
  3330. string name
  3331. string value
  3332. # advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to
  3333. # allow the next delayed task (if any) to run; pause: The virtual time base may not advance;
  3334. # pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending
  3335. # resource fetches.
  3336. experimental type VirtualTimePolicy extends string
  3337. enum
  3338. advance
  3339. pause
  3340. pauseIfNetworkFetchesPending
  3341. # Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
  3342. experimental type UserAgentBrandVersion extends object
  3343. properties
  3344. string brand
  3345. string version
  3346. # Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
  3347. # Missing optional values will be filled in by the target with what it would normally use.
  3348. experimental type UserAgentMetadata extends object
  3349. properties
  3350. # Brands appearing in Sec-CH-UA.
  3351. optional array of UserAgentBrandVersion brands
  3352. # Brands appearing in Sec-CH-UA-Full-Version-List.
  3353. optional array of UserAgentBrandVersion fullVersionList
  3354. deprecated optional string fullVersion
  3355. string platform
  3356. string platformVersion
  3357. string architecture
  3358. string model
  3359. boolean mobile
  3360. optional string bitness
  3361. optional boolean wow64
  3362. # Tells whether emulation is supported.
  3363. command canEmulate
  3364. returns
  3365. # True if emulation is supported.
  3366. boolean result
  3367. # Clears the overridden device metrics.
  3368. command clearDeviceMetricsOverride
  3369. # Clears the overridden Geolocation Position and Error.
  3370. command clearGeolocationOverride
  3371. # Requests that page scale factor is reset to initial values.
  3372. experimental command resetPageScaleFactor
  3373. # Enables or disables simulating a focused and active page.
  3374. experimental command setFocusEmulationEnabled
  3375. parameters
  3376. # Whether to enable to disable focus emulation.
  3377. boolean enabled
  3378. # Automatically render all web contents using a dark theme.
  3379. experimental command setAutoDarkModeOverride
  3380. parameters
  3381. # Whether to enable or disable automatic dark mode.
  3382. # If not specified, any existing override will be cleared.
  3383. optional boolean enabled
  3384. # Enables CPU throttling to emulate slow CPUs.
  3385. experimental command setCPUThrottlingRate
  3386. parameters
  3387. # Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).
  3388. number rate
  3389. # Sets or clears an override of the default background color of the frame. This override is used
  3390. # if the content does not specify one.
  3391. command setDefaultBackgroundColorOverride
  3392. parameters
  3393. # RGBA of the default background color. If not specified, any existing override will be
  3394. # cleared.
  3395. optional DOM.RGBA color
  3396. # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
  3397. # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
  3398. # query results).
  3399. command setDeviceMetricsOverride
  3400. parameters
  3401. # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  3402. integer width
  3403. # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  3404. integer height
  3405. # Overriding device scale factor value. 0 disables the override.
  3406. number deviceScaleFactor
  3407. # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
  3408. # autosizing and more.
  3409. boolean mobile
  3410. # Scale to apply to resulting view image.
  3411. experimental optional number scale
  3412. # Overriding screen width value in pixels (minimum 0, maximum 10000000).
  3413. experimental optional integer screenWidth
  3414. # Overriding screen height value in pixels (minimum 0, maximum 10000000).
  3415. experimental optional integer screenHeight
  3416. # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
  3417. experimental optional integer positionX
  3418. # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
  3419. experimental optional integer positionY
  3420. # Do not set visible view size, rely upon explicit setVisibleSize call.
  3421. experimental optional boolean dontSetVisibleSize
  3422. # Screen orientation override.
  3423. optional ScreenOrientation screenOrientation
  3424. # If set, the visible area of the page will be overridden to this viewport. This viewport
  3425. # change is not observed by the page, e.g. viewport-relative elements do not change positions.
  3426. experimental optional Page.Viewport viewport
  3427. # If set, the display feature of a multi-segment screen. If not set, multi-segment support
  3428. # is turned-off.
  3429. experimental optional DisplayFeature displayFeature
  3430. experimental command setScrollbarsHidden
  3431. parameters
  3432. # Whether scrollbars should be always hidden.
  3433. boolean hidden
  3434. experimental command setDocumentCookieDisabled
  3435. parameters
  3436. # Whether document.coookie API should be disabled.
  3437. boolean disabled
  3438. experimental command setEmitTouchEventsForMouse
  3439. parameters
  3440. # Whether touch emulation based on mouse input should be enabled.
  3441. boolean enabled
  3442. # Touch/gesture events configuration. Default: current platform.
  3443. optional enum configuration
  3444. mobile
  3445. desktop
  3446. # Emulates the given media type or media feature for CSS media queries.
  3447. command setEmulatedMedia
  3448. parameters
  3449. # Media type to emulate. Empty string disables the override.
  3450. optional string media
  3451. # Media features to emulate.
  3452. optional array of MediaFeature features
  3453. # Emulates the given vision deficiency.
  3454. experimental command setEmulatedVisionDeficiency
  3455. parameters
  3456. # Vision deficiency to emulate. Order: best-effort emulations come first, followed by any
  3457. # physiologically accurate emulations for medically recognized color vision deficiencies.
  3458. enum type
  3459. none
  3460. blurredVision
  3461. reducedContrast
  3462. achromatopsia
  3463. deuteranopia
  3464. protanopia
  3465. tritanopia
  3466. # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
  3467. # unavailable.
  3468. command setGeolocationOverride
  3469. parameters
  3470. # Mock latitude
  3471. optional number latitude
  3472. # Mock longitude
  3473. optional number longitude
  3474. # Mock accuracy
  3475. optional number accuracy
  3476. # Overrides the Idle state.
  3477. experimental command setIdleOverride
  3478. parameters
  3479. # Mock isUserActive
  3480. boolean isUserActive
  3481. # Mock isScreenUnlocked
  3482. boolean isScreenUnlocked
  3483. # Clears Idle state overrides.
  3484. experimental command clearIdleOverride
  3485. # Overrides value returned by the javascript navigator object.
  3486. experimental deprecated command setNavigatorOverrides
  3487. parameters
  3488. # The platform navigator.platform should return.
  3489. string platform
  3490. # Sets a specified page scale factor.
  3491. experimental command setPageScaleFactor
  3492. parameters
  3493. # Page scale factor.
  3494. number pageScaleFactor
  3495. # Switches script execution in the page.
  3496. command setScriptExecutionDisabled
  3497. parameters
  3498. # Whether script execution should be disabled in the page.
  3499. boolean value
  3500. # Enables touch on platforms which do not support them.
  3501. command setTouchEmulationEnabled
  3502. parameters
  3503. # Whether the touch event emulation should be enabled.
  3504. boolean enabled
  3505. # Maximum touch points supported. Defaults to one.
  3506. optional integer maxTouchPoints
  3507. # Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets
  3508. # the current virtual time policy. Note this supersedes any previous time budget.
  3509. experimental command setVirtualTimePolicy
  3510. parameters
  3511. VirtualTimePolicy policy
  3512. # If set, after this many virtual milliseconds have elapsed virtual time will be paused and a
  3513. # virtualTimeBudgetExpired event is sent.
  3514. optional number budget
  3515. # If set this specifies the maximum number of tasks that can be run before virtual is forced
  3516. # forwards to prevent deadlock.
  3517. optional integer maxVirtualTimeTaskStarvationCount
  3518. # If set, base::Time::Now will be overridden to initially return this value.
  3519. optional Network.TimeSinceEpoch initialVirtualTime
  3520. returns
  3521. # Absolute timestamp at which virtual time was first enabled (up time in milliseconds).
  3522. number virtualTimeTicksBase
  3523. # Overrides default host system locale with the specified one.
  3524. experimental command setLocaleOverride
  3525. parameters
  3526. # ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and
  3527. # restores default host system locale.
  3528. optional string locale
  3529. # Overrides default host system timezone with the specified one.
  3530. experimental command setTimezoneOverride
  3531. parameters
  3532. # The timezone identifier. If empty, disables the override and
  3533. # restores default host system timezone.
  3534. string timezoneId
  3535. # Resizes the frame/viewport of the page. Note that this does not affect the frame's container
  3536. # (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported
  3537. # on Android.
  3538. experimental deprecated command setVisibleSize
  3539. parameters
  3540. # Frame width (DIP).
  3541. integer width
  3542. # Frame height (DIP).
  3543. integer height
  3544. # Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
  3545. experimental event virtualTimeBudgetExpired
  3546. # Enum of image types that can be disabled.
  3547. experimental type DisabledImageType extends string
  3548. enum
  3549. avif
  3550. webp
  3551. experimental command setDisabledImageTypes
  3552. parameters
  3553. # Image types to disable.
  3554. array of DisabledImageType imageTypes
  3555. experimental command setHardwareConcurrencyOverride
  3556. parameters
  3557. # Hardware concurrency to report
  3558. integer hardwareConcurrency
  3559. # Allows overriding user agent with the given string.
  3560. command setUserAgentOverride
  3561. parameters
  3562. # User agent to use.
  3563. string userAgent
  3564. # Browser langugage to emulate.
  3565. optional string acceptLanguage
  3566. # The platform navigator.platform should return.
  3567. optional string platform
  3568. # To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
  3569. experimental optional UserAgentMetadata userAgentMetadata
  3570. # Allows overriding the automation flag.
  3571. experimental command setAutomationOverride
  3572. parameters
  3573. # Whether the override should be enabled.
  3574. boolean enabled
  3575. # This domain provides experimental commands only supported in headless mode.
  3576. experimental domain HeadlessExperimental
  3577. depends on Page
  3578. depends on Runtime
  3579. # Encoding options for a screenshot.
  3580. type ScreenshotParams extends object
  3581. properties
  3582. # Image compression format (defaults to png).
  3583. optional enum format
  3584. jpeg
  3585. png
  3586. webp
  3587. # Compression quality from range [0..100] (jpeg only).
  3588. optional integer quality
  3589. # Optimize image encoding for speed, not for resulting size (defaults to false)
  3590. optional boolean optimizeForSpeed
  3591. # Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
  3592. # screenshot from the resulting frame. Requires that the target was created with enabled
  3593. # BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
  3594. # https://goo.gle/chrome-headless-rendering for more background.
  3595. command beginFrame
  3596. parameters
  3597. # Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
  3598. # the current time will be used.
  3599. optional number frameTimeTicks
  3600. # The interval between BeginFrames that is reported to the compositor, in milliseconds.
  3601. # Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
  3602. optional number interval
  3603. # Whether updates should not be committed and drawn onto the display. False by default. If
  3604. # true, only side effects of the BeginFrame will be run, such as layout and animations, but
  3605. # any visual updates may not be visible on the display or in screenshots.
  3606. optional boolean noDisplayUpdates
  3607. # If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
  3608. # no screenshot will be captured. Note that capturing a screenshot can fail, for example,
  3609. # during renderer initialization. In such a case, no screenshot data will be returned.
  3610. optional ScreenshotParams screenshot
  3611. returns
  3612. # Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
  3613. # display. Reported for diagnostic uses, may be removed in the future.
  3614. boolean hasDamage
  3615. # Base64-encoded image data of the screenshot, if one was requested and successfully taken.
  3616. optional binary screenshotData
  3617. # Disables headless events for the target.
  3618. deprecated command disable
  3619. # Enables headless events for the target.
  3620. deprecated command enable
  3621. # Input/Output operations for streams produced by DevTools.
  3622. domain IO
  3623. # This is either obtained from another method or specified as `blob:&lt;uuid&gt;` where
  3624. # `&lt;uuid&gt` is an UUID of a Blob.
  3625. type StreamHandle extends string
  3626. # Close the stream, discard any temporary backing storage.
  3627. command close
  3628. parameters
  3629. # Handle of the stream to close.
  3630. StreamHandle handle
  3631. # Read a chunk of the stream
  3632. command read
  3633. parameters
  3634. # Handle of the stream to read.
  3635. StreamHandle handle
  3636. # Seek to the specified offset before reading (if not specificed, proceed with offset
  3637. # following the last read). Some types of streams may only support sequential reads.
  3638. optional integer offset
  3639. # Maximum number of bytes to read (left upon the agent discretion if not specified).
  3640. optional integer size
  3641. returns
  3642. # Set if the data is base64-encoded
  3643. optional boolean base64Encoded
  3644. # Data that were read.
  3645. string data
  3646. # Set if the end-of-file condition occurred while reading.
  3647. boolean eof
  3648. # Return UUID of Blob object specified by a remote object id.
  3649. command resolveBlob
  3650. parameters
  3651. # Object id of a Blob object wrapper.
  3652. Runtime.RemoteObjectId objectId
  3653. returns
  3654. # UUID of the specified Blob.
  3655. string uuid
  3656. experimental domain IndexedDB
  3657. depends on Runtime
  3658. depends on Storage
  3659. # Database with an array of object stores.
  3660. type DatabaseWithObjectStores extends object
  3661. properties
  3662. # Database name.
  3663. string name
  3664. # Database version (type is not 'integer', as the standard
  3665. # requires the version number to be 'unsigned long long')
  3666. number version
  3667. # Object stores in this database.
  3668. array of ObjectStore objectStores
  3669. # Object store.
  3670. type ObjectStore extends object
  3671. properties
  3672. # Object store name.
  3673. string name
  3674. # Object store key path.
  3675. KeyPath keyPath
  3676. # If true, object store has auto increment flag set.
  3677. boolean autoIncrement
  3678. # Indexes in this object store.
  3679. array of ObjectStoreIndex indexes
  3680. # Object store index.
  3681. type ObjectStoreIndex extends object
  3682. properties
  3683. # Index name.
  3684. string name
  3685. # Index key path.
  3686. KeyPath keyPath
  3687. # If true, index is unique.
  3688. boolean unique
  3689. # If true, index allows multiple entries for a key.
  3690. boolean multiEntry
  3691. # Key.
  3692. type Key extends object
  3693. properties
  3694. # Key type.
  3695. enum type
  3696. number
  3697. string
  3698. date
  3699. array
  3700. # Number value.
  3701. optional number number
  3702. # String value.
  3703. optional string string
  3704. # Date value.
  3705. optional number date
  3706. # Array value.
  3707. optional array of Key array
  3708. # Key range.
  3709. type KeyRange extends object
  3710. properties
  3711. # Lower bound.
  3712. optional Key lower
  3713. # Upper bound.
  3714. optional Key upper
  3715. # If true lower bound is open.
  3716. boolean lowerOpen
  3717. # If true upper bound is open.
  3718. boolean upperOpen
  3719. # Data entry.
  3720. type DataEntry extends object
  3721. properties
  3722. # Key object.
  3723. Runtime.RemoteObject key
  3724. # Primary key object.
  3725. Runtime.RemoteObject primaryKey
  3726. # Value object.
  3727. Runtime.RemoteObject value
  3728. # Key path.
  3729. type KeyPath extends object
  3730. properties
  3731. # Key path type.
  3732. enum type
  3733. null
  3734. string
  3735. array
  3736. # String value.
  3737. optional string string
  3738. # Array value.
  3739. optional array of string array
  3740. # Clears all entries from an object store.
  3741. command clearObjectStore
  3742. parameters
  3743. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3744. # Security origin.
  3745. optional string securityOrigin
  3746. # Storage key.
  3747. optional string storageKey
  3748. # Storage bucket. If not specified, it uses the default bucket.
  3749. optional Storage.StorageBucket storageBucket
  3750. # Database name.
  3751. string databaseName
  3752. # Object store name.
  3753. string objectStoreName
  3754. # Deletes a database.
  3755. command deleteDatabase
  3756. parameters
  3757. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3758. # Security origin.
  3759. optional string securityOrigin
  3760. # Storage key.
  3761. optional string storageKey
  3762. # Storage bucket. If not specified, it uses the default bucket.
  3763. optional Storage.StorageBucket storageBucket
  3764. # Database name.
  3765. string databaseName
  3766. # Delete a range of entries from an object store
  3767. command deleteObjectStoreEntries
  3768. parameters
  3769. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3770. # Security origin.
  3771. optional string securityOrigin
  3772. # Storage key.
  3773. optional string storageKey
  3774. # Storage bucket. If not specified, it uses the default bucket.
  3775. optional Storage.StorageBucket storageBucket
  3776. string databaseName
  3777. string objectStoreName
  3778. # Range of entry keys to delete
  3779. KeyRange keyRange
  3780. # Disables events from backend.
  3781. command disable
  3782. # Enables events from backend.
  3783. command enable
  3784. # Requests data from object store or index.
  3785. command requestData
  3786. parameters
  3787. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3788. # Security origin.
  3789. optional string securityOrigin
  3790. # Storage key.
  3791. optional string storageKey
  3792. # Storage bucket. If not specified, it uses the default bucket.
  3793. optional Storage.StorageBucket storageBucket
  3794. # Database name.
  3795. string databaseName
  3796. # Object store name.
  3797. string objectStoreName
  3798. # Index name, empty string for object store data requests.
  3799. string indexName
  3800. # Number of records to skip.
  3801. integer skipCount
  3802. # Number of records to fetch.
  3803. integer pageSize
  3804. # Key range.
  3805. optional KeyRange keyRange
  3806. returns
  3807. # Array of object store data entries.
  3808. array of DataEntry objectStoreDataEntries
  3809. # If true, there are more entries to fetch in the given range.
  3810. boolean hasMore
  3811. # Gets metadata of an object store.
  3812. command getMetadata
  3813. parameters
  3814. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3815. # Security origin.
  3816. optional string securityOrigin
  3817. # Storage key.
  3818. optional string storageKey
  3819. # Storage bucket. If not specified, it uses the default bucket.
  3820. optional Storage.StorageBucket storageBucket
  3821. # Database name.
  3822. string databaseName
  3823. # Object store name.
  3824. string objectStoreName
  3825. returns
  3826. # the entries count
  3827. number entriesCount
  3828. # the current value of key generator, to become the next inserted
  3829. # key into the object store. Valid if objectStore.autoIncrement
  3830. # is true.
  3831. number keyGeneratorValue
  3832. # Requests database with given name in given frame.
  3833. command requestDatabase
  3834. parameters
  3835. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3836. # Security origin.
  3837. optional string securityOrigin
  3838. # Storage key.
  3839. optional string storageKey
  3840. # Storage bucket. If not specified, it uses the default bucket.
  3841. optional Storage.StorageBucket storageBucket
  3842. # Database name.
  3843. string databaseName
  3844. returns
  3845. # Database with an array of object stores.
  3846. DatabaseWithObjectStores databaseWithObjectStores
  3847. # Requests database names for given security origin.
  3848. command requestDatabaseNames
  3849. parameters
  3850. # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
  3851. # Security origin.
  3852. optional string securityOrigin
  3853. # Storage key.
  3854. optional string storageKey
  3855. # Storage bucket. If not specified, it uses the default bucket.
  3856. optional Storage.StorageBucket storageBucket
  3857. returns
  3858. # Database names for origin.
  3859. array of string databaseNames
  3860. domain Input
  3861. type TouchPoint extends object
  3862. properties
  3863. # X coordinate of the event relative to the main frame's viewport in CSS pixels.
  3864. number x
  3865. # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
  3866. # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
  3867. number y
  3868. # X radius of the touch area (default: 1.0).
  3869. optional number radiusX
  3870. # Y radius of the touch area (default: 1.0).
  3871. optional number radiusY
  3872. # Rotation angle (default: 0.0).
  3873. optional number rotationAngle
  3874. # Force (default: 1.0).
  3875. optional number force
  3876. # The normalized tangential pressure, which has a range of [-1,1] (default: 0).
  3877. experimental optional number tangentialPressure
  3878. # The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
  3879. experimental optional integer tiltX
  3880. # The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
  3881. experimental optional integer tiltY
  3882. # The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
  3883. experimental optional integer twist
  3884. # Identifier used to track touch sources between events, must be unique within an event.
  3885. optional number id
  3886. experimental type GestureSourceType extends string
  3887. enum
  3888. default
  3889. touch
  3890. mouse
  3891. type MouseButton extends string
  3892. enum
  3893. none
  3894. left
  3895. middle
  3896. right
  3897. back
  3898. forward
  3899. # UTC time in seconds, counted from January 1, 1970.
  3900. type TimeSinceEpoch extends number
  3901. experimental type DragDataItem extends object
  3902. properties
  3903. # Mime type of the dragged data.
  3904. string mimeType
  3905. # Depending of the value of `mimeType`, it contains the dragged link,
  3906. # text, HTML markup or any other data.
  3907. string data
  3908. # Title associated with a link. Only valid when `mimeType` == "text/uri-list".
  3909. optional string title
  3910. # Stores the base URL for the contained markup. Only valid when `mimeType`
  3911. # == "text/html".
  3912. optional string baseURL
  3913. experimental type DragData extends object
  3914. properties
  3915. array of DragDataItem items
  3916. # List of filenames that should be included when dropping
  3917. optional array of string files
  3918. # Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16
  3919. integer dragOperationsMask
  3920. # Dispatches a drag event into the page.
  3921. experimental command dispatchDragEvent
  3922. parameters
  3923. # Type of the drag event.
  3924. enum type
  3925. dragEnter
  3926. dragOver
  3927. drop
  3928. dragCancel
  3929. # X coordinate of the event relative to the main frame's viewport in CSS pixels.
  3930. number x
  3931. # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
  3932. # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
  3933. number y
  3934. DragData data
  3935. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  3936. # (default: 0).
  3937. optional integer modifiers
  3938. # Dispatches a key event to the page.
  3939. command dispatchKeyEvent
  3940. parameters
  3941. # Type of the key event.
  3942. enum type
  3943. keyDown
  3944. keyUp
  3945. rawKeyDown
  3946. char
  3947. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  3948. # (default: 0).
  3949. optional integer modifiers
  3950. # Time at which the event occurred.
  3951. optional TimeSinceEpoch timestamp
  3952. # Text as generated by processing a virtual key code with a keyboard layout. Not needed for
  3953. # for `keyUp` and `rawKeyDown` events (default: "")
  3954. optional string text
  3955. # Text that would have been generated by the keyboard if no modifiers were pressed (except for
  3956. # shift). Useful for shortcut (accelerator) key handling (default: "").
  3957. optional string unmodifiedText
  3958. # Unique key identifier (e.g., 'U+0041') (default: "").
  3959. optional string keyIdentifier
  3960. # Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
  3961. optional string code
  3962. # Unique DOM defined string value describing the meaning of the key in the context of active
  3963. # modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
  3964. optional string key
  3965. # Windows virtual key code (default: 0).
  3966. optional integer windowsVirtualKeyCode
  3967. # Native virtual key code (default: 0).
  3968. optional integer nativeVirtualKeyCode
  3969. # Whether the event was generated from auto repeat (default: false).
  3970. optional boolean autoRepeat
  3971. # Whether the event was generated from the keypad (default: false).
  3972. optional boolean isKeypad
  3973. # Whether the event was a system key event (default: false).
  3974. optional boolean isSystemKey
  3975. # Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
  3976. # 0).
  3977. optional integer location
  3978. # Editing commands to send with the key event (e.g., 'selectAll') (default: []).
  3979. # These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
  3980. # See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
  3981. experimental optional array of string commands
  3982. # This method emulates inserting text that doesn't come from a key press,
  3983. # for example an emoji keyboard or an IME.
  3984. experimental command insertText
  3985. parameters
  3986. # The text to insert.
  3987. string text
  3988. # This method sets the current candidate text for ime.
  3989. # Use imeCommitComposition to commit the final text.
  3990. # Use imeSetComposition with empty string as text to cancel composition.
  3991. experimental command imeSetComposition
  3992. parameters
  3993. # The text to insert
  3994. string text
  3995. # selection start
  3996. integer selectionStart
  3997. # selection end
  3998. integer selectionEnd
  3999. # replacement start
  4000. optional integer replacementStart
  4001. # replacement end
  4002. optional integer replacementEnd
  4003. # Dispatches a mouse event to the page.
  4004. command dispatchMouseEvent
  4005. parameters
  4006. # Type of the mouse event.
  4007. enum type
  4008. mousePressed
  4009. mouseReleased
  4010. mouseMoved
  4011. mouseWheel
  4012. # X coordinate of the event relative to the main frame's viewport in CSS pixels.
  4013. number x
  4014. # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
  4015. # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
  4016. number y
  4017. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  4018. # (default: 0).
  4019. optional integer modifiers
  4020. # Time at which the event occurred.
  4021. optional TimeSinceEpoch timestamp
  4022. # Mouse button (default: "none").
  4023. optional MouseButton button
  4024. # A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
  4025. # Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
  4026. optional integer buttons
  4027. # Number of times the mouse button was clicked (default: 0).
  4028. optional integer clickCount
  4029. # The normalized pressure, which has a range of [0,1] (default: 0).
  4030. experimental optional number force
  4031. # The normalized tangential pressure, which has a range of [-1,1] (default: 0).
  4032. experimental optional number tangentialPressure
  4033. # The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
  4034. experimental optional integer tiltX
  4035. # The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
  4036. experimental optional integer tiltY
  4037. # The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
  4038. experimental optional integer twist
  4039. # X delta in CSS pixels for mouse wheel event (default: 0).
  4040. optional number deltaX
  4041. # Y delta in CSS pixels for mouse wheel event (default: 0).
  4042. optional number deltaY
  4043. # Pointer type (default: "mouse").
  4044. optional enum pointerType
  4045. mouse
  4046. pen
  4047. # Dispatches a touch event to the page.
  4048. command dispatchTouchEvent
  4049. parameters
  4050. # Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
  4051. # TouchStart and TouchMove must contains at least one.
  4052. enum type
  4053. touchStart
  4054. touchEnd
  4055. touchMove
  4056. touchCancel
  4057. # Active touch points on the touch device. One event per any changed point (compared to
  4058. # previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
  4059. # one by one.
  4060. array of TouchPoint touchPoints
  4061. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  4062. # (default: 0).
  4063. optional integer modifiers
  4064. # Time at which the event occurred.
  4065. optional TimeSinceEpoch timestamp
  4066. # Emulates touch event from the mouse event parameters.
  4067. experimental command emulateTouchFromMouseEvent
  4068. parameters
  4069. # Type of the mouse event.
  4070. enum type
  4071. mousePressed
  4072. mouseReleased
  4073. mouseMoved
  4074. mouseWheel
  4075. # X coordinate of the mouse pointer in DIP.
  4076. integer x
  4077. # Y coordinate of the mouse pointer in DIP.
  4078. integer y
  4079. # Mouse button. Only "none", "left", "right" are supported.
  4080. MouseButton button
  4081. # Time at which the event occurred (default: current time).
  4082. optional TimeSinceEpoch timestamp
  4083. # X delta in DIP for mouse wheel event (default: 0).
  4084. optional number deltaX
  4085. # Y delta in DIP for mouse wheel event (default: 0).
  4086. optional number deltaY
  4087. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  4088. # (default: 0).
  4089. optional integer modifiers
  4090. # Number of times the mouse button was clicked (default: 0).
  4091. optional integer clickCount
  4092. # Ignores input events (useful while auditing page).
  4093. command setIgnoreInputEvents
  4094. parameters
  4095. # Ignores input events processing when set to true.
  4096. boolean ignore
  4097. # Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
  4098. # Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
  4099. experimental command setInterceptDrags
  4100. parameters
  4101. boolean enabled
  4102. # Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
  4103. experimental command synthesizePinchGesture
  4104. parameters
  4105. # X coordinate of the start of the gesture in CSS pixels.
  4106. number x
  4107. # Y coordinate of the start of the gesture in CSS pixels.
  4108. number y
  4109. # Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
  4110. number scaleFactor
  4111. # Relative pointer speed in pixels per second (default: 800).
  4112. optional integer relativeSpeed
  4113. # Which type of input events to be generated (default: 'default', which queries the platform
  4114. # for the preferred input type).
  4115. optional GestureSourceType gestureSourceType
  4116. # Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
  4117. experimental command synthesizeScrollGesture
  4118. parameters
  4119. # X coordinate of the start of the gesture in CSS pixels.
  4120. number x
  4121. # Y coordinate of the start of the gesture in CSS pixels.
  4122. number y
  4123. # The distance to scroll along the X axis (positive to scroll left).
  4124. optional number xDistance
  4125. # The distance to scroll along the Y axis (positive to scroll up).
  4126. optional number yDistance
  4127. # The number of additional pixels to scroll back along the X axis, in addition to the given
  4128. # distance.
  4129. optional number xOverscroll
  4130. # The number of additional pixels to scroll back along the Y axis, in addition to the given
  4131. # distance.
  4132. optional number yOverscroll
  4133. # Prevent fling (default: true).
  4134. optional boolean preventFling
  4135. # Swipe speed in pixels per second (default: 800).
  4136. optional integer speed
  4137. # Which type of input events to be generated (default: 'default', which queries the platform
  4138. # for the preferred input type).
  4139. optional GestureSourceType gestureSourceType
  4140. # The number of times to repeat the gesture (default: 0).
  4141. optional integer repeatCount
  4142. # The number of milliseconds delay between each repeat. (default: 250).
  4143. optional integer repeatDelayMs
  4144. # The name of the interaction markers to generate, if not empty (default: "").
  4145. optional string interactionMarkerName
  4146. # Synthesizes a tap gesture over a time period by issuing appropriate touch events.
  4147. experimental command synthesizeTapGesture
  4148. parameters
  4149. # X coordinate of the start of the gesture in CSS pixels.
  4150. number x
  4151. # Y coordinate of the start of the gesture in CSS pixels.
  4152. number y
  4153. # Duration between touchdown and touchup events in ms (default: 50).
  4154. optional integer duration
  4155. # Number of times to perform the tap (e.g. 2 for double tap, default: 1).
  4156. optional integer tapCount
  4157. # Which type of input events to be generated (default: 'default', which queries the platform
  4158. # for the preferred input type).
  4159. optional GestureSourceType gestureSourceType
  4160. # Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to
  4161. # restore normal drag and drop behavior.
  4162. experimental event dragIntercepted
  4163. parameters
  4164. DragData data
  4165. experimental domain Inspector
  4166. # Disables inspector domain notifications.
  4167. command disable
  4168. # Enables inspector domain notifications.
  4169. command enable
  4170. # Fired when remote debugging connection is about to be terminated. Contains detach reason.
  4171. event detached
  4172. parameters
  4173. # The reason why connection has been terminated.
  4174. string reason
  4175. # Fired when debugging target has crashed
  4176. event targetCrashed
  4177. # Fired when debugging target has reloaded after crash
  4178. event targetReloadedAfterCrash
  4179. experimental domain LayerTree
  4180. depends on DOM
  4181. # Unique Layer identifier.
  4182. type LayerId extends string
  4183. # Unique snapshot identifier.
  4184. type SnapshotId extends string
  4185. # Rectangle where scrolling happens on the main thread.
  4186. type ScrollRect extends object
  4187. properties
  4188. # Rectangle itself.
  4189. DOM.Rect rect
  4190. # Reason for rectangle to force scrolling on the main thread
  4191. enum type
  4192. RepaintsOnScroll
  4193. TouchEventHandler
  4194. WheelEventHandler
  4195. # Sticky position constraints.
  4196. type StickyPositionConstraint extends object
  4197. properties
  4198. # Layout rectangle of the sticky element before being shifted
  4199. DOM.Rect stickyBoxRect
  4200. # Layout rectangle of the containing block of the sticky element
  4201. DOM.Rect containingBlockRect
  4202. # The nearest sticky layer that shifts the sticky box
  4203. optional LayerId nearestLayerShiftingStickyBox
  4204. # The nearest sticky layer that shifts the containing block
  4205. optional LayerId nearestLayerShiftingContainingBlock
  4206. # Serialized fragment of layer picture along with its offset within the layer.
  4207. type PictureTile extends object
  4208. properties
  4209. # Offset from owning layer left boundary
  4210. number x
  4211. # Offset from owning layer top boundary
  4212. number y
  4213. # Base64-encoded snapshot data.
  4214. binary picture
  4215. # Information about a compositing layer.
  4216. type Layer extends object
  4217. properties
  4218. # The unique id for this layer.
  4219. LayerId layerId
  4220. # The id of parent (not present for root).
  4221. optional LayerId parentLayerId
  4222. # The backend id for the node associated with this layer.
  4223. optional DOM.BackendNodeId backendNodeId
  4224. # Offset from parent layer, X coordinate.
  4225. number offsetX
  4226. # Offset from parent layer, Y coordinate.
  4227. number offsetY
  4228. # Layer width.
  4229. number width
  4230. # Layer height.
  4231. number height
  4232. # Transformation matrix for layer, default is identity matrix
  4233. optional array of number transform
  4234. # Transform anchor point X, absent if no transform specified
  4235. optional number anchorX
  4236. # Transform anchor point Y, absent if no transform specified
  4237. optional number anchorY
  4238. # Transform anchor point Z, absent if no transform specified
  4239. optional number anchorZ
  4240. # Indicates how many time this layer has painted.
  4241. integer paintCount
  4242. # Indicates whether this layer hosts any content, rather than being used for
  4243. # transform/scrolling purposes only.
  4244. boolean drawsContent
  4245. # Set if layer is not visible.
  4246. optional boolean invisible
  4247. # Rectangles scrolling on main thread only.
  4248. optional array of ScrollRect scrollRects
  4249. # Sticky position constraint information
  4250. optional StickyPositionConstraint stickyPositionConstraint
  4251. # Array of timings, one per paint step.
  4252. type PaintProfile extends array of number
  4253. # Provides the reasons why the given layer was composited.
  4254. command compositingReasons
  4255. parameters
  4256. # The id of the layer for which we want to get the reasons it was composited.
  4257. LayerId layerId
  4258. returns
  4259. # A list of strings specifying reasons for the given layer to become composited.
  4260. array of string compositingReasons
  4261. # A list of strings specifying reason IDs for the given layer to become composited.
  4262. array of string compositingReasonIds
  4263. # Disables compositing tree inspection.
  4264. command disable
  4265. # Enables compositing tree inspection.
  4266. command enable
  4267. # Returns the snapshot identifier.
  4268. command loadSnapshot
  4269. parameters
  4270. # An array of tiles composing the snapshot.
  4271. array of PictureTile tiles
  4272. returns
  4273. # The id of the snapshot.
  4274. SnapshotId snapshotId
  4275. # Returns the layer snapshot identifier.
  4276. command makeSnapshot
  4277. parameters
  4278. # The id of the layer.
  4279. LayerId layerId
  4280. returns
  4281. # The id of the layer snapshot.
  4282. SnapshotId snapshotId
  4283. command profileSnapshot
  4284. parameters
  4285. # The id of the layer snapshot.
  4286. SnapshotId snapshotId
  4287. # The maximum number of times to replay the snapshot (1, if not specified).
  4288. optional integer minRepeatCount
  4289. # The minimum duration (in seconds) to replay the snapshot.
  4290. optional number minDuration
  4291. # The clip rectangle to apply when replaying the snapshot.
  4292. optional DOM.Rect clipRect
  4293. returns
  4294. # The array of paint profiles, one per run.
  4295. array of PaintProfile timings
  4296. # Releases layer snapshot captured by the back-end.
  4297. command releaseSnapshot
  4298. parameters
  4299. # The id of the layer snapshot.
  4300. SnapshotId snapshotId
  4301. # Replays the layer snapshot and returns the resulting bitmap.
  4302. command replaySnapshot
  4303. parameters
  4304. # The id of the layer snapshot.
  4305. SnapshotId snapshotId
  4306. # The first step to replay from (replay from the very start if not specified).
  4307. optional integer fromStep
  4308. # The last step to replay to (replay till the end if not specified).
  4309. optional integer toStep
  4310. # The scale to apply while replaying (defaults to 1).
  4311. optional number scale
  4312. returns
  4313. # A data: URL for resulting image.
  4314. string dataURL
  4315. # Replays the layer snapshot and returns canvas log.
  4316. command snapshotCommandLog
  4317. parameters
  4318. # The id of the layer snapshot.
  4319. SnapshotId snapshotId
  4320. returns
  4321. # The array of canvas function calls.
  4322. array of object commandLog
  4323. event layerPainted
  4324. parameters
  4325. # The id of the painted layer.
  4326. LayerId layerId
  4327. # Clip rectangle.
  4328. DOM.Rect clip
  4329. event layerTreeDidChange
  4330. parameters
  4331. # Layer tree, absent if not in the comspositing mode.
  4332. optional array of Layer layers
  4333. # Provides access to log entries.
  4334. domain Log
  4335. depends on Runtime
  4336. depends on Network
  4337. # Log entry.
  4338. type LogEntry extends object
  4339. properties
  4340. # Log entry source.
  4341. enum source
  4342. xml
  4343. javascript
  4344. network
  4345. storage
  4346. appcache
  4347. rendering
  4348. security
  4349. deprecation
  4350. worker
  4351. violation
  4352. intervention
  4353. recommendation
  4354. other
  4355. # Log entry severity.
  4356. enum level
  4357. verbose
  4358. info
  4359. warning
  4360. error
  4361. # Logged text.
  4362. string text
  4363. optional enum category
  4364. cors
  4365. # Timestamp when this entry was added.
  4366. Runtime.Timestamp timestamp
  4367. # URL of the resource if known.
  4368. optional string url
  4369. # Line number in the resource.
  4370. optional integer lineNumber
  4371. # JavaScript stack trace.
  4372. optional Runtime.StackTrace stackTrace
  4373. # Identifier of the network request associated with this entry.
  4374. optional Network.RequestId networkRequestId
  4375. # Identifier of the worker associated with this entry.
  4376. optional string workerId
  4377. # Call arguments.
  4378. optional array of Runtime.RemoteObject args
  4379. # Violation configuration setting.
  4380. type ViolationSetting extends object
  4381. properties
  4382. # Violation type.
  4383. enum name
  4384. longTask
  4385. longLayout
  4386. blockedEvent
  4387. blockedParser
  4388. discouragedAPIUse
  4389. handler
  4390. recurringHandler
  4391. # Time threshold to trigger upon.
  4392. number threshold
  4393. # Clears the log.
  4394. command clear
  4395. # Disables log domain, prevents further log entries from being reported to the client.
  4396. command disable
  4397. # Enables log domain, sends the entries collected so far to the client by means of the
  4398. # `entryAdded` notification.
  4399. command enable
  4400. # start violation reporting.
  4401. command startViolationsReport
  4402. parameters
  4403. # Configuration for violations.
  4404. array of ViolationSetting config
  4405. # Stop violation reporting.
  4406. command stopViolationsReport
  4407. # Issued when new message was logged.
  4408. event entryAdded
  4409. parameters
  4410. # The entry.
  4411. LogEntry entry
  4412. experimental domain Memory
  4413. # Memory pressure level.
  4414. type PressureLevel extends string
  4415. enum
  4416. moderate
  4417. critical
  4418. command getDOMCounters
  4419. returns
  4420. integer documents
  4421. integer nodes
  4422. integer jsEventListeners
  4423. command prepareForLeakDetection
  4424. # Simulate OomIntervention by purging V8 memory.
  4425. command forciblyPurgeJavaScriptMemory
  4426. # Enable/disable suppressing memory pressure notifications in all processes.
  4427. command setPressureNotificationsSuppressed
  4428. parameters
  4429. # If true, memory pressure notifications will be suppressed.
  4430. boolean suppressed
  4431. # Simulate a memory pressure notification in all processes.
  4432. command simulatePressureNotification
  4433. parameters
  4434. # Memory pressure level of the notification.
  4435. PressureLevel level
  4436. # Start collecting native memory profile.
  4437. command startSampling
  4438. parameters
  4439. # Average number of bytes between samples.
  4440. optional integer samplingInterval
  4441. # Do not randomize intervals between samples.
  4442. optional boolean suppressRandomness
  4443. # Stop collecting native memory profile.
  4444. command stopSampling
  4445. # Retrieve native memory allocations profile
  4446. # collected since renderer process startup.
  4447. command getAllTimeSamplingProfile
  4448. returns
  4449. SamplingProfile profile
  4450. # Retrieve native memory allocations profile
  4451. # collected since browser process startup.
  4452. command getBrowserSamplingProfile
  4453. returns
  4454. SamplingProfile profile
  4455. # Retrieve native memory allocations profile collected since last
  4456. # `startSampling` call.
  4457. command getSamplingProfile
  4458. returns
  4459. SamplingProfile profile
  4460. # Heap profile sample.
  4461. type SamplingProfileNode extends object
  4462. properties
  4463. # Size of the sampled allocation.
  4464. number size
  4465. # Total bytes attributed to this sample.
  4466. number total
  4467. # Execution stack at the point of allocation.
  4468. array of string stack
  4469. # Array of heap profile samples.
  4470. type SamplingProfile extends object
  4471. properties
  4472. array of SamplingProfileNode samples
  4473. array of Module modules
  4474. # Executable module information
  4475. type Module extends object
  4476. properties
  4477. # Name of the module.
  4478. string name
  4479. # UUID of the module.
  4480. string uuid
  4481. # Base address where the module is loaded into memory. Encoded as a decimal
  4482. # or hexadecimal (0x prefixed) string.
  4483. string baseAddress
  4484. # Size of the module in bytes.
  4485. number size
  4486. # Network domain allows tracking network activities of the page. It exposes information about http,
  4487. # file, data and other requests and responses, their headers, bodies, timing, etc.
  4488. domain Network
  4489. depends on Debugger
  4490. depends on Runtime
  4491. depends on Security
  4492. # Resource type as it was perceived by the rendering engine.
  4493. type ResourceType extends string
  4494. enum
  4495. Document
  4496. Stylesheet
  4497. Image
  4498. Media
  4499. Font
  4500. Script
  4501. TextTrack
  4502. XHR
  4503. Fetch
  4504. Prefetch
  4505. EventSource
  4506. WebSocket
  4507. Manifest
  4508. SignedExchange
  4509. Ping
  4510. CSPViolationReport
  4511. Preflight
  4512. Other
  4513. # Unique loader identifier.
  4514. type LoaderId extends string
  4515. # Unique request identifier.
  4516. type RequestId extends string
  4517. # Unique intercepted request identifier.
  4518. type InterceptionId extends string
  4519. # Network level fetch failure reason.
  4520. type ErrorReason extends string
  4521. enum
  4522. Failed
  4523. Aborted
  4524. TimedOut
  4525. AccessDenied
  4526. ConnectionClosed
  4527. ConnectionReset
  4528. ConnectionRefused
  4529. ConnectionAborted
  4530. ConnectionFailed
  4531. NameNotResolved
  4532. InternetDisconnected
  4533. AddressUnreachable
  4534. BlockedByClient
  4535. BlockedByResponse
  4536. # UTC time in seconds, counted from January 1, 1970.
  4537. type TimeSinceEpoch extends number
  4538. # Monotonically increasing time in seconds since an arbitrary point in the past.
  4539. type MonotonicTime extends number
  4540. # Request / response headers as keys / values of JSON object.
  4541. type Headers extends object
  4542. # The underlying connection technology that the browser is supposedly using.
  4543. type ConnectionType extends string
  4544. enum
  4545. none
  4546. cellular2g
  4547. cellular3g
  4548. cellular4g
  4549. bluetooth
  4550. ethernet
  4551. wifi
  4552. wimax
  4553. other
  4554. # Represents the cookie's 'SameSite' status:
  4555. # https://tools.ietf.org/html/draft-west-first-party-cookies
  4556. type CookieSameSite extends string
  4557. enum
  4558. Strict
  4559. Lax
  4560. None
  4561. # Represents the cookie's 'Priority' status:
  4562. # https://tools.ietf.org/html/draft-west-cookie-priority-00
  4563. experimental type CookiePriority extends string
  4564. enum
  4565. Low
  4566. Medium
  4567. High
  4568. # Represents the source scheme of the origin that originally set the cookie.
  4569. # A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme.
  4570. # This is a temporary ability and it will be removed in the future.
  4571. experimental type CookieSourceScheme extends string
  4572. enum
  4573. Unset
  4574. NonSecure
  4575. Secure
  4576. # Timing information for the request.
  4577. type ResourceTiming extends object
  4578. properties
  4579. # Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
  4580. # milliseconds relatively to this requestTime.
  4581. number requestTime
  4582. # Started resolving proxy.
  4583. number proxyStart
  4584. # Finished resolving proxy.
  4585. number proxyEnd
  4586. # Started DNS address resolve.
  4587. number dnsStart
  4588. # Finished DNS address resolve.
  4589. number dnsEnd
  4590. # Started connecting to the remote host.
  4591. number connectStart
  4592. # Connected to the remote host.
  4593. number connectEnd
  4594. # Started SSL handshake.
  4595. number sslStart
  4596. # Finished SSL handshake.
  4597. number sslEnd
  4598. # Started running ServiceWorker.
  4599. experimental number workerStart
  4600. # Finished Starting ServiceWorker.
  4601. experimental number workerReady
  4602. # Started fetch event.
  4603. experimental number workerFetchStart
  4604. # Settled fetch event respondWith promise.
  4605. experimental number workerRespondWithSettled
  4606. # Started sending request.
  4607. number sendStart
  4608. # Finished sending request.
  4609. number sendEnd
  4610. # Time the server started pushing request.
  4611. experimental number pushStart
  4612. # Time the server finished pushing request.
  4613. experimental number pushEnd
  4614. # Finished receiving response headers.
  4615. number receiveHeadersEnd
  4616. # Loading priority of a resource request.
  4617. type ResourcePriority extends string
  4618. enum
  4619. VeryLow
  4620. Low
  4621. Medium
  4622. High
  4623. VeryHigh
  4624. # Post data entry for HTTP request
  4625. type PostDataEntry extends object
  4626. properties
  4627. optional binary bytes
  4628. # HTTP request data.
  4629. type Request extends object
  4630. properties
  4631. # Request URL (without fragment).
  4632. string url
  4633. # Fragment of the requested URL starting with hash, if present.
  4634. optional string urlFragment
  4635. # HTTP request method.
  4636. string method
  4637. # HTTP request headers.
  4638. Headers headers
  4639. # HTTP POST request data.
  4640. optional string postData
  4641. # True when the request has POST data. Note that postData might still be omitted when this flag is true when the data is too long.
  4642. optional boolean hasPostData
  4643. # Request body elements. This will be converted from base64 to binary
  4644. experimental optional array of PostDataEntry postDataEntries
  4645. # The mixed content type of the request.
  4646. optional Security.MixedContentType mixedContentType
  4647. # Priority of the resource request at the time request is sent.
  4648. ResourcePriority initialPriority
  4649. # The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
  4650. enum referrerPolicy
  4651. unsafe-url
  4652. no-referrer-when-downgrade
  4653. no-referrer
  4654. origin
  4655. origin-when-cross-origin
  4656. same-origin
  4657. strict-origin
  4658. strict-origin-when-cross-origin
  4659. # Whether is loaded via link preload.
  4660. optional boolean isLinkPreload
  4661. # Set for requests when the TrustToken API is used. Contains the parameters
  4662. # passed by the developer (e.g. via "fetch") as understood by the backend.
  4663. experimental optional TrustTokenParams trustTokenParams
  4664. # True if this resource request is considered to be the 'same site' as the
  4665. # request correspondinfg to the main frame.
  4666. experimental optional boolean isSameSite
  4667. # Details of a signed certificate timestamp (SCT).
  4668. type SignedCertificateTimestamp extends object
  4669. properties
  4670. # Validation status.
  4671. string status
  4672. # Origin.
  4673. string origin
  4674. # Log name / description.
  4675. string logDescription
  4676. # Log ID.
  4677. string logId
  4678. # Issuance date. Unlike TimeSinceEpoch, this contains the number of
  4679. # milliseconds since January 1, 1970, UTC, not the number of seconds.
  4680. number timestamp
  4681. # Hash algorithm.
  4682. string hashAlgorithm
  4683. # Signature algorithm.
  4684. string signatureAlgorithm
  4685. # Signature data.
  4686. string signatureData
  4687. # Security details about a request.
  4688. type SecurityDetails extends object
  4689. properties
  4690. # Protocol name (e.g. "TLS 1.2" or "QUIC").
  4691. string protocol
  4692. # Key Exchange used by the connection, or the empty string if not applicable.
  4693. string keyExchange
  4694. # (EC)DH group used by the connection, if applicable.
  4695. optional string keyExchangeGroup
  4696. # Cipher name.
  4697. string cipher
  4698. # TLS MAC. Note that AEAD ciphers do not have separate MACs.
  4699. optional string mac
  4700. # Certificate ID value.
  4701. Security.CertificateId certificateId
  4702. # Certificate subject name.
  4703. string subjectName
  4704. # Subject Alternative Name (SAN) DNS names and IP addresses.
  4705. array of string sanList
  4706. # Name of the issuing CA.
  4707. string issuer
  4708. # Certificate valid from date.
  4709. TimeSinceEpoch validFrom
  4710. # Certificate valid to (expiration) date
  4711. TimeSinceEpoch validTo
  4712. # List of signed certificate timestamps (SCTs).
  4713. array of SignedCertificateTimestamp signedCertificateTimestampList
  4714. # Whether the request complied with Certificate Transparency policy
  4715. CertificateTransparencyCompliance certificateTransparencyCompliance
  4716. # The signature algorithm used by the server in the TLS server signature,
  4717. # represented as a TLS SignatureScheme code point. Omitted if not
  4718. # applicable or not known.
  4719. optional integer serverSignatureAlgorithm
  4720. # Whether the connection used Encrypted ClientHello
  4721. boolean encryptedClientHello
  4722. # Whether the request complied with Certificate Transparency policy.
  4723. type CertificateTransparencyCompliance extends string
  4724. enum
  4725. unknown
  4726. not-compliant
  4727. compliant
  4728. # The reason why request was blocked.
  4729. type BlockedReason extends string
  4730. enum
  4731. other
  4732. csp
  4733. mixed-content
  4734. origin
  4735. inspector
  4736. subresource-filter
  4737. content-type
  4738. coep-frame-resource-needs-coep-header
  4739. coop-sandboxed-iframe-cannot-navigate-to-coop-page
  4740. corp-not-same-origin
  4741. corp-not-same-origin-after-defaulted-to-same-origin-by-coep
  4742. corp-not-same-site
  4743. # The reason why request was blocked.
  4744. type CorsError extends string
  4745. enum
  4746. DisallowedByMode
  4747. InvalidResponse
  4748. WildcardOriginNotAllowed
  4749. MissingAllowOriginHeader
  4750. MultipleAllowOriginValues
  4751. InvalidAllowOriginValue
  4752. AllowOriginMismatch
  4753. InvalidAllowCredentials
  4754. CorsDisabledScheme
  4755. PreflightInvalidStatus
  4756. PreflightDisallowedRedirect
  4757. PreflightWildcardOriginNotAllowed
  4758. PreflightMissingAllowOriginHeader
  4759. PreflightMultipleAllowOriginValues
  4760. PreflightInvalidAllowOriginValue
  4761. PreflightAllowOriginMismatch
  4762. PreflightInvalidAllowCredentials
  4763. # TODO(https://crbug.com/1263483): Remove this once frontend code does
  4764. # not reference it anymore.
  4765. PreflightMissingAllowExternal
  4766. # TODO(https://crbug.com/1263483): Remove this once frontend code does
  4767. # not reference it anymore.
  4768. PreflightInvalidAllowExternal
  4769. PreflightMissingAllowPrivateNetwork
  4770. PreflightInvalidAllowPrivateNetwork
  4771. InvalidAllowMethodsPreflightResponse
  4772. InvalidAllowHeadersPreflightResponse
  4773. MethodDisallowedByPreflightResponse
  4774. HeaderDisallowedByPreflightResponse
  4775. RedirectContainsCredentials
  4776. # Request was a private network request initiated by a non-secure context.
  4777. InsecurePrivateNetwork
  4778. # Request carried a target IP address space property that did not match
  4779. # the target resource's address space.
  4780. InvalidPrivateNetworkAccess
  4781. # Request was a private network request yet did not carry a target IP
  4782. # address space.
  4783. UnexpectedPrivateNetworkAccess
  4784. NoCorsRedirectModeNotFollow
  4785. type CorsErrorStatus extends object
  4786. properties
  4787. CorsError corsError
  4788. string failedParameter
  4789. # Source of serviceworker response.
  4790. type ServiceWorkerResponseSource extends string
  4791. enum
  4792. cache-storage
  4793. http-cache
  4794. fallback-code
  4795. network
  4796. # Determines what type of Trust Token operation is executed and
  4797. # depending on the type, some additional parameters. The values
  4798. # are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
  4799. experimental type TrustTokenParams extends object
  4800. properties
  4801. TrustTokenOperationType operation
  4802. # Only set for "token-redemption" operation and determine whether
  4803. # to request a fresh SRR or use a still valid cached SRR.
  4804. enum refreshPolicy
  4805. UseCached
  4806. Refresh
  4807. # Origins of issuers from whom to request tokens or redemption
  4808. # records.
  4809. optional array of string issuers
  4810. experimental type TrustTokenOperationType extends string
  4811. enum
  4812. # Type "token-request" in the Trust Token API.
  4813. Issuance
  4814. # Type "token-redemption" in the Trust Token API.
  4815. Redemption
  4816. # Type "send-redemption-record" in the Trust Token API.
  4817. Signing
  4818. # The reason why Chrome uses a specific transport protocol for HTTP semantics.
  4819. experimental type AlternateProtocolUsage extends string
  4820. enum
  4821. # Alternate Protocol was used without racing a normal connection.
  4822. alternativeJobWonWithoutRace
  4823. # Alternate Protocol was used by winning a race with a normal connection.
  4824. alternativeJobWonRace
  4825. # Alternate Protocol was not used by losing a race with a normal connection.
  4826. mainJobWonRace
  4827. # Alternate Protocol was not used because no Alternate-Protocol information
  4828. # was available when the request was issued, but an Alternate-Protocol header
  4829. # was present in the response.
  4830. mappingMissing
  4831. # Alternate Protocol was not used because it was marked broken.
  4832. broken
  4833. # HTTPS DNS protocol upgrade job was used without racing with a normal
  4834. # connection and an Alternate Protocol job.
  4835. dnsAlpnH3JobWonWithoutRace
  4836. # HTTPS DNS protocol upgrade job won a race with a normal connection and
  4837. # an Alternate Protocol job.
  4838. dnsAlpnH3JobWonRace
  4839. # This value is used when the reason is unknown.
  4840. unspecifiedReason
  4841. # HTTP response data.
  4842. type Response extends object
  4843. properties
  4844. # Response URL. This URL can be different from CachedResource.url in case of redirect.
  4845. string url
  4846. # HTTP response status code.
  4847. integer status
  4848. # HTTP response status text.
  4849. string statusText
  4850. # HTTP response headers.
  4851. Headers headers
  4852. # HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.
  4853. deprecated optional string headersText
  4854. # Resource mimeType as determined by the browser.
  4855. string mimeType
  4856. # Refined HTTP request headers that were actually transmitted over the network.
  4857. optional Headers requestHeaders
  4858. # HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.
  4859. deprecated optional string requestHeadersText
  4860. # Specifies whether physical connection was actually reused for this request.
  4861. boolean connectionReused
  4862. # Physical connection id that was actually used for this request.
  4863. number connectionId
  4864. # Remote IP address.
  4865. optional string remoteIPAddress
  4866. # Remote port.
  4867. optional integer remotePort
  4868. # Specifies that the request was served from the disk cache.
  4869. optional boolean fromDiskCache
  4870. # Specifies that the request was served from the ServiceWorker.
  4871. optional boolean fromServiceWorker
  4872. # Specifies that the request was served from the prefetch cache.
  4873. optional boolean fromPrefetchCache
  4874. # Total number of bytes received for this request so far.
  4875. number encodedDataLength
  4876. # Timing information for the given request.
  4877. optional ResourceTiming timing
  4878. # Response source of response from ServiceWorker.
  4879. optional ServiceWorkerResponseSource serviceWorkerResponseSource
  4880. # The time at which the returned response was generated.
  4881. optional TimeSinceEpoch responseTime
  4882. # Cache Storage Cache Name.
  4883. optional string cacheStorageCacheName
  4884. # Protocol used to fetch this request.
  4885. optional string protocol
  4886. # The reason why Chrome uses a specific transport protocol for HTTP semantics.
  4887. experimental optional AlternateProtocolUsage alternateProtocolUsage
  4888. # Security state of the request resource.
  4889. Security.SecurityState securityState
  4890. # Security details for the request.
  4891. optional SecurityDetails securityDetails
  4892. # WebSocket request data.
  4893. type WebSocketRequest extends object
  4894. properties
  4895. # HTTP request headers.
  4896. Headers headers
  4897. # WebSocket response data.
  4898. type WebSocketResponse extends object
  4899. properties
  4900. # HTTP response status code.
  4901. integer status
  4902. # HTTP response status text.
  4903. string statusText
  4904. # HTTP response headers.
  4905. Headers headers
  4906. # HTTP response headers text.
  4907. optional string headersText
  4908. # HTTP request headers.
  4909. optional Headers requestHeaders
  4910. # HTTP request headers text.
  4911. optional string requestHeadersText
  4912. # WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
  4913. type WebSocketFrame extends object
  4914. properties
  4915. # WebSocket message opcode.
  4916. number opcode
  4917. # WebSocket message mask.
  4918. boolean mask
  4919. # WebSocket message payload data.
  4920. # If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
  4921. # If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
  4922. string payloadData
  4923. # Information about the cached resource.
  4924. type CachedResource extends object
  4925. properties
  4926. # Resource URL. This is the url of the original network request.
  4927. string url
  4928. # Type of this resource.
  4929. ResourceType type
  4930. # Cached response data.
  4931. optional Response response
  4932. # Cached response body size.
  4933. number bodySize
  4934. # Information about the request initiator.
  4935. type Initiator extends object
  4936. properties
  4937. # Type of this initiator.
  4938. enum type
  4939. parser
  4940. script
  4941. preload
  4942. SignedExchange
  4943. preflight
  4944. other
  4945. # Initiator JavaScript stack trace, set for Script only.
  4946. optional Runtime.StackTrace stack
  4947. # Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
  4948. optional string url
  4949. # Initiator line number, set for Parser type or for Script type (when script is importing
  4950. # module) (0-based).
  4951. optional number lineNumber
  4952. # Initiator column number, set for Parser type or for Script type (when script is importing
  4953. # module) (0-based).
  4954. optional number columnNumber
  4955. # Set if another request triggered this request (e.g. preflight).
  4956. optional RequestId requestId
  4957. # Cookie object
  4958. type Cookie extends object
  4959. properties
  4960. # Cookie name.
  4961. string name
  4962. # Cookie value.
  4963. string value
  4964. # Cookie domain.
  4965. string domain
  4966. # Cookie path.
  4967. string path
  4968. # Cookie expiration date as the number of seconds since the UNIX epoch.
  4969. number expires
  4970. # Cookie size.
  4971. integer size
  4972. # True if cookie is http-only.
  4973. boolean httpOnly
  4974. # True if cookie is secure.
  4975. boolean secure
  4976. # True in case of session cookie.
  4977. boolean session
  4978. # Cookie SameSite type.
  4979. optional CookieSameSite sameSite
  4980. # Cookie Priority
  4981. experimental CookiePriority priority
  4982. # True if cookie is SameParty.
  4983. experimental boolean sameParty
  4984. # Cookie source scheme type.
  4985. experimental CookieSourceScheme sourceScheme
  4986. # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
  4987. # An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
  4988. # This is a temporary ability and it will be removed in the future.
  4989. experimental integer sourcePort
  4990. # Cookie partition key. The site of the top-level URL the browser was visiting at the start
  4991. # of the request to the endpoint that set the cookie.
  4992. experimental optional string partitionKey
  4993. # True if cookie partition key is opaque.
  4994. experimental optional boolean partitionKeyOpaque
  4995. # Types of reasons why a cookie may not be stored from a response.
  4996. experimental type SetCookieBlockedReason extends string
  4997. enum
  4998. # The cookie had the "Secure" attribute but was not received over a secure connection.
  4999. SecureOnly
  5000. # The cookie had the "SameSite=Strict" attribute but came from a cross-origin response.
  5001. # This includes navigation requests intitiated by other origins.
  5002. SameSiteStrict
  5003. # The cookie had the "SameSite=Lax" attribute but came from a cross-origin response.
  5004. SameSiteLax
  5005. # The cookie didn't specify a "SameSite" attribute and was defaulted to "SameSite=Lax" and
  5006. # broke the same rules specified in the SameSiteLax value.
  5007. SameSiteUnspecifiedTreatedAsLax
  5008. # The cookie had the "SameSite=None" attribute but did not specify the "Secure" attribute,
  5009. # which is required in order to use "SameSite=None".
  5010. SameSiteNoneInsecure
  5011. # The cookie was not stored due to user preferences.
  5012. UserPreferences
  5013. # The cookie was blocked by third-party cookie blocking between sites in
  5014. # the same First-Party Set.
  5015. ThirdPartyBlockedInFirstPartySet
  5016. # The syntax of the Set-Cookie header of the response was invalid.
  5017. SyntaxError
  5018. # The scheme of the connection is not allowed to store cookies.
  5019. SchemeNotSupported
  5020. # The cookie was not sent over a secure connection and would have overwritten a cookie with
  5021. # the Secure attribute.
  5022. OverwriteSecure
  5023. # The cookie's domain attribute was invalid with regards to the current host url.
  5024. InvalidDomain
  5025. # The cookie used the "__Secure-" or "__Host-" prefix in its name and broke the additional
  5026. # rules applied to cookies with these prefixes as defined in
  5027. # https://tools.ietf.org/html/draft-west-cookie-prefixes-05
  5028. InvalidPrefix
  5029. # An unknown error was encountered when trying to store this cookie.
  5030. UnknownError
  5031. # The cookie had the "SameSite=Strict" attribute but came from a response
  5032. # with the same registrable domain but a different scheme.
  5033. # This includes navigation requests intitiated by other origins.
  5034. # This is the "Schemeful Same-Site" version of the blocked reason.
  5035. SchemefulSameSiteStrict
  5036. # The cookie had the "SameSite=Lax" attribute but came from a response
  5037. # with the same registrable domain but a different scheme.
  5038. # This is the "Schemeful Same-Site" version of the blocked reason.
  5039. SchemefulSameSiteLax
  5040. # The cookie didn't specify a "SameSite" attribute and was defaulted to
  5041. # "SameSite=Lax" and broke the same rules specified in the SchemefulSameSiteLax
  5042. # value.
  5043. # This is the "Schemeful Same-Site" version of the blocked reason.
  5044. SchemefulSameSiteUnspecifiedTreatedAsLax
  5045. # The cookie had the "SameParty" attribute but came from a cross-party response.
  5046. SamePartyFromCrossPartyContext
  5047. # The cookie had the "SameParty" attribute but did not specify the "Secure" attribute
  5048. # (which is required in order to use "SameParty"); or specified the "SameSite=Strict"
  5049. # attribute (which is forbidden when using "SameParty").
  5050. SamePartyConflictsWithOtherAttributes
  5051. # The cookie's name/value pair size exceeded the size limit defined in
  5052. # RFC6265bis.
  5053. NameValuePairExceedsMaxSize
  5054. # Types of reasons why a cookie may not be sent with a request.
  5055. experimental type CookieBlockedReason extends string
  5056. enum
  5057. # The cookie had the "Secure" attribute and the connection was not secure.
  5058. SecureOnly
  5059. # The cookie's path was not within the request url's path.
  5060. NotOnPath
  5061. # The cookie's domain is not configured to match the request url's domain, even though they
  5062. # share a common TLD+1 (TLD+1 of foo.bar.example.com is example.com).
  5063. DomainMismatch
  5064. # The cookie had the "SameSite=Strict" attribute and the request was made on on a different
  5065. # site. This includes navigation requests initiated by other sites.
  5066. SameSiteStrict
  5067. # The cookie had the "SameSite=Lax" attribute and the request was made on a different site.
  5068. # This does not include navigation requests initiated by other sites.
  5069. SameSiteLax
  5070. # The cookie didn't specify a SameSite attribute when it was stored and was defaulted to
  5071. # "SameSite=Lax" and broke the same rules specified in the SameSiteLax value. The cookie had
  5072. # to have been set with "SameSite=None" to enable third-party usage.
  5073. SameSiteUnspecifiedTreatedAsLax
  5074. # The cookie had the "SameSite=None" attribute and the connection was not secure. Cookies
  5075. # without SameSite restrictions must be sent over a secure connection.
  5076. SameSiteNoneInsecure
  5077. # The cookie was not sent due to user preferences.
  5078. UserPreferences
  5079. # The cookie was blocked by third-party cookie blocking between sites in
  5080. # the same First-Party Set.
  5081. ThirdPartyBlockedInFirstPartySet
  5082. # An unknown error was encountered when trying to send this cookie.
  5083. UnknownError
  5084. # The cookie had the "SameSite=Strict" attribute but came from a response
  5085. # with the same registrable domain but a different scheme.
  5086. # This includes navigation requests intitiated by other origins.
  5087. # This is the "Schemeful Same-Site" version of the blocked reason.
  5088. SchemefulSameSiteStrict
  5089. # The cookie had the "SameSite=Lax" attribute but came from a response
  5090. # with the same registrable domain but a different scheme.
  5091. # This is the "Schemeful Same-Site" version of the blocked reason.
  5092. SchemefulSameSiteLax
  5093. # The cookie didn't specify a "SameSite" attribute and was defaulted to
  5094. # "SameSite=Lax" and broke the same rules specified in the SchemefulSameSiteLax
  5095. # value.
  5096. # This is the "Schemeful Same-Site" version of the blocked reason.
  5097. SchemefulSameSiteUnspecifiedTreatedAsLax
  5098. # The cookie had the "SameParty" attribute and the request was made from a cross-party context.
  5099. SamePartyFromCrossPartyContext
  5100. # The cookie's name/value pair size exceeded the size limit defined in
  5101. # RFC6265bis.
  5102. NameValuePairExceedsMaxSize
  5103. # A cookie which was not stored from a response with the corresponding reason.
  5104. experimental type BlockedSetCookieWithReason extends object
  5105. properties
  5106. # The reason(s) this cookie was blocked.
  5107. array of SetCookieBlockedReason blockedReasons
  5108. # The string representing this individual cookie as it would appear in the header.
  5109. # This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
  5110. string cookieLine
  5111. # The cookie object which represents the cookie which was not stored. It is optional because
  5112. # sometimes complete cookie information is not available, such as in the case of parsing
  5113. # errors.
  5114. optional Cookie cookie
  5115. # A cookie with was not sent with a request with the corresponding reason.
  5116. experimental type BlockedCookieWithReason extends object
  5117. properties
  5118. # The reason(s) the cookie was blocked.
  5119. array of CookieBlockedReason blockedReasons
  5120. # The cookie object representing the cookie which was not sent.
  5121. Cookie cookie
  5122. # Cookie parameter object
  5123. type CookieParam extends object
  5124. properties
  5125. # Cookie name.
  5126. string name
  5127. # Cookie value.
  5128. string value
  5129. # The request-URI to associate with the setting of the cookie. This value can affect the
  5130. # default domain, path, source port, and source scheme values of the created cookie.
  5131. optional string url
  5132. # Cookie domain.
  5133. optional string domain
  5134. # Cookie path.
  5135. optional string path
  5136. # True if cookie is secure.
  5137. optional boolean secure
  5138. # True if cookie is http-only.
  5139. optional boolean httpOnly
  5140. # Cookie SameSite type.
  5141. optional CookieSameSite sameSite
  5142. # Cookie expiration date, session cookie if not set
  5143. optional TimeSinceEpoch expires
  5144. # Cookie Priority.
  5145. experimental optional CookiePriority priority
  5146. # True if cookie is SameParty.
  5147. experimental optional boolean sameParty
  5148. # Cookie source scheme type.
  5149. experimental optional CookieSourceScheme sourceScheme
  5150. # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
  5151. # An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
  5152. # This is a temporary ability and it will be removed in the future.
  5153. experimental optional integer sourcePort
  5154. # Cookie partition key. The site of the top-level URL the browser was visiting at the start
  5155. # of the request to the endpoint that set the cookie.
  5156. # If not set, the cookie will be set as not partitioned.
  5157. experimental optional string partitionKey
  5158. # Authorization challenge for HTTP status code 401 or 407.
  5159. experimental type AuthChallenge extends object
  5160. properties
  5161. # Source of the authentication challenge.
  5162. optional enum source
  5163. Server
  5164. Proxy
  5165. # Origin of the challenger.
  5166. string origin
  5167. # The authentication scheme used, such as basic or digest
  5168. string scheme
  5169. # The realm of the challenge. May be empty.
  5170. string realm
  5171. # Response to an AuthChallenge.
  5172. experimental type AuthChallengeResponse extends object
  5173. properties
  5174. # The decision on what to do in response to the authorization challenge. Default means
  5175. # deferring to the default behavior of the net stack, which will likely either the Cancel
  5176. # authentication or display a popup dialog box.
  5177. enum response
  5178. Default
  5179. CancelAuth
  5180. ProvideCredentials
  5181. # The username to provide, possibly empty. Should only be set if response is
  5182. # ProvideCredentials.
  5183. optional string username
  5184. # The password to provide, possibly empty. Should only be set if response is
  5185. # ProvideCredentials.
  5186. optional string password
  5187. # Stages of the interception to begin intercepting. Request will intercept before the request is
  5188. # sent. Response will intercept after the response is received.
  5189. experimental type InterceptionStage extends string
  5190. enum
  5191. Request
  5192. HeadersReceived
  5193. # Request pattern for interception.
  5194. experimental type RequestPattern extends object
  5195. properties
  5196. # Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
  5197. # backslash. Omitting is equivalent to `"*"`.
  5198. optional string urlPattern
  5199. # If set, only requests for matching resource types will be intercepted.
  5200. optional ResourceType resourceType
  5201. # Stage at which to begin intercepting requests. Default is Request.
  5202. optional InterceptionStage interceptionStage
  5203. # Information about a signed exchange signature.
  5204. # https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
  5205. experimental type SignedExchangeSignature extends object
  5206. properties
  5207. # Signed exchange signature label.
  5208. string label
  5209. # The hex string of signed exchange signature.
  5210. string signature
  5211. # Signed exchange signature integrity.
  5212. string integrity
  5213. # Signed exchange signature cert Url.
  5214. optional string certUrl
  5215. # The hex string of signed exchange signature cert sha256.
  5216. optional string certSha256
  5217. # Signed exchange signature validity Url.
  5218. string validityUrl
  5219. # Signed exchange signature date.
  5220. integer date
  5221. # Signed exchange signature expires.
  5222. integer expires
  5223. # The encoded certificates.
  5224. optional array of string certificates
  5225. # Information about a signed exchange header.
  5226. # https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
  5227. experimental type SignedExchangeHeader extends object
  5228. properties
  5229. # Signed exchange request URL.
  5230. string requestUrl
  5231. # Signed exchange response code.
  5232. integer responseCode
  5233. # Signed exchange response headers.
  5234. Headers responseHeaders
  5235. # Signed exchange response signature.
  5236. array of SignedExchangeSignature signatures
  5237. # Signed exchange header integrity hash in the form of "sha256-<base64-hash-value>".
  5238. string headerIntegrity
  5239. # Field type for a signed exchange related error.
  5240. experimental type SignedExchangeErrorField extends string
  5241. enum
  5242. signatureSig
  5243. signatureIntegrity
  5244. signatureCertUrl
  5245. signatureCertSha256
  5246. signatureValidityUrl
  5247. signatureTimestamps
  5248. # Information about a signed exchange response.
  5249. experimental type SignedExchangeError extends object
  5250. properties
  5251. # Error message.
  5252. string message
  5253. # The index of the signature which caused the error.
  5254. optional integer signatureIndex
  5255. # The field which caused the error.
  5256. optional SignedExchangeErrorField errorField
  5257. # Information about a signed exchange response.
  5258. experimental type SignedExchangeInfo extends object
  5259. properties
  5260. # The outer response of signed HTTP exchange which was received from network.
  5261. Response outerResponse
  5262. # Information about the signed exchange header.
  5263. optional SignedExchangeHeader header
  5264. # Security details for the signed exchange header.
  5265. optional SecurityDetails securityDetails
  5266. # Errors occurred while handling the signed exchagne.
  5267. optional array of SignedExchangeError errors
  5268. # List of content encodings supported by the backend.
  5269. experimental type ContentEncoding extends string
  5270. enum
  5271. deflate
  5272. gzip
  5273. br
  5274. # Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted.
  5275. experimental command setAcceptedEncodings
  5276. parameters
  5277. # List of accepted content encodings.
  5278. array of ContentEncoding encodings
  5279. # Clears accepted encodings set by setAcceptedEncodings
  5280. experimental command clearAcceptedEncodingsOverride
  5281. # Tells whether clearing browser cache is supported.
  5282. deprecated command canClearBrowserCache
  5283. returns
  5284. # True if browser cache can be cleared.
  5285. boolean result
  5286. # Tells whether clearing browser cookies is supported.
  5287. deprecated command canClearBrowserCookies
  5288. returns
  5289. # True if browser cookies can be cleared.
  5290. boolean result
  5291. # Tells whether emulation of network conditions is supported.
  5292. deprecated command canEmulateNetworkConditions
  5293. returns
  5294. # True if emulation of network conditions is supported.
  5295. boolean result
  5296. # Clears browser cache.
  5297. command clearBrowserCache
  5298. # Clears browser cookies.
  5299. command clearBrowserCookies
  5300. # Response to Network.requestIntercepted which either modifies the request to continue with any
  5301. # modifications, or blocks it, or completes it with the provided response bytes. If a network
  5302. # fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted
  5303. # event will be sent with the same InterceptionId.
  5304. # Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead.
  5305. experimental deprecated command continueInterceptedRequest
  5306. parameters
  5307. InterceptionId interceptionId
  5308. # If set this causes the request to fail with the given reason. Passing `Aborted` for requests
  5309. # marked with `isNavigationRequest` also cancels the navigation. Must not be set in response
  5310. # to an authChallenge.
  5311. optional ErrorReason errorReason
  5312. # If set the requests completes using with the provided base64 encoded raw response, including
  5313. # HTTP status line and headers etc... Must not be set in response to an authChallenge.
  5314. optional binary rawResponse
  5315. # If set the request url will be modified in a way that's not observable by page. Must not be
  5316. # set in response to an authChallenge.
  5317. optional string url
  5318. # If set this allows the request method to be overridden. Must not be set in response to an
  5319. # authChallenge.
  5320. optional string method
  5321. # If set this allows postData to be set. Must not be set in response to an authChallenge.
  5322. optional string postData
  5323. # If set this allows the request headers to be changed. Must not be set in response to an
  5324. # authChallenge.
  5325. optional Headers headers
  5326. # Response to a requestIntercepted with an authChallenge. Must not be set otherwise.
  5327. optional AuthChallengeResponse authChallengeResponse
  5328. # Deletes browser cookies with matching name and url or domain/path pair.
  5329. command deleteCookies
  5330. parameters
  5331. # Name of the cookies to remove.
  5332. string name
  5333. # If specified, deletes all the cookies with the given name where domain and path match
  5334. # provided URL.
  5335. optional string url
  5336. # If specified, deletes only cookies with the exact domain.
  5337. optional string domain
  5338. # If specified, deletes only cookies with the exact path.
  5339. optional string path
  5340. # Disables network tracking, prevents network events from being sent to the client.
  5341. command disable
  5342. # Activates emulation of network conditions.
  5343. command emulateNetworkConditions
  5344. parameters
  5345. # True to emulate internet disconnection.
  5346. boolean offline
  5347. # Minimum latency from request sent to response headers received (ms).
  5348. number latency
  5349. # Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
  5350. number downloadThroughput
  5351. # Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
  5352. number uploadThroughput
  5353. # Connection type if known.
  5354. optional ConnectionType connectionType
  5355. # Enables network tracking, network events will now be delivered to the client.
  5356. command enable
  5357. parameters
  5358. # Buffer size in bytes to use when preserving network payloads (XHRs, etc).
  5359. experimental optional integer maxTotalBufferSize
  5360. # Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).
  5361. experimental optional integer maxResourceBufferSize
  5362. # Longest post body size (in bytes) that would be included in requestWillBeSent notification
  5363. optional integer maxPostDataSize
  5364. # Returns all browser cookies. Depending on the backend support, will return detailed cookie
  5365. # information in the `cookies` field.
  5366. # Deprecated. Use Storage.getCookies instead.
  5367. deprecated command getAllCookies
  5368. returns
  5369. # Array of cookie objects.
  5370. array of Cookie cookies
  5371. # Returns the DER-encoded certificate.
  5372. experimental command getCertificate
  5373. parameters
  5374. # Origin to get certificate for.
  5375. string origin
  5376. returns
  5377. array of string tableNames
  5378. # Returns all browser cookies for the current URL. Depending on the backend support, will return
  5379. # detailed cookie information in the `cookies` field.
  5380. command getCookies
  5381. parameters
  5382. # The list of URLs for which applicable cookies will be fetched.
  5383. # If not specified, it's assumed to be set to the list containing
  5384. # the URLs of the page and all of its subframes.
  5385. optional array of string urls
  5386. returns
  5387. # Array of cookie objects.
  5388. array of Cookie cookies
  5389. # Returns content served for the given request.
  5390. command getResponseBody
  5391. parameters
  5392. # Identifier of the network request to get content for.
  5393. RequestId requestId
  5394. returns
  5395. # Response body.
  5396. string body
  5397. # True, if content was sent as base64.
  5398. boolean base64Encoded
  5399. # Returns post data sent with the request. Returns an error when no data was sent with the request.
  5400. command getRequestPostData
  5401. parameters
  5402. # Identifier of the network request to get content for.
  5403. RequestId requestId
  5404. returns
  5405. # Request body string, omitting files from multipart requests
  5406. string postData
  5407. # Returns content served for the given currently intercepted request.
  5408. experimental command getResponseBodyForInterception
  5409. parameters
  5410. # Identifier for the intercepted request to get body for.
  5411. InterceptionId interceptionId
  5412. returns
  5413. # Response body.
  5414. string body
  5415. # True, if content was sent as base64.
  5416. boolean base64Encoded
  5417. # Returns a handle to the stream representing the response body. Note that after this command,
  5418. # the intercepted request can't be continued as is -- you either need to cancel it or to provide
  5419. # the response body. The stream only supports sequential read, IO.read will fail if the position
  5420. # is specified.
  5421. experimental command takeResponseBodyForInterceptionAsStream
  5422. parameters
  5423. InterceptionId interceptionId
  5424. returns
  5425. IO.StreamHandle stream
  5426. # This method sends a new XMLHttpRequest which is identical to the original one. The following
  5427. # parameters should be identical: method, url, async, request body, extra headers, withCredentials
  5428. # attribute, user, password.
  5429. experimental command replayXHR
  5430. parameters
  5431. # Identifier of XHR to replay.
  5432. RequestId requestId
  5433. # Searches for given string in response content.
  5434. experimental command searchInResponseBody
  5435. parameters
  5436. # Identifier of the network response to search.
  5437. RequestId requestId
  5438. # String to search for.
  5439. string query
  5440. # If true, search is case sensitive.
  5441. optional boolean caseSensitive
  5442. # If true, treats string parameter as regex.
  5443. optional boolean isRegex
  5444. returns
  5445. # List of search matches.
  5446. array of Debugger.SearchMatch result
  5447. # Blocks URLs from loading.
  5448. experimental command setBlockedURLs
  5449. parameters
  5450. # URL patterns to block. Wildcards ('*') are allowed.
  5451. array of string urls
  5452. # Toggles ignoring of service worker for each request.
  5453. experimental command setBypassServiceWorker
  5454. parameters
  5455. # Bypass service worker and load from network.
  5456. boolean bypass
  5457. # Toggles ignoring cache for each request. If `true`, cache will not be used.
  5458. command setCacheDisabled
  5459. parameters
  5460. # Cache disabled state.
  5461. boolean cacheDisabled
  5462. # Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
  5463. command setCookie
  5464. parameters
  5465. # Cookie name.
  5466. string name
  5467. # Cookie value.
  5468. string value
  5469. # The request-URI to associate with the setting of the cookie. This value can affect the
  5470. # default domain, path, source port, and source scheme values of the created cookie.
  5471. optional string url
  5472. # Cookie domain.
  5473. optional string domain
  5474. # Cookie path.
  5475. optional string path
  5476. # True if cookie is secure.
  5477. optional boolean secure
  5478. # True if cookie is http-only.
  5479. optional boolean httpOnly
  5480. # Cookie SameSite type.
  5481. optional CookieSameSite sameSite
  5482. # Cookie expiration date, session cookie if not set
  5483. optional TimeSinceEpoch expires
  5484. # Cookie Priority type.
  5485. experimental optional CookiePriority priority
  5486. # True if cookie is SameParty.
  5487. experimental optional boolean sameParty
  5488. # Cookie source scheme type.
  5489. experimental optional CookieSourceScheme sourceScheme
  5490. # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
  5491. # An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
  5492. # This is a temporary ability and it will be removed in the future.
  5493. experimental optional integer sourcePort
  5494. # Cookie partition key. The site of the top-level URL the browser was visiting at the start
  5495. # of the request to the endpoint that set the cookie.
  5496. # If not set, the cookie will be set as not partitioned.
  5497. experimental optional string partitionKey
  5498. returns
  5499. # Always set to true. If an error occurs, the response indicates protocol error.
  5500. deprecated boolean success
  5501. # Sets given cookies.
  5502. command setCookies
  5503. parameters
  5504. # Cookies to be set.
  5505. array of CookieParam cookies
  5506. # Specifies whether to always send extra HTTP headers with the requests from this page.
  5507. command setExtraHTTPHeaders
  5508. parameters
  5509. # Map with extra HTTP headers.
  5510. Headers headers
  5511. # Specifies whether to attach a page script stack id in requests
  5512. experimental command setAttachDebugStack
  5513. parameters
  5514. # Whether to attach a page script stack for debugging purpose.
  5515. boolean enabled
  5516. # Sets the requests to intercept that match the provided patterns and optionally resource types.
  5517. # Deprecated, please use Fetch.enable instead.
  5518. experimental deprecated command setRequestInterception
  5519. parameters
  5520. # Requests matching any of these patterns will be forwarded and wait for the corresponding
  5521. # continueInterceptedRequest call.
  5522. array of RequestPattern patterns
  5523. # Allows overriding user agent with the given string.
  5524. command setUserAgentOverride
  5525. redirect Emulation
  5526. parameters
  5527. # User agent to use.
  5528. string userAgent
  5529. # Browser langugage to emulate.
  5530. optional string acceptLanguage
  5531. # The platform navigator.platform should return.
  5532. optional string platform
  5533. # To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
  5534. experimental optional Emulation.UserAgentMetadata userAgentMetadata
  5535. # Fired when data chunk was received over the network.
  5536. event dataReceived
  5537. parameters
  5538. # Request identifier.
  5539. RequestId requestId
  5540. # Timestamp.
  5541. MonotonicTime timestamp
  5542. # Data chunk length.
  5543. integer dataLength
  5544. # Actual bytes received (might be less than dataLength for compressed encodings).
  5545. integer encodedDataLength
  5546. # Fired when EventSource message is received.
  5547. event eventSourceMessageReceived
  5548. parameters
  5549. # Request identifier.
  5550. RequestId requestId
  5551. # Timestamp.
  5552. MonotonicTime timestamp
  5553. # Message type.
  5554. string eventName
  5555. # Message identifier.
  5556. string eventId
  5557. # Message content.
  5558. string data
  5559. # Fired when HTTP request has failed to load.
  5560. event loadingFailed
  5561. parameters
  5562. # Request identifier.
  5563. RequestId requestId
  5564. # Timestamp.
  5565. MonotonicTime timestamp
  5566. # Resource type.
  5567. ResourceType type
  5568. # User friendly error message.
  5569. string errorText
  5570. # True if loading was canceled.
  5571. optional boolean canceled
  5572. # The reason why loading was blocked, if any.
  5573. optional BlockedReason blockedReason
  5574. # The reason why loading was blocked by CORS, if any.
  5575. optional CorsErrorStatus corsErrorStatus
  5576. # Fired when HTTP request has finished loading.
  5577. event loadingFinished
  5578. parameters
  5579. # Request identifier.
  5580. RequestId requestId
  5581. # Timestamp.
  5582. MonotonicTime timestamp
  5583. # Total number of bytes received for this request.
  5584. number encodedDataLength
  5585. # Set when 1) response was blocked by Cross-Origin Read Blocking and also
  5586. # 2) this needs to be reported to the DevTools console.
  5587. optional boolean shouldReportCorbBlocking
  5588. # Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
  5589. # mocked.
  5590. # Deprecated, use Fetch.requestPaused instead.
  5591. experimental deprecated event requestIntercepted
  5592. parameters
  5593. # Each request the page makes will have a unique id, however if any redirects are encountered
  5594. # while processing that fetch, they will be reported with the same id as the original fetch.
  5595. # Likewise if HTTP authentication is needed then the same fetch id will be used.
  5596. InterceptionId interceptionId
  5597. Request request
  5598. # The id of the frame that initiated the request.
  5599. Page.FrameId frameId
  5600. # How the requested resource will be used.
  5601. ResourceType resourceType
  5602. # Whether this is a navigation request, which can abort the navigation completely.
  5603. boolean isNavigationRequest
  5604. # Set if the request is a navigation that will result in a download.
  5605. # Only present after response is received from the server (i.e. HeadersReceived stage).
  5606. optional boolean isDownload
  5607. # Redirect location, only sent if a redirect was intercepted.
  5608. optional string redirectUrl
  5609. # Details of the Authorization Challenge encountered. If this is set then
  5610. # continueInterceptedRequest must contain an authChallengeResponse.
  5611. optional AuthChallenge authChallenge
  5612. # Response error if intercepted at response stage or if redirect occurred while intercepting
  5613. # request.
  5614. optional ErrorReason responseErrorReason
  5615. # Response code if intercepted at response stage or if redirect occurred while intercepting
  5616. # request or auth retry occurred.
  5617. optional integer responseStatusCode
  5618. # Response headers if intercepted at the response stage or if redirect occurred while
  5619. # intercepting request or auth retry occurred.
  5620. optional Headers responseHeaders
  5621. # If the intercepted request had a corresponding requestWillBeSent event fired for it, then
  5622. # this requestId will be the same as the requestId present in the requestWillBeSent event.
  5623. optional RequestId requestId
  5624. # Fired if request ended up loading from cache.
  5625. event requestServedFromCache
  5626. parameters
  5627. # Request identifier.
  5628. RequestId requestId
  5629. # Fired when page is about to send HTTP request.
  5630. event requestWillBeSent
  5631. parameters
  5632. # Request identifier.
  5633. RequestId requestId
  5634. # Loader identifier. Empty string if the request is fetched from worker.
  5635. LoaderId loaderId
  5636. # URL of the document this request is loaded for.
  5637. string documentURL
  5638. # Request data.
  5639. Request request
  5640. # Timestamp.
  5641. MonotonicTime timestamp
  5642. # Timestamp.
  5643. TimeSinceEpoch wallTime
  5644. # Request initiator.
  5645. Initiator initiator
  5646. # In the case that redirectResponse is populated, this flag indicates whether
  5647. # requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
  5648. # for the request which was just redirected.
  5649. experimental boolean redirectHasExtraInfo
  5650. # Redirect response data.
  5651. optional Response redirectResponse
  5652. # Type of this resource.
  5653. optional ResourceType type
  5654. # Frame identifier.
  5655. optional Page.FrameId frameId
  5656. # Whether the request is initiated by a user gesture. Defaults to false.
  5657. optional boolean hasUserGesture
  5658. # Fired when resource loading priority is changed
  5659. experimental event resourceChangedPriority
  5660. parameters
  5661. # Request identifier.
  5662. RequestId requestId
  5663. # New priority
  5664. ResourcePriority newPriority
  5665. # Timestamp.
  5666. MonotonicTime timestamp
  5667. # Fired when a signed exchange was received over the network
  5668. experimental event signedExchangeReceived
  5669. parameters
  5670. # Request identifier.
  5671. RequestId requestId
  5672. # Information about the signed exchange response.
  5673. SignedExchangeInfo info
  5674. # Fired when HTTP response is available.
  5675. event responseReceived
  5676. parameters
  5677. # Request identifier.
  5678. RequestId requestId
  5679. # Loader identifier. Empty string if the request is fetched from worker.
  5680. LoaderId loaderId
  5681. # Timestamp.
  5682. MonotonicTime timestamp
  5683. # Resource type.
  5684. ResourceType type
  5685. # Response data.
  5686. Response response
  5687. # Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
  5688. # or were emitted for this request.
  5689. experimental boolean hasExtraInfo
  5690. # Frame identifier.
  5691. optional Page.FrameId frameId
  5692. # Fired when WebSocket is closed.
  5693. event webSocketClosed
  5694. parameters
  5695. # Request identifier.
  5696. RequestId requestId
  5697. # Timestamp.
  5698. MonotonicTime timestamp
  5699. # Fired upon WebSocket creation.
  5700. event webSocketCreated
  5701. parameters
  5702. # Request identifier.
  5703. RequestId requestId
  5704. # WebSocket request URL.
  5705. string url
  5706. # Request initiator.
  5707. optional Initiator initiator
  5708. # Fired when WebSocket message error occurs.
  5709. event webSocketFrameError
  5710. parameters
  5711. # Request identifier.
  5712. RequestId requestId
  5713. # Timestamp.
  5714. MonotonicTime timestamp
  5715. # WebSocket error message.
  5716. string errorMessage
  5717. # Fired when WebSocket message is received.
  5718. event webSocketFrameReceived
  5719. parameters
  5720. # Request identifier.
  5721. RequestId requestId
  5722. # Timestamp.
  5723. MonotonicTime timestamp
  5724. # WebSocket response data.
  5725. WebSocketFrame response
  5726. # Fired when WebSocket message is sent.
  5727. event webSocketFrameSent
  5728. parameters
  5729. # Request identifier.
  5730. RequestId requestId
  5731. # Timestamp.
  5732. MonotonicTime timestamp
  5733. # WebSocket response data.
  5734. WebSocketFrame response
  5735. # Fired when WebSocket handshake response becomes available.
  5736. event webSocketHandshakeResponseReceived
  5737. parameters
  5738. # Request identifier.
  5739. RequestId requestId
  5740. # Timestamp.
  5741. MonotonicTime timestamp
  5742. # WebSocket response data.
  5743. WebSocketResponse response
  5744. # Fired when WebSocket is about to initiate handshake.
  5745. event webSocketWillSendHandshakeRequest
  5746. parameters
  5747. # Request identifier.
  5748. RequestId requestId
  5749. # Timestamp.
  5750. MonotonicTime timestamp
  5751. # UTC Timestamp.
  5752. TimeSinceEpoch wallTime
  5753. # WebSocket request data.
  5754. WebSocketRequest request
  5755. # Fired upon WebTransport creation.
  5756. event webTransportCreated
  5757. parameters
  5758. # WebTransport identifier.
  5759. RequestId transportId
  5760. # WebTransport request URL.
  5761. string url
  5762. # Timestamp.
  5763. MonotonicTime timestamp
  5764. # Request initiator.
  5765. optional Initiator initiator
  5766. # Fired when WebTransport handshake is finished.
  5767. event webTransportConnectionEstablished
  5768. parameters
  5769. # WebTransport identifier.
  5770. RequestId transportId
  5771. # Timestamp.
  5772. MonotonicTime timestamp
  5773. # Fired when WebTransport is disposed.
  5774. event webTransportClosed
  5775. parameters
  5776. # WebTransport identifier.
  5777. RequestId transportId
  5778. # Timestamp.
  5779. MonotonicTime timestamp
  5780. experimental type PrivateNetworkRequestPolicy extends string
  5781. enum
  5782. Allow
  5783. BlockFromInsecureToMorePrivate
  5784. WarnFromInsecureToMorePrivate
  5785. PreflightBlock
  5786. PreflightWarn
  5787. experimental type IPAddressSpace extends string
  5788. enum
  5789. Local
  5790. Private
  5791. Public
  5792. Unknown
  5793. experimental type ConnectTiming extends object
  5794. properties
  5795. # Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
  5796. # milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for
  5797. # the same request (but not for redirected requests).
  5798. number requestTime
  5799. experimental type ClientSecurityState extends object
  5800. properties
  5801. boolean initiatorIsSecureContext
  5802. IPAddressSpace initiatorIPAddressSpace
  5803. PrivateNetworkRequestPolicy privateNetworkRequestPolicy
  5804. # Fired when additional information about a requestWillBeSent event is available from the
  5805. # network stack. Not every requestWillBeSent event will have an additional
  5806. # requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent
  5807. # or requestWillBeSentExtraInfo will be fired first for the same request.
  5808. experimental event requestWillBeSentExtraInfo
  5809. parameters
  5810. # Request identifier. Used to match this information to an existing requestWillBeSent event.
  5811. RequestId requestId
  5812. # A list of cookies potentially associated to the requested URL. This includes both cookies sent with
  5813. # the request and the ones not sent; the latter are distinguished by having blockedReason field set.
  5814. array of BlockedCookieWithReason associatedCookies
  5815. # Raw request headers as they will be sent over the wire.
  5816. Headers headers
  5817. # Connection timing information for the request.
  5818. experimental ConnectTiming connectTiming
  5819. # The client security state set for the request.
  5820. optional ClientSecurityState clientSecurityState
  5821. # Whether the site has partitioned cookies stored in a partition different than the current one.
  5822. optional boolean siteHasCookieInOtherPartition
  5823. # Fired when additional information about a responseReceived event is available from the network
  5824. # stack. Not every responseReceived event will have an additional responseReceivedExtraInfo for
  5825. # it, and responseReceivedExtraInfo may be fired before or after responseReceived.
  5826. experimental event responseReceivedExtraInfo
  5827. parameters
  5828. # Request identifier. Used to match this information to another responseReceived event.
  5829. RequestId requestId
  5830. # A list of cookies which were not stored from the response along with the corresponding
  5831. # reasons for blocking. The cookies here may not be valid due to syntax errors, which
  5832. # are represented by the invalid cookie line string instead of a proper cookie.
  5833. array of BlockedSetCookieWithReason blockedCookies
  5834. # Raw response headers as they were received over the wire.
  5835. Headers headers
  5836. # The IP address space of the resource. The address space can only be determined once the transport
  5837. # established the connection, so we can't send it in `requestWillBeSentExtraInfo`.
  5838. IPAddressSpace resourceIPAddressSpace
  5839. # The status code of the response. This is useful in cases the request failed and no responseReceived
  5840. # event is triggered, which is the case for, e.g., CORS errors. This is also the correct status code
  5841. # for cached requests, where the status in responseReceived is a 200 and this will be 304.
  5842. integer statusCode
  5843. # Raw response header text as it was received over the wire. The raw text may not always be
  5844. # available, such as in the case of HTTP/2 or QUIC.
  5845. optional string headersText
  5846. # The cookie partition key that will be used to store partitioned cookies set in this response.
  5847. # Only sent when partitioned cookies are enabled.
  5848. optional string cookiePartitionKey
  5849. # True if partitioned cookies are enabled, but the partition key is not serializeable to string.
  5850. optional boolean cookiePartitionKeyOpaque
  5851. # Fired exactly once for each Trust Token operation. Depending on
  5852. # the type of the operation and whether the operation succeeded or
  5853. # failed, the event is fired before the corresponding request was sent
  5854. # or after the response was received.
  5855. experimental event trustTokenOperationDone
  5856. parameters
  5857. # Detailed success or error status of the operation.
  5858. # 'AlreadyExists' also signifies a successful operation, as the result
  5859. # of the operation already exists und thus, the operation was abort
  5860. # preemptively (e.g. a cache hit).
  5861. enum status
  5862. Ok
  5863. InvalidArgument
  5864. FailedPrecondition
  5865. ResourceExhausted
  5866. AlreadyExists
  5867. Unavailable
  5868. Unauthorized
  5869. BadResponse
  5870. InternalError
  5871. UnknownError
  5872. FulfilledLocally
  5873. TrustTokenOperationType type
  5874. RequestId requestId
  5875. # Top level origin. The context in which the operation was attempted.
  5876. optional string topLevelOrigin
  5877. # Origin of the issuer in case of a "Issuance" or "Redemption" operation.
  5878. optional string issuerOrigin
  5879. # The number of obtained Trust Tokens on a successful "Issuance" operation.
  5880. optional integer issuedTokenCount
  5881. # Fired once when parsing the .wbn file has succeeded.
  5882. # The event contains the information about the web bundle contents.
  5883. experimental event subresourceWebBundleMetadataReceived
  5884. parameters
  5885. # Request identifier. Used to match this information to another event.
  5886. RequestId requestId
  5887. # A list of URLs of resources in the subresource Web Bundle.
  5888. array of string urls
  5889. # Fired once when parsing the .wbn file has failed.
  5890. experimental event subresourceWebBundleMetadataError
  5891. parameters
  5892. # Request identifier. Used to match this information to another event.
  5893. RequestId requestId
  5894. # Error message
  5895. string errorMessage
  5896. # Fired when handling requests for resources within a .wbn file.
  5897. # Note: this will only be fired for resources that are requested by the webpage.
  5898. experimental event subresourceWebBundleInnerResponseParsed
  5899. parameters
  5900. # Request identifier of the subresource request
  5901. RequestId innerRequestId
  5902. # URL of the subresource resource.
  5903. string innerRequestURL
  5904. # Bundle request identifier. Used to match this information to another event.
  5905. # This made be absent in case when the instrumentation was enabled only
  5906. # after webbundle was parsed.
  5907. optional RequestId bundleRequestId
  5908. # Fired when request for resources within a .wbn file failed.
  5909. experimental event subresourceWebBundleInnerResponseError
  5910. parameters
  5911. # Request identifier of the subresource request
  5912. RequestId innerRequestId
  5913. # URL of the subresource resource.
  5914. string innerRequestURL
  5915. # Error message
  5916. string errorMessage
  5917. # Bundle request identifier. Used to match this information to another event.
  5918. # This made be absent in case when the instrumentation was enabled only
  5919. # after webbundle was parsed.
  5920. optional RequestId bundleRequestId
  5921. experimental type CrossOriginOpenerPolicyValue extends string
  5922. enum
  5923. SameOrigin
  5924. SameOriginAllowPopups
  5925. RestrictProperties
  5926. UnsafeNone
  5927. SameOriginPlusCoep
  5928. RestrictPropertiesPlusCoep
  5929. experimental type CrossOriginOpenerPolicyStatus extends object
  5930. properties
  5931. CrossOriginOpenerPolicyValue value
  5932. CrossOriginOpenerPolicyValue reportOnlyValue
  5933. optional string reportingEndpoint
  5934. optional string reportOnlyReportingEndpoint
  5935. experimental type CrossOriginEmbedderPolicyValue extends string
  5936. enum
  5937. None
  5938. Credentialless
  5939. RequireCorp
  5940. experimental type CrossOriginEmbedderPolicyStatus extends object
  5941. properties
  5942. CrossOriginEmbedderPolicyValue value
  5943. CrossOriginEmbedderPolicyValue reportOnlyValue
  5944. optional string reportingEndpoint
  5945. optional string reportOnlyReportingEndpoint
  5946. experimental type SecurityIsolationStatus extends object
  5947. properties
  5948. optional CrossOriginOpenerPolicyStatus coop
  5949. optional CrossOriginEmbedderPolicyStatus coep
  5950. # Returns information about the COEP/COOP isolation status.
  5951. experimental command getSecurityIsolationStatus
  5952. parameters
  5953. # If no frameId is provided, the status of the target is provided.
  5954. optional Page.FrameId frameId
  5955. returns
  5956. SecurityIsolationStatus status
  5957. # Enables tracking for the Reporting API, events generated by the Reporting API will now be delivered to the client.
  5958. # Enabling triggers 'reportingApiReportAdded' for all existing reports.
  5959. experimental command enableReportingApi
  5960. parameters
  5961. # Whether to enable or disable events for the Reporting API
  5962. boolean enable
  5963. # The status of a Reporting API report.
  5964. experimental type ReportStatus extends string
  5965. enum
  5966. # Report has been queued and no attempt has been made to deliver it yet,
  5967. # or attempted previous upload failed (impermanently).
  5968. Queued
  5969. # There is an ongoing attempt to upload this report.
  5970. Pending
  5971. # Deletion of this report was requested while it was pending, so it will
  5972. # be removed after possibly outstanding upload attempts complete (successful
  5973. # or not).
  5974. MarkedForRemoval
  5975. # Successfully uploaded and MarkedForRemoval.
  5976. Success
  5977. experimental type ReportId extends string
  5978. # An object representing a report generated by the Reporting API.
  5979. experimental type ReportingApiReport extends object
  5980. properties
  5981. ReportId id
  5982. # The URL of the document that triggered the report.
  5983. string initiatorUrl
  5984. # The name of the endpoint group that should be used to deliver the report.
  5985. string destination
  5986. # The type of the report (specifies the set of data that is contained in the report body).
  5987. string type
  5988. # When the report was generated.
  5989. Network.TimeSinceEpoch timestamp
  5990. # How many uploads deep the related request was.
  5991. integer depth
  5992. # The number of delivery attempts made so far, not including an active attempt.
  5993. integer completedAttempts
  5994. object body
  5995. ReportStatus status
  5996. # Is sent whenever a new report is added.
  5997. # And after 'enableReportingApi' for all existing reports.
  5998. experimental event reportingApiReportAdded
  5999. parameters
  6000. ReportingApiReport report
  6001. experimental event reportingApiReportUpdated
  6002. parameters
  6003. ReportingApiReport report
  6004. experimental type ReportingApiEndpoint extends object
  6005. properties
  6006. # The URL of the endpoint to which reports may be delivered.
  6007. string url
  6008. # Name of the endpoint group.
  6009. string groupName
  6010. experimental event reportingApiEndpointsChangedForOrigin
  6011. parameters
  6012. # Origin of the document(s) which configured the endpoints.
  6013. string origin
  6014. array of ReportingApiEndpoint endpoints
  6015. # An object providing the result of a network resource load.
  6016. experimental type LoadNetworkResourcePageResult extends object
  6017. properties
  6018. boolean success
  6019. # Optional values used for error reporting.
  6020. optional number netError
  6021. optional string netErrorName
  6022. optional number httpStatusCode
  6023. # If successful, one of the following two fields holds the result.
  6024. optional IO.StreamHandle stream
  6025. # Response headers.
  6026. optional Network.Headers headers
  6027. # An options object that may be extended later to better support CORS,
  6028. # CORB and streaming.
  6029. experimental type LoadNetworkResourceOptions extends object
  6030. properties
  6031. boolean disableCache
  6032. boolean includeCredentials
  6033. # Fetches the resource and returns the content.
  6034. experimental command loadNetworkResource
  6035. parameters
  6036. # Frame id to get the resource for. Mandatory for frame targets, and
  6037. # should be omitted for worker targets.
  6038. optional Page.FrameId frameId
  6039. # URL of the resource to get content for.
  6040. string url
  6041. # Options for the request.
  6042. LoadNetworkResourceOptions options
  6043. returns
  6044. LoadNetworkResourcePageResult resource
  6045. # This domain provides various functionality related to drawing atop the inspected page.
  6046. experimental domain Overlay
  6047. depends on DOM
  6048. depends on Page
  6049. depends on Runtime
  6050. # Configuration data for drawing the source order of an elements children.
  6051. type SourceOrderConfig extends object
  6052. properties
  6053. # the color to outline the givent element in.
  6054. DOM.RGBA parentOutlineColor
  6055. # the color to outline the child elements in.
  6056. DOM.RGBA childOutlineColor
  6057. # Configuration data for the highlighting of Grid elements.
  6058. type GridHighlightConfig extends object
  6059. properties
  6060. # Whether the extension lines from grid cells to the rulers should be shown (default: false).
  6061. optional boolean showGridExtensionLines
  6062. # Show Positive line number labels (default: false).
  6063. optional boolean showPositiveLineNumbers
  6064. # Show Negative line number labels (default: false).
  6065. optional boolean showNegativeLineNumbers
  6066. # Show area name labels (default: false).
  6067. optional boolean showAreaNames
  6068. # Show line name labels (default: false).
  6069. optional boolean showLineNames
  6070. # Show track size labels (default: false).
  6071. optional boolean showTrackSizes
  6072. # The grid container border highlight color (default: transparent).
  6073. optional DOM.RGBA gridBorderColor
  6074. # The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.
  6075. deprecated optional DOM.RGBA cellBorderColor
  6076. # The row line color (default: transparent).
  6077. optional DOM.RGBA rowLineColor
  6078. # The column line color (default: transparent).
  6079. optional DOM.RGBA columnLineColor
  6080. # Whether the grid border is dashed (default: false).
  6081. optional boolean gridBorderDash
  6082. # Whether the cell border is dashed (default: false). Deprecated, please us rowLineDash and columnLineDash instead.
  6083. deprecated optional boolean cellBorderDash
  6084. # Whether row lines are dashed (default: false).
  6085. optional boolean rowLineDash
  6086. # Whether column lines are dashed (default: false).
  6087. optional boolean columnLineDash
  6088. # The row gap highlight fill color (default: transparent).
  6089. optional DOM.RGBA rowGapColor
  6090. # The row gap hatching fill color (default: transparent).
  6091. optional DOM.RGBA rowHatchColor
  6092. # The column gap highlight fill color (default: transparent).
  6093. optional DOM.RGBA columnGapColor
  6094. # The column gap hatching fill color (default: transparent).
  6095. optional DOM.RGBA columnHatchColor
  6096. # The named grid areas border color (Default: transparent).
  6097. optional DOM.RGBA areaBorderColor
  6098. # The grid container background color (Default: transparent).
  6099. optional DOM.RGBA gridBackgroundColor
  6100. # Configuration data for the highlighting of Flex container elements.
  6101. type FlexContainerHighlightConfig extends object
  6102. properties
  6103. # The style of the container border
  6104. optional LineStyle containerBorder
  6105. # The style of the separator between lines
  6106. optional LineStyle lineSeparator
  6107. # The style of the separator between items
  6108. optional LineStyle itemSeparator
  6109. # Style of content-distribution space on the main axis (justify-content).
  6110. optional BoxStyle mainDistributedSpace
  6111. # Style of content-distribution space on the cross axis (align-content).
  6112. optional BoxStyle crossDistributedSpace
  6113. # Style of empty space caused by row gaps (gap/row-gap).
  6114. optional BoxStyle rowGapSpace
  6115. # Style of empty space caused by columns gaps (gap/column-gap).
  6116. optional BoxStyle columnGapSpace
  6117. # Style of the self-alignment line (align-items).
  6118. optional LineStyle crossAlignment
  6119. # Configuration data for the highlighting of Flex item elements.
  6120. type FlexItemHighlightConfig extends object
  6121. properties
  6122. # Style of the box representing the item's base size
  6123. optional BoxStyle baseSizeBox
  6124. # Style of the border around the box representing the item's base size
  6125. optional LineStyle baseSizeBorder
  6126. # Style of the arrow representing if the item grew or shrank
  6127. optional LineStyle flexibilityArrow
  6128. # Style information for drawing a line.
  6129. type LineStyle extends object
  6130. properties
  6131. # The color of the line (default: transparent)
  6132. optional DOM.RGBA color
  6133. # The line pattern (default: solid)
  6134. optional enum pattern
  6135. dashed
  6136. dotted
  6137. # Style information for drawing a box.
  6138. type BoxStyle extends object
  6139. properties
  6140. # The background color for the box (default: transparent)
  6141. optional DOM.RGBA fillColor
  6142. # The hatching color for the box (default: transparent)
  6143. optional DOM.RGBA hatchColor
  6144. type ContrastAlgorithm extends string
  6145. enum
  6146. aa
  6147. aaa
  6148. apca
  6149. # Configuration data for the highlighting of page elements.
  6150. type HighlightConfig extends object
  6151. properties
  6152. # Whether the node info tooltip should be shown (default: false).
  6153. optional boolean showInfo
  6154. # Whether the node styles in the tooltip (default: false).
  6155. optional boolean showStyles
  6156. # Whether the rulers should be shown (default: false).
  6157. optional boolean showRulers
  6158. # Whether the a11y info should be shown (default: true).
  6159. optional boolean showAccessibilityInfo
  6160. # Whether the extension lines from node to the rulers should be shown (default: false).
  6161. optional boolean showExtensionLines
  6162. # The content box highlight fill color (default: transparent).
  6163. optional DOM.RGBA contentColor
  6164. # The padding highlight fill color (default: transparent).
  6165. optional DOM.RGBA paddingColor
  6166. # The border highlight fill color (default: transparent).
  6167. optional DOM.RGBA borderColor
  6168. # The margin highlight fill color (default: transparent).
  6169. optional DOM.RGBA marginColor
  6170. # The event target element highlight fill color (default: transparent).
  6171. optional DOM.RGBA eventTargetColor
  6172. # The shape outside fill color (default: transparent).
  6173. optional DOM.RGBA shapeColor
  6174. # The shape margin fill color (default: transparent).
  6175. optional DOM.RGBA shapeMarginColor
  6176. # The grid layout color (default: transparent).
  6177. optional DOM.RGBA cssGridColor
  6178. # The color format used to format color styles (default: hex).
  6179. optional ColorFormat colorFormat
  6180. # The grid layout highlight configuration (default: all transparent).
  6181. optional GridHighlightConfig gridHighlightConfig
  6182. # The flex container highlight configuration (default: all transparent).
  6183. optional FlexContainerHighlightConfig flexContainerHighlightConfig
  6184. # The flex item highlight configuration (default: all transparent).
  6185. optional FlexItemHighlightConfig flexItemHighlightConfig
  6186. # The contrast algorithm to use for the contrast ratio (default: aa).
  6187. optional ContrastAlgorithm contrastAlgorithm
  6188. # The container query container highlight configuration (default: all transparent).
  6189. optional ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig
  6190. type ColorFormat extends string
  6191. enum
  6192. rgb
  6193. hsl
  6194. hwb
  6195. hex
  6196. # Configurations for Persistent Grid Highlight
  6197. type GridNodeHighlightConfig extends object
  6198. properties
  6199. # A descriptor for the highlight appearance.
  6200. GridHighlightConfig gridHighlightConfig
  6201. # Identifier of the node to highlight.
  6202. DOM.NodeId nodeId
  6203. type FlexNodeHighlightConfig extends object
  6204. properties
  6205. # A descriptor for the highlight appearance of flex containers.
  6206. FlexContainerHighlightConfig flexContainerHighlightConfig
  6207. # Identifier of the node to highlight.
  6208. DOM.NodeId nodeId
  6209. type ScrollSnapContainerHighlightConfig extends object
  6210. properties
  6211. # The style of the snapport border (default: transparent)
  6212. optional LineStyle snapportBorder
  6213. # The style of the snap area border (default: transparent)
  6214. optional LineStyle snapAreaBorder
  6215. # The margin highlight fill color (default: transparent).
  6216. optional DOM.RGBA scrollMarginColor
  6217. # The padding highlight fill color (default: transparent).
  6218. optional DOM.RGBA scrollPaddingColor
  6219. type ScrollSnapHighlightConfig extends object
  6220. properties
  6221. # A descriptor for the highlight appearance of scroll snap containers.
  6222. ScrollSnapContainerHighlightConfig scrollSnapContainerHighlightConfig
  6223. # Identifier of the node to highlight.
  6224. DOM.NodeId nodeId
  6225. # Configuration for dual screen hinge
  6226. type HingeConfig extends object
  6227. properties
  6228. # A rectangle represent hinge
  6229. DOM.Rect rect
  6230. # The content box highlight fill color (default: a dark color).
  6231. optional DOM.RGBA contentColor
  6232. # The content box highlight outline color (default: transparent).
  6233. optional DOM.RGBA outlineColor
  6234. type ContainerQueryHighlightConfig extends object
  6235. properties
  6236. # A descriptor for the highlight appearance of container query containers.
  6237. ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig
  6238. # Identifier of the container node to highlight.
  6239. DOM.NodeId nodeId
  6240. type ContainerQueryContainerHighlightConfig extends object
  6241. properties
  6242. # The style of the container border.
  6243. optional LineStyle containerBorder
  6244. # The style of the descendants' borders.
  6245. optional LineStyle descendantBorder
  6246. type IsolatedElementHighlightConfig extends object
  6247. properties
  6248. # A descriptor for the highlight appearance of an element in isolation mode.
  6249. IsolationModeHighlightConfig isolationModeHighlightConfig
  6250. # Identifier of the isolated element to highlight.
  6251. DOM.NodeId nodeId
  6252. type IsolationModeHighlightConfig extends object
  6253. properties
  6254. # The fill color of the resizers (default: transparent).
  6255. optional DOM.RGBA resizerColor
  6256. # The fill color for resizer handles (default: transparent).
  6257. optional DOM.RGBA resizerHandleColor
  6258. # The fill color for the mask covering non-isolated elements (default: transparent).
  6259. optional DOM.RGBA maskColor
  6260. type InspectMode extends string
  6261. enum
  6262. searchForNode
  6263. searchForUAShadowDOM
  6264. captureAreaScreenshot
  6265. showDistances
  6266. none
  6267. # Disables domain notifications.
  6268. command disable
  6269. # Enables domain notifications.
  6270. command enable
  6271. # For testing.
  6272. command getHighlightObjectForTest
  6273. parameters
  6274. # Id of the node to get highlight object for.
  6275. DOM.NodeId nodeId
  6276. # Whether to include distance info.
  6277. optional boolean includeDistance
  6278. # Whether to include style info.
  6279. optional boolean includeStyle
  6280. # The color format to get config with (default: hex).
  6281. optional ColorFormat colorFormat
  6282. # Whether to show accessibility info (default: true).
  6283. optional boolean showAccessibilityInfo
  6284. returns
  6285. # Highlight data for the node.
  6286. object highlight
  6287. # For Persistent Grid testing.
  6288. command getGridHighlightObjectsForTest
  6289. parameters
  6290. # Ids of the node to get highlight object for.
  6291. array of DOM.NodeId nodeIds
  6292. returns
  6293. # Grid Highlight data for the node ids provided.
  6294. object highlights
  6295. # For Source Order Viewer testing.
  6296. command getSourceOrderHighlightObjectForTest
  6297. parameters
  6298. # Id of the node to highlight.
  6299. DOM.NodeId nodeId
  6300. returns
  6301. # Source order highlight data for the node id provided.
  6302. object highlight
  6303. # Hides any highlight.
  6304. command hideHighlight
  6305. # Highlights owner element of the frame with given id.
  6306. # Deprecated: Doesn't work reliablity and cannot be fixed due to process
  6307. # separatation (the owner node might be in a different process). Determine
  6308. # the owner node in the client and use highlightNode.
  6309. deprecated command highlightFrame
  6310. parameters
  6311. # Identifier of the frame to highlight.
  6312. Page.FrameId frameId
  6313. # The content box highlight fill color (default: transparent).
  6314. optional DOM.RGBA contentColor
  6315. # The content box highlight outline color (default: transparent).
  6316. optional DOM.RGBA contentOutlineColor
  6317. # Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or
  6318. # objectId must be specified.
  6319. command highlightNode
  6320. parameters
  6321. # A descriptor for the highlight appearance.
  6322. HighlightConfig highlightConfig
  6323. # Identifier of the node to highlight.
  6324. optional DOM.NodeId nodeId
  6325. # Identifier of the backend node to highlight.
  6326. optional DOM.BackendNodeId backendNodeId
  6327. # JavaScript object id of the node to be highlighted.
  6328. optional Runtime.RemoteObjectId objectId
  6329. # Selectors to highlight relevant nodes.
  6330. optional string selector
  6331. # Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
  6332. command highlightQuad
  6333. parameters
  6334. # Quad to highlight
  6335. DOM.Quad quad
  6336. # The highlight fill color (default: transparent).
  6337. optional DOM.RGBA color
  6338. # The highlight outline color (default: transparent).
  6339. optional DOM.RGBA outlineColor
  6340. # Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
  6341. command highlightRect
  6342. parameters
  6343. # X coordinate
  6344. integer x
  6345. # Y coordinate
  6346. integer y
  6347. # Rectangle width
  6348. integer width
  6349. # Rectangle height
  6350. integer height
  6351. # The highlight fill color (default: transparent).
  6352. optional DOM.RGBA color
  6353. # The highlight outline color (default: transparent).
  6354. optional DOM.RGBA outlineColor
  6355. # Highlights the source order of the children of the DOM node with given id or with the given
  6356. # JavaScript object wrapper. Either nodeId or objectId must be specified.
  6357. command highlightSourceOrder
  6358. parameters
  6359. # A descriptor for the appearance of the overlay drawing.
  6360. SourceOrderConfig sourceOrderConfig
  6361. # Identifier of the node to highlight.
  6362. optional DOM.NodeId nodeId
  6363. # Identifier of the backend node to highlight.
  6364. optional DOM.BackendNodeId backendNodeId
  6365. # JavaScript object id of the node to be highlighted.
  6366. optional Runtime.RemoteObjectId objectId
  6367. # Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted.
  6368. # Backend then generates 'inspectNodeRequested' event upon element selection.
  6369. command setInspectMode
  6370. parameters
  6371. # Set an inspection mode.
  6372. InspectMode mode
  6373. # A descriptor for the highlight appearance of hovered-over nodes. May be omitted if `enabled
  6374. # == false`.
  6375. optional HighlightConfig highlightConfig
  6376. # Highlights owner element of all frames detected to be ads.
  6377. command setShowAdHighlights
  6378. parameters
  6379. # True for showing ad highlights
  6380. boolean show
  6381. command setPausedInDebuggerMessage
  6382. parameters
  6383. # The message to display, also triggers resume and step over controls.
  6384. optional string message
  6385. # Requests that backend shows debug borders on layers
  6386. command setShowDebugBorders
  6387. parameters
  6388. # True for showing debug borders
  6389. boolean show
  6390. # Requests that backend shows the FPS counter
  6391. command setShowFPSCounter
  6392. parameters
  6393. # True for showing the FPS counter
  6394. boolean show
  6395. # Highlight multiple elements with the CSS Grid overlay.
  6396. command setShowGridOverlays
  6397. parameters
  6398. # An array of node identifiers and descriptors for the highlight appearance.
  6399. array of GridNodeHighlightConfig gridNodeHighlightConfigs
  6400. command setShowFlexOverlays
  6401. parameters
  6402. # An array of node identifiers and descriptors for the highlight appearance.
  6403. array of FlexNodeHighlightConfig flexNodeHighlightConfigs
  6404. command setShowScrollSnapOverlays
  6405. parameters
  6406. # An array of node identifiers and descriptors for the highlight appearance.
  6407. array of ScrollSnapHighlightConfig scrollSnapHighlightConfigs
  6408. command setShowContainerQueryOverlays
  6409. parameters
  6410. # An array of node identifiers and descriptors for the highlight appearance.
  6411. array of ContainerQueryHighlightConfig containerQueryHighlightConfigs
  6412. # Requests that backend shows paint rectangles
  6413. command setShowPaintRects
  6414. parameters
  6415. # True for showing paint rectangles
  6416. boolean result
  6417. # Requests that backend shows layout shift regions
  6418. command setShowLayoutShiftRegions
  6419. parameters
  6420. # True for showing layout shift regions
  6421. boolean result
  6422. # Requests that backend shows scroll bottleneck rects
  6423. command setShowScrollBottleneckRects
  6424. parameters
  6425. # True for showing scroll bottleneck rects
  6426. boolean show
  6427. # Deprecated, no longer has any effect.
  6428. deprecated command setShowHitTestBorders
  6429. parameters
  6430. # True for showing hit-test borders
  6431. boolean show
  6432. # Request that backend shows an overlay with web vital metrics.
  6433. command setShowWebVitals
  6434. parameters
  6435. boolean show
  6436. # Paints viewport size upon main frame resize.
  6437. command setShowViewportSizeOnResize
  6438. parameters
  6439. # Whether to paint size or not.
  6440. boolean show
  6441. # Add a dual screen device hinge
  6442. command setShowHinge
  6443. parameters
  6444. # hinge data, null means hideHinge
  6445. optional HingeConfig hingeConfig
  6446. # Show elements in isolation mode with overlays.
  6447. command setShowIsolatedElements
  6448. parameters
  6449. # An array of node identifiers and descriptors for the highlight appearance.
  6450. array of IsolatedElementHighlightConfig isolatedElementHighlightConfigs
  6451. # Fired when the node should be inspected. This happens after call to `setInspectMode` or when
  6452. # user manually inspects an element.
  6453. event inspectNodeRequested
  6454. parameters
  6455. # Id of the node to inspect.
  6456. DOM.BackendNodeId backendNodeId
  6457. # Fired when the node should be highlighted. This happens after call to `setInspectMode`.
  6458. event nodeHighlightRequested
  6459. parameters
  6460. DOM.NodeId nodeId
  6461. # Fired when user asks to capture screenshot of some area on the page.
  6462. event screenshotRequested
  6463. parameters
  6464. # Viewport to capture, in device independent pixels (dip).
  6465. Page.Viewport viewport
  6466. # Fired when user cancels the inspect mode.
  6467. event inspectModeCanceled
  6468. # Actions and events related to the inspected page belong to the page domain.
  6469. domain Page
  6470. depends on Debugger
  6471. depends on DOM
  6472. depends on IO
  6473. depends on Network
  6474. depends on Runtime
  6475. # Unique frame identifier.
  6476. type FrameId extends string
  6477. # Indicates whether a frame has been identified as an ad.
  6478. experimental type AdFrameType extends string
  6479. enum
  6480. none
  6481. # This frame is a subframe of an ad frame.
  6482. child
  6483. # This frame is the root of an ad frame.
  6484. root
  6485. experimental type AdFrameExplanation extends string
  6486. enum
  6487. ParentIsAd
  6488. CreatedByAdScript
  6489. MatchedBlockingRule
  6490. # Indicates whether a frame has been identified as an ad and why.
  6491. experimental type AdFrameStatus extends object
  6492. properties
  6493. AdFrameType adFrameType
  6494. optional array of AdFrameExplanation explanations
  6495. # Identifies the bottom-most script which caused the frame to be labelled
  6496. # as an ad.
  6497. experimental type AdScriptId extends object
  6498. properties
  6499. # Script Id of the bottom-most script which caused the frame to be labelled
  6500. # as an ad.
  6501. Runtime.ScriptId scriptId
  6502. # Id of adScriptId's debugger.
  6503. Runtime.UniqueDebuggerId debuggerId
  6504. # Indicates whether the frame is a secure context and why it is the case.
  6505. experimental type SecureContextType extends string
  6506. enum
  6507. # The origin is a secure context.
  6508. Secure
  6509. # The host is localhost and hence is considered secure.
  6510. SecureLocalhost
  6511. # The origin has an insecure scheme and is not localhost.
  6512. InsecureScheme
  6513. # One of the ancestor frames is not a secure context.
  6514. InsecureAncestor
  6515. # Indicates whether the frame is cross-origin isolated and why it is the case.
  6516. experimental type CrossOriginIsolatedContextType extends string
  6517. enum
  6518. # The origin is cross-origin isolated.
  6519. Isolated
  6520. # The origin is not cross-origin isolated.
  6521. NotIsolated
  6522. # The cross-origin isolation feature is disabled.
  6523. NotIsolatedFeatureDisabled
  6524. experimental type GatedAPIFeatures extends string
  6525. enum
  6526. SharedArrayBuffers
  6527. SharedArrayBuffersTransferAllowed
  6528. PerformanceMeasureMemory
  6529. PerformanceProfile
  6530. # All Permissions Policy features. This enum should match the one defined
  6531. # in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.
  6532. experimental type PermissionsPolicyFeature extends string
  6533. enum
  6534. accelerometer
  6535. ambient-light-sensor
  6536. attribution-reporting
  6537. autoplay
  6538. bluetooth
  6539. browsing-topics
  6540. camera
  6541. ch-dpr
  6542. ch-device-memory
  6543. ch-downlink
  6544. ch-ect
  6545. ch-prefers-color-scheme
  6546. ch-prefers-reduced-motion
  6547. ch-rtt
  6548. ch-save-data
  6549. ch-ua
  6550. ch-ua-arch
  6551. ch-ua-bitness
  6552. ch-ua-platform
  6553. ch-ua-model
  6554. ch-ua-mobile
  6555. ch-ua-full
  6556. ch-ua-full-version
  6557. ch-ua-full-version-list
  6558. ch-ua-platform-version
  6559. ch-ua-reduced
  6560. ch-ua-wow64
  6561. ch-viewport-height
  6562. ch-viewport-width
  6563. ch-width
  6564. clipboard-read
  6565. clipboard-write
  6566. compute-pressure
  6567. cross-origin-isolated
  6568. direct-sockets
  6569. display-capture
  6570. document-domain
  6571. encrypted-media
  6572. execution-while-out-of-viewport
  6573. execution-while-not-rendered
  6574. focus-without-user-activation
  6575. fullscreen
  6576. frobulate
  6577. gamepad
  6578. geolocation
  6579. gyroscope
  6580. hid
  6581. identity-credentials-get
  6582. idle-detection
  6583. interest-cohort
  6584. join-ad-interest-group
  6585. keyboard-map
  6586. local-fonts
  6587. magnetometer
  6588. microphone
  6589. midi
  6590. otp-credentials
  6591. payment
  6592. picture-in-picture
  6593. private-aggregation
  6594. private-state-token-issuance
  6595. private-state-token-redemption
  6596. publickey-credentials-get
  6597. run-ad-auction
  6598. screen-wake-lock
  6599. serial
  6600. shared-autofill
  6601. shared-storage
  6602. shared-storage-select-url
  6603. smart-card
  6604. storage-access
  6605. sync-xhr
  6606. unload
  6607. usb
  6608. vertical-scroll
  6609. web-share
  6610. # Alias for 'window-placement' (crbug.com/1328581).
  6611. window-management
  6612. window-placement
  6613. xr-spatial-tracking
  6614. # Reason for a permissions policy feature to be disabled.
  6615. experimental type PermissionsPolicyBlockReason extends string
  6616. enum
  6617. # Declaration in HTTP header.
  6618. Header
  6619. # Declaration in iframe attribute.
  6620. IframeAttribute
  6621. # Inside fenced frame.
  6622. InFencedFrameTree
  6623. # Inside an Isolated Application.
  6624. InIsolatedApp
  6625. experimental type PermissionsPolicyBlockLocator extends object
  6626. properties
  6627. FrameId frameId
  6628. PermissionsPolicyBlockReason blockReason
  6629. experimental type PermissionsPolicyFeatureState extends object
  6630. properties
  6631. PermissionsPolicyFeature feature
  6632. boolean allowed
  6633. optional PermissionsPolicyBlockLocator locator
  6634. # Origin Trial(https://www.chromium.org/blink/origin-trials) support.
  6635. # Status for an Origin Trial token.
  6636. experimental type OriginTrialTokenStatus extends string
  6637. enum
  6638. Success
  6639. NotSupported
  6640. Insecure
  6641. Expired
  6642. WrongOrigin
  6643. InvalidSignature
  6644. Malformed
  6645. WrongVersion
  6646. FeatureDisabled
  6647. TokenDisabled
  6648. FeatureDisabledForUser
  6649. UnknownTrial
  6650. # Status for an Origin Trial.
  6651. experimental type OriginTrialStatus extends string
  6652. enum
  6653. Enabled
  6654. ValidTokenNotProvided
  6655. OSNotSupported
  6656. TrialNotAllowed
  6657. experimental type OriginTrialUsageRestriction extends string
  6658. enum
  6659. None
  6660. Subset
  6661. experimental type OriginTrialToken extends object
  6662. properties
  6663. string origin
  6664. boolean matchSubDomains
  6665. string trialName
  6666. Network.TimeSinceEpoch expiryTime
  6667. boolean isThirdParty
  6668. OriginTrialUsageRestriction usageRestriction
  6669. experimental type OriginTrialTokenWithStatus extends object
  6670. properties
  6671. string rawTokenText
  6672. # `parsedToken` is present only when the token is extractable and
  6673. # parsable.
  6674. optional OriginTrialToken parsedToken
  6675. OriginTrialTokenStatus status
  6676. experimental type OriginTrial extends object
  6677. properties
  6678. string trialName
  6679. OriginTrialStatus status
  6680. array of OriginTrialTokenWithStatus tokensWithStatus
  6681. # Information about the Frame on the page.
  6682. type Frame extends object
  6683. properties
  6684. # Frame unique identifier.
  6685. FrameId id
  6686. # Parent frame identifier.
  6687. optional FrameId parentId
  6688. # Identifier of the loader associated with this frame.
  6689. Network.LoaderId loaderId
  6690. # Frame's name as specified in the tag.
  6691. optional string name
  6692. # Frame document's URL without fragment.
  6693. string url
  6694. # Frame document's URL fragment including the '#'.
  6695. experimental optional string urlFragment
  6696. # Frame document's registered domain, taking the public suffixes list into account.
  6697. # Extracted from the Frame's url.
  6698. # Example URLs: http://www.google.com/file.html -> "google.com"
  6699. # http://a.b.co.uk/file.html -> "b.co.uk"
  6700. experimental string domainAndRegistry
  6701. # Frame document's security origin.
  6702. string securityOrigin
  6703. # Frame document's mimeType as determined by the browser.
  6704. string mimeType
  6705. # If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.
  6706. experimental optional string unreachableUrl
  6707. # Indicates whether this frame was tagged as an ad and why.
  6708. experimental optional AdFrameStatus adFrameStatus
  6709. # Indicates whether the main document is a secure context and explains why that is the case.
  6710. experimental SecureContextType secureContextType
  6711. # Indicates whether this is a cross origin isolated context.
  6712. experimental CrossOriginIsolatedContextType crossOriginIsolatedContextType
  6713. # Indicated which gated APIs / features are available.
  6714. experimental array of GatedAPIFeatures gatedAPIFeatures
  6715. # Information about the Resource on the page.
  6716. experimental type FrameResource extends object
  6717. properties
  6718. # Resource URL.
  6719. string url
  6720. # Type of this resource.
  6721. Network.ResourceType type
  6722. # Resource mimeType as determined by the browser.
  6723. string mimeType
  6724. # last-modified timestamp as reported by server.
  6725. optional Network.TimeSinceEpoch lastModified
  6726. # Resource content size.
  6727. optional number contentSize
  6728. # True if the resource failed to load.
  6729. optional boolean failed
  6730. # True if the resource was canceled during loading.
  6731. optional boolean canceled
  6732. # Information about the Frame hierarchy along with their cached resources.
  6733. experimental type FrameResourceTree extends object
  6734. properties
  6735. # Frame information for this tree item.
  6736. Frame frame
  6737. # Child frames.
  6738. optional array of FrameResourceTree childFrames
  6739. # Information about frame resources.
  6740. array of FrameResource resources
  6741. # Information about the Frame hierarchy.
  6742. type FrameTree extends object
  6743. properties
  6744. # Frame information for this tree item.
  6745. Frame frame
  6746. # Child frames.
  6747. optional array of FrameTree childFrames
  6748. # Unique script identifier.
  6749. type ScriptIdentifier extends string
  6750. # Transition type.
  6751. type TransitionType extends string
  6752. enum
  6753. link
  6754. typed
  6755. address_bar
  6756. auto_bookmark
  6757. auto_subframe
  6758. manual_subframe
  6759. generated
  6760. auto_toplevel
  6761. form_submit
  6762. reload
  6763. keyword
  6764. keyword_generated
  6765. other
  6766. # Navigation history entry.
  6767. type NavigationEntry extends object
  6768. properties
  6769. # Unique id of the navigation history entry.
  6770. integer id
  6771. # URL of the navigation history entry.
  6772. string url
  6773. # URL that the user typed in the url bar.
  6774. string userTypedURL
  6775. # Title of the navigation history entry.
  6776. string title
  6777. # Transition type.
  6778. TransitionType transitionType
  6779. # Screencast frame metadata.
  6780. experimental type ScreencastFrameMetadata extends object
  6781. properties
  6782. # Top offset in DIP.
  6783. number offsetTop
  6784. # Page scale factor.
  6785. number pageScaleFactor
  6786. # Device screen width in DIP.
  6787. number deviceWidth
  6788. # Device screen height in DIP.
  6789. number deviceHeight
  6790. # Position of horizontal scroll in CSS pixels.
  6791. number scrollOffsetX
  6792. # Position of vertical scroll in CSS pixels.
  6793. number scrollOffsetY
  6794. # Frame swap timestamp.
  6795. optional Network.TimeSinceEpoch timestamp
  6796. # Javascript dialog type.
  6797. type DialogType extends string
  6798. enum
  6799. alert
  6800. confirm
  6801. prompt
  6802. beforeunload
  6803. # Error while paring app manifest.
  6804. type AppManifestError extends object
  6805. properties
  6806. # Error message.
  6807. string message
  6808. # If criticial, this is a non-recoverable parse error.
  6809. integer critical
  6810. # Error line.
  6811. integer line
  6812. # Error column.
  6813. integer column
  6814. # Parsed app manifest properties.
  6815. experimental type AppManifestParsedProperties extends object
  6816. properties
  6817. # Computed scope value
  6818. string scope
  6819. # Layout viewport position and dimensions.
  6820. type LayoutViewport extends object
  6821. properties
  6822. # Horizontal offset relative to the document (CSS pixels).
  6823. integer pageX
  6824. # Vertical offset relative to the document (CSS pixels).
  6825. integer pageY
  6826. # Width (CSS pixels), excludes scrollbar if present.
  6827. integer clientWidth
  6828. # Height (CSS pixels), excludes scrollbar if present.
  6829. integer clientHeight
  6830. # Visual viewport position, dimensions, and scale.
  6831. type VisualViewport extends object
  6832. properties
  6833. # Horizontal offset relative to the layout viewport (CSS pixels).
  6834. number offsetX
  6835. # Vertical offset relative to the layout viewport (CSS pixels).
  6836. number offsetY
  6837. # Horizontal offset relative to the document (CSS pixels).
  6838. number pageX
  6839. # Vertical offset relative to the document (CSS pixels).
  6840. number pageY
  6841. # Width (CSS pixels), excludes scrollbar if present.
  6842. number clientWidth
  6843. # Height (CSS pixels), excludes scrollbar if present.
  6844. number clientHeight
  6845. # Scale relative to the ideal viewport (size at width=device-width).
  6846. number scale
  6847. # Page zoom factor (CSS to device independent pixels ratio).
  6848. optional number zoom
  6849. # Viewport for capturing screenshot.
  6850. type Viewport extends object
  6851. properties
  6852. # X offset in device independent pixels (dip).
  6853. number x
  6854. # Y offset in device independent pixels (dip).
  6855. number y
  6856. # Rectangle width in device independent pixels (dip).
  6857. number width
  6858. # Rectangle height in device independent pixels (dip).
  6859. number height
  6860. # Page scale factor.
  6861. number scale
  6862. # Generic font families collection.
  6863. experimental type FontFamilies extends object
  6864. properties
  6865. # The standard font-family.
  6866. optional string standard
  6867. # The fixed font-family.
  6868. optional string fixed
  6869. # The serif font-family.
  6870. optional string serif
  6871. # The sansSerif font-family.
  6872. optional string sansSerif
  6873. # The cursive font-family.
  6874. optional string cursive
  6875. # The fantasy font-family.
  6876. optional string fantasy
  6877. # The math font-family.
  6878. optional string math
  6879. # Font families collection for a script.
  6880. experimental type ScriptFontFamilies extends object
  6881. properties
  6882. # Name of the script which these font families are defined for.
  6883. string script
  6884. # Generic font families collection for the script.
  6885. FontFamilies fontFamilies
  6886. # Default font sizes.
  6887. experimental type FontSizes extends object
  6888. properties
  6889. # Default standard font size.
  6890. optional integer standard
  6891. # Default fixed font size.
  6892. optional integer fixed
  6893. experimental type ClientNavigationReason extends string
  6894. enum
  6895. formSubmissionGet
  6896. formSubmissionPost
  6897. httpHeaderRefresh
  6898. scriptInitiated
  6899. metaTagRefresh
  6900. pageBlockInterstitial
  6901. reload
  6902. anchorClick
  6903. experimental type ClientNavigationDisposition extends string
  6904. enum
  6905. currentTab
  6906. newTab
  6907. newWindow
  6908. download
  6909. experimental type InstallabilityErrorArgument extends object
  6910. properties
  6911. # Argument name (e.g. name:'minimum-icon-size-in-pixels').
  6912. string name
  6913. # Argument value (e.g. value:'64').
  6914. string value
  6915. # The installability error
  6916. experimental type InstallabilityError extends object
  6917. properties
  6918. # The error id (e.g. 'manifest-missing-suitable-icon').
  6919. string errorId
  6920. # The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).
  6921. array of InstallabilityErrorArgument errorArguments
  6922. # The referring-policy used for the navigation.
  6923. experimental type ReferrerPolicy extends string
  6924. enum
  6925. noReferrer
  6926. noReferrerWhenDowngrade
  6927. origin
  6928. originWhenCrossOrigin
  6929. sameOrigin
  6930. strictOrigin
  6931. strictOriginWhenCrossOrigin
  6932. unsafeUrl
  6933. # Per-script compilation cache parameters for `Page.produceCompilationCache`
  6934. experimental type CompilationCacheParams extends object
  6935. properties
  6936. # The URL of the script to produce a compilation cache entry for.
  6937. string url
  6938. # A hint to the backend whether eager compilation is recommended.
  6939. # (the actual compilation mode used is upon backend discretion).
  6940. optional boolean eager
  6941. # Deprecated, please use addScriptToEvaluateOnNewDocument instead.
  6942. experimental deprecated command addScriptToEvaluateOnLoad
  6943. parameters
  6944. string scriptSource
  6945. returns
  6946. # Identifier of the added script.
  6947. ScriptIdentifier identifier
  6948. # Evaluates given script in every frame upon creation (before loading frame's scripts).
  6949. command addScriptToEvaluateOnNewDocument
  6950. parameters
  6951. string source
  6952. # If specified, creates an isolated world with the given name and evaluates given script in it.
  6953. # This world name will be used as the ExecutionContextDescription::name when the corresponding
  6954. # event is emitted.
  6955. experimental optional string worldName
  6956. # Specifies whether command line API should be available to the script, defaults
  6957. # to false.
  6958. experimental optional boolean includeCommandLineAPI
  6959. returns
  6960. # Identifier of the added script.
  6961. ScriptIdentifier identifier
  6962. # Brings page to front (activates tab).
  6963. command bringToFront
  6964. # Capture page screenshot.
  6965. command captureScreenshot
  6966. parameters
  6967. # Image compression format (defaults to png).
  6968. optional enum format
  6969. jpeg
  6970. png
  6971. webp
  6972. # Compression quality from range [0..100] (jpeg only).
  6973. optional integer quality
  6974. # Capture the screenshot of a given region only.
  6975. optional Viewport clip
  6976. # Capture the screenshot from the surface, rather than the view. Defaults to true.
  6977. experimental optional boolean fromSurface
  6978. # Capture the screenshot beyond the viewport. Defaults to false.
  6979. experimental optional boolean captureBeyondViewport
  6980. # Optimize image encoding for speed, not for resulting size (defaults to false)
  6981. experimental optional boolean optimizeForSpeed
  6982. returns
  6983. # Base64-encoded image data.
  6984. binary data
  6985. # Returns a snapshot of the page as a string. For MHTML format, the serialization includes
  6986. # iframes, shadow DOM, external resources, and element-inline styles.
  6987. experimental command captureSnapshot
  6988. parameters
  6989. # Format (defaults to mhtml).
  6990. optional enum format
  6991. mhtml
  6992. returns
  6993. # Serialized page data.
  6994. string data
  6995. # Clears the overridden device metrics.
  6996. experimental deprecated command clearDeviceMetricsOverride
  6997. # Use 'Emulation.clearDeviceMetricsOverride' instead
  6998. redirect Emulation
  6999. # Clears the overridden Device Orientation.
  7000. experimental deprecated command clearDeviceOrientationOverride
  7001. # Use 'DeviceOrientation.clearDeviceOrientationOverride' instead
  7002. redirect DeviceOrientation
  7003. # Clears the overridden Geolocation Position and Error.
  7004. deprecated command clearGeolocationOverride
  7005. # Use 'Emulation.clearGeolocationOverride' instead
  7006. redirect Emulation
  7007. # Creates an isolated world for the given frame.
  7008. command createIsolatedWorld
  7009. parameters
  7010. # Id of the frame in which the isolated world should be created.
  7011. FrameId frameId
  7012. # An optional name which is reported in the Execution Context.
  7013. optional string worldName
  7014. # Whether or not universal access should be granted to the isolated world. This is a powerful
  7015. # option, use with caution.
  7016. optional boolean grantUniveralAccess
  7017. returns
  7018. # Execution context of the isolated world.
  7019. Runtime.ExecutionContextId executionContextId
  7020. # Deletes browser cookie with given name, domain and path.
  7021. experimental deprecated command deleteCookie
  7022. # Use 'Network.deleteCookie' instead
  7023. redirect Network
  7024. parameters
  7025. # Name of the cookie to remove.
  7026. string cookieName
  7027. # URL to match cooke domain and path.
  7028. string url
  7029. # Disables page domain notifications.
  7030. command disable
  7031. # Enables page domain notifications.
  7032. command enable
  7033. command getAppManifest
  7034. returns
  7035. # Manifest location.
  7036. string url
  7037. array of AppManifestError errors
  7038. # Manifest content.
  7039. optional string data
  7040. # Parsed manifest properties
  7041. experimental optional AppManifestParsedProperties parsed
  7042. experimental command getInstallabilityErrors
  7043. returns
  7044. array of InstallabilityError installabilityErrors
  7045. # Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.
  7046. experimental deprecated command getManifestIcons
  7047. returns
  7048. optional binary primaryIcon
  7049. # Returns the unique (PWA) app id.
  7050. # Only returns values if the feature flag 'WebAppEnableManifestId' is enabled
  7051. experimental command getAppId
  7052. returns
  7053. # App id, either from manifest's id attribute or computed from start_url
  7054. optional string appId
  7055. # Recommendation for manifest's id attribute to match current id computed from start_url
  7056. optional string recommendedId
  7057. experimental command getAdScriptId
  7058. parameters
  7059. FrameId frameId
  7060. returns
  7061. # Identifies the bottom-most script which caused the frame to be labelled
  7062. # as an ad. Only sent if frame is labelled as an ad and id is available.
  7063. optional AdScriptId adScriptId
  7064. # Returns all browser cookies for the page and all of its subframes. Depending
  7065. # on the backend support, will return detailed cookie information in the
  7066. # `cookies` field.
  7067. experimental deprecated command getCookies
  7068. # Use 'Network.getCookies' instead
  7069. redirect Network
  7070. returns
  7071. # Array of cookie objects.
  7072. array of Network.Cookie cookies
  7073. # Returns present frame tree structure.
  7074. command getFrameTree
  7075. returns
  7076. # Present frame tree structure.
  7077. FrameTree frameTree
  7078. # Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
  7079. command getLayoutMetrics
  7080. returns
  7081. # Deprecated metrics relating to the layout viewport. Is in device pixels. Use `cssLayoutViewport` instead.
  7082. deprecated LayoutViewport layoutViewport
  7083. # Deprecated metrics relating to the visual viewport. Is in device pixels. Use `cssVisualViewport` instead.
  7084. deprecated VisualViewport visualViewport
  7085. # Deprecated size of scrollable area. Is in DP. Use `cssContentSize` instead.
  7086. deprecated DOM.Rect contentSize
  7087. # Metrics relating to the layout viewport in CSS pixels.
  7088. LayoutViewport cssLayoutViewport
  7089. # Metrics relating to the visual viewport in CSS pixels.
  7090. VisualViewport cssVisualViewport
  7091. # Size of scrollable area in CSS pixels.
  7092. DOM.Rect cssContentSize
  7093. # Returns navigation history for the current page.
  7094. command getNavigationHistory
  7095. returns
  7096. # Index of the current navigation history entry.
  7097. integer currentIndex
  7098. # Array of navigation history entries.
  7099. array of NavigationEntry entries
  7100. # Resets navigation history for the current page.
  7101. command resetNavigationHistory
  7102. # Returns content of the given resource.
  7103. experimental command getResourceContent
  7104. parameters
  7105. # Frame id to get resource for.
  7106. FrameId frameId
  7107. # URL of the resource to get content for.
  7108. string url
  7109. returns
  7110. # Resource content.
  7111. string content
  7112. # True, if content was served as base64.
  7113. boolean base64Encoded
  7114. # Returns present frame / resource tree structure.
  7115. experimental command getResourceTree
  7116. returns
  7117. # Present frame / resource tree structure.
  7118. FrameResourceTree frameTree
  7119. # Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
  7120. command handleJavaScriptDialog
  7121. parameters
  7122. # Whether to accept or dismiss the dialog.
  7123. boolean accept
  7124. # The text to enter into the dialog prompt before accepting. Used only if this is a prompt
  7125. # dialog.
  7126. optional string promptText
  7127. # Navigates current page to the given URL.
  7128. command navigate
  7129. parameters
  7130. # URL to navigate the page to.
  7131. string url
  7132. # Referrer URL.
  7133. optional string referrer
  7134. # Intended transition type.
  7135. optional TransitionType transitionType
  7136. # Frame id to navigate, if not specified navigates the top frame.
  7137. optional FrameId frameId
  7138. # Referrer-policy used for the navigation.
  7139. experimental optional ReferrerPolicy referrerPolicy
  7140. returns
  7141. # Frame id that has navigated (or failed to navigate)
  7142. FrameId frameId
  7143. # Loader identifier. This is omitted in case of same-document navigation,
  7144. # as the previously committed loaderId would not change.
  7145. optional Network.LoaderId loaderId
  7146. # User friendly error message, present if and only if navigation has failed.
  7147. optional string errorText
  7148. # Navigates current page to the given history entry.
  7149. command navigateToHistoryEntry
  7150. parameters
  7151. # Unique id of the entry to navigate to.
  7152. integer entryId
  7153. # Print page as PDF.
  7154. command printToPDF
  7155. parameters
  7156. # Paper orientation. Defaults to false.
  7157. optional boolean landscape
  7158. # Display header and footer. Defaults to false.
  7159. optional boolean displayHeaderFooter
  7160. # Print background graphics. Defaults to false.
  7161. optional boolean printBackground
  7162. # Scale of the webpage rendering. Defaults to 1.
  7163. optional number scale
  7164. # Paper width in inches. Defaults to 8.5 inches.
  7165. optional number paperWidth
  7166. # Paper height in inches. Defaults to 11 inches.
  7167. optional number paperHeight
  7168. # Top margin in inches. Defaults to 1cm (~0.4 inches).
  7169. optional number marginTop
  7170. # Bottom margin in inches. Defaults to 1cm (~0.4 inches).
  7171. optional number marginBottom
  7172. # Left margin in inches. Defaults to 1cm (~0.4 inches).
  7173. optional number marginLeft
  7174. # Right margin in inches. Defaults to 1cm (~0.4 inches).
  7175. optional number marginRight
  7176. # Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are
  7177. # printed in the document order, not in the order specified, and no
  7178. # more than once.
  7179. # Defaults to empty string, which implies the entire document is printed.
  7180. # The page numbers are quietly capped to actual page count of the
  7181. # document, and ranges beyond the end of the document are ignored.
  7182. # If this results in no pages to print, an error is reported.
  7183. # It is an error to specify a range with start greater than end.
  7184. optional string pageRanges
  7185. # HTML template for the print header. Should be valid HTML markup with following
  7186. # classes used to inject printing values into them:
  7187. # - `date`: formatted print date
  7188. # - `title`: document title
  7189. # - `url`: document location
  7190. # - `pageNumber`: current page number
  7191. # - `totalPages`: total pages in the document
  7192. #
  7193. # For example, `<span class=title></span>` would generate span containing the title.
  7194. optional string headerTemplate
  7195. # HTML template for the print footer. Should use the same format as the `headerTemplate`.
  7196. optional string footerTemplate
  7197. # Whether or not to prefer page size as defined by css. Defaults to false,
  7198. # in which case the content will be scaled to fit the paper size.
  7199. optional boolean preferCSSPageSize
  7200. # return as stream
  7201. experimental optional enum transferMode
  7202. ReturnAsBase64
  7203. ReturnAsStream
  7204. returns
  7205. # Base64-encoded pdf data. Empty if |returnAsStream| is specified.
  7206. binary data
  7207. # A handle of the stream that holds resulting PDF data.
  7208. experimental optional IO.StreamHandle stream
  7209. # Reloads given page optionally ignoring the cache.
  7210. command reload
  7211. parameters
  7212. # If true, browser cache is ignored (as if the user pressed Shift+refresh).
  7213. optional boolean ignoreCache
  7214. # If set, the script will be injected into all frames of the inspected page after reload.
  7215. # Argument will be ignored if reloading dataURL origin.
  7216. optional string scriptToEvaluateOnLoad
  7217. # Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
  7218. experimental deprecated command removeScriptToEvaluateOnLoad
  7219. parameters
  7220. ScriptIdentifier identifier
  7221. # Removes given script from the list.
  7222. command removeScriptToEvaluateOnNewDocument
  7223. parameters
  7224. ScriptIdentifier identifier
  7225. # Acknowledges that a screencast frame has been received by the frontend.
  7226. experimental command screencastFrameAck
  7227. parameters
  7228. # Frame number.
  7229. integer sessionId
  7230. # Searches for given string in resource content.
  7231. experimental command searchInResource
  7232. parameters
  7233. # Frame id for resource to search in.
  7234. FrameId frameId
  7235. # URL of the resource to search in.
  7236. string url
  7237. # String to search for.
  7238. string query
  7239. # If true, search is case sensitive.
  7240. optional boolean caseSensitive
  7241. # If true, treats string parameter as regex.
  7242. optional boolean isRegex
  7243. returns
  7244. # List of search matches.
  7245. array of Debugger.SearchMatch result
  7246. # Enable Chrome's experimental ad filter on all sites.
  7247. experimental command setAdBlockingEnabled
  7248. parameters
  7249. # Whether to block ads.
  7250. boolean enabled
  7251. # Enable page Content Security Policy by-passing.
  7252. experimental command setBypassCSP
  7253. parameters
  7254. # Whether to bypass page CSP.
  7255. boolean enabled
  7256. # Get Permissions Policy state on given frame.
  7257. experimental command getPermissionsPolicyState
  7258. parameters
  7259. FrameId frameId
  7260. returns
  7261. array of PermissionsPolicyFeatureState states
  7262. # Get Origin Trials on given frame.
  7263. experimental command getOriginTrials
  7264. parameters
  7265. FrameId frameId
  7266. returns
  7267. array of OriginTrial originTrials
  7268. # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
  7269. # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
  7270. # query results).
  7271. experimental deprecated command setDeviceMetricsOverride
  7272. # Use 'Emulation.setDeviceMetricsOverride' instead
  7273. redirect Emulation
  7274. parameters
  7275. # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  7276. integer width
  7277. # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  7278. integer height
  7279. # Overriding device scale factor value. 0 disables the override.
  7280. number deviceScaleFactor
  7281. # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
  7282. # autosizing and more.
  7283. boolean mobile
  7284. # Scale to apply to resulting view image.
  7285. optional number scale
  7286. # Overriding screen width value in pixels (minimum 0, maximum 10000000).
  7287. optional integer screenWidth
  7288. # Overriding screen height value in pixels (minimum 0, maximum 10000000).
  7289. optional integer screenHeight
  7290. # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
  7291. optional integer positionX
  7292. # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
  7293. optional integer positionY
  7294. # Do not set visible view size, rely upon explicit setVisibleSize call.
  7295. optional boolean dontSetVisibleSize
  7296. # Screen orientation override.
  7297. optional Emulation.ScreenOrientation screenOrientation
  7298. # The viewport dimensions and scale. If not set, the override is cleared.
  7299. optional Viewport viewport
  7300. # Overrides the Device Orientation.
  7301. experimental deprecated command setDeviceOrientationOverride
  7302. # Use 'DeviceOrientation.setDeviceOrientationOverride' instead
  7303. redirect DeviceOrientation
  7304. parameters
  7305. # Mock alpha
  7306. number alpha
  7307. # Mock beta
  7308. number beta
  7309. # Mock gamma
  7310. number gamma
  7311. # Set generic font families.
  7312. experimental command setFontFamilies
  7313. parameters
  7314. # Specifies font families to set. If a font family is not specified, it won't be changed.
  7315. FontFamilies fontFamilies
  7316. # Specifies font families to set for individual scripts.
  7317. optional array of ScriptFontFamilies forScripts
  7318. # Set default font sizes.
  7319. experimental command setFontSizes
  7320. parameters
  7321. # Specifies font sizes to set. If a font size is not specified, it won't be changed.
  7322. FontSizes fontSizes
  7323. # Sets given markup as the document's HTML.
  7324. command setDocumentContent
  7325. parameters
  7326. # Frame id to set HTML for.
  7327. FrameId frameId
  7328. # HTML content to set.
  7329. string html
  7330. # Set the behavior when downloading a file.
  7331. experimental deprecated command setDownloadBehavior
  7332. parameters
  7333. # Whether to allow all or deny all download requests, or use default Chrome behavior if
  7334. # available (otherwise deny).
  7335. enum behavior
  7336. deny
  7337. allow
  7338. default
  7339. # The default path to save downloaded files to. This is required if behavior is set to 'allow'
  7340. optional string downloadPath
  7341. # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
  7342. # unavailable.
  7343. deprecated command setGeolocationOverride
  7344. # Use 'Emulation.setGeolocationOverride' instead
  7345. redirect Emulation
  7346. parameters
  7347. # Mock latitude
  7348. optional number latitude
  7349. # Mock longitude
  7350. optional number longitude
  7351. # Mock accuracy
  7352. optional number accuracy
  7353. # Controls whether page will emit lifecycle events.
  7354. experimental command setLifecycleEventsEnabled
  7355. parameters
  7356. # If true, starts emitting lifecycle events.
  7357. boolean enabled
  7358. # Toggles mouse event-based touch event emulation.
  7359. experimental deprecated command setTouchEmulationEnabled
  7360. # Use 'Emulation.setTouchEmulationEnabled' instead
  7361. redirect Emulation
  7362. parameters
  7363. # Whether the touch event emulation should be enabled.
  7364. boolean enabled
  7365. # Touch/gesture events configuration. Default: current platform.
  7366. optional enum configuration
  7367. mobile
  7368. desktop
  7369. # Starts sending each frame using the `screencastFrame` event.
  7370. experimental command startScreencast
  7371. parameters
  7372. # Image compression format.
  7373. optional enum format
  7374. jpeg
  7375. png
  7376. # Compression quality from range [0..100].
  7377. optional integer quality
  7378. # Maximum screenshot width.
  7379. optional integer maxWidth
  7380. # Maximum screenshot height.
  7381. optional integer maxHeight
  7382. # Send every n-th frame.
  7383. optional integer everyNthFrame
  7384. # Force the page stop all navigations and pending resource fetches.
  7385. command stopLoading
  7386. # Crashes renderer on the IO thread, generates minidumps.
  7387. experimental command crash
  7388. # Tries to close page, running its beforeunload hooks, if any.
  7389. experimental command close
  7390. # Tries to update the web lifecycle state of the page.
  7391. # It will transition the page to the given state according to:
  7392. # https://github.com/WICG/web-lifecycle/
  7393. experimental command setWebLifecycleState
  7394. parameters
  7395. # Target lifecycle state
  7396. enum state
  7397. frozen
  7398. active
  7399. # Stops sending each frame in the `screencastFrame`.
  7400. experimental command stopScreencast
  7401. # Requests backend to produce compilation cache for the specified scripts.
  7402. # `scripts` are appeneded to the list of scripts for which the cache
  7403. # would be produced. The list may be reset during page navigation.
  7404. # When script with a matching URL is encountered, the cache is optionally
  7405. # produced upon backend discretion, based on internal heuristics.
  7406. # See also: `Page.compilationCacheProduced`.
  7407. experimental command produceCompilationCache
  7408. parameters
  7409. array of CompilationCacheParams scripts
  7410. # Seeds compilation cache for given url. Compilation cache does not survive
  7411. # cross-process navigation.
  7412. experimental command addCompilationCache
  7413. parameters
  7414. string url
  7415. # Base64-encoded data
  7416. binary data
  7417. # Clears seeded compilation cache.
  7418. experimental command clearCompilationCache
  7419. # Enum of possible auto-reponse for permisison / prompt dialogs.
  7420. experimental type AutoResponseMode extends string
  7421. enum
  7422. none
  7423. autoAccept
  7424. autoReject
  7425. autoOptOut
  7426. # Sets the Secure Payment Confirmation transaction mode.
  7427. # https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode
  7428. experimental command setSPCTransactionMode
  7429. parameters
  7430. AutoResponseMode mode
  7431. # Extensions for Custom Handlers API:
  7432. # https://html.spec.whatwg.org/multipage/system-state.html#rph-automation
  7433. experimental command setRPHRegistrationMode
  7434. parameters
  7435. AutoResponseMode mode
  7436. # Generates a report for testing.
  7437. experimental command generateTestReport
  7438. parameters
  7439. # Message to be displayed in the report.
  7440. string message
  7441. # Specifies the endpoint group to deliver the report to.
  7442. optional string group
  7443. # Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
  7444. experimental command waitForDebugger
  7445. # Intercept file chooser requests and transfer control to protocol clients.
  7446. # When file chooser interception is enabled, native file chooser dialog is not shown.
  7447. # Instead, a protocol event `Page.fileChooserOpened` is emitted.
  7448. experimental command setInterceptFileChooserDialog
  7449. parameters
  7450. boolean enabled
  7451. event domContentEventFired
  7452. parameters
  7453. Network.MonotonicTime timestamp
  7454. # Emitted only when `page.interceptFileChooser` is enabled.
  7455. event fileChooserOpened
  7456. parameters
  7457. # Id of the frame containing input node.
  7458. experimental FrameId frameId
  7459. # Input mode.
  7460. enum mode
  7461. selectSingle
  7462. selectMultiple
  7463. # Input node id. Only present for file choosers opened via an <input type="file"> element.
  7464. experimental optional DOM.BackendNodeId backendNodeId
  7465. # Fired when frame has been attached to its parent.
  7466. event frameAttached
  7467. parameters
  7468. # Id of the frame that has been attached.
  7469. FrameId frameId
  7470. # Parent frame identifier.
  7471. FrameId parentFrameId
  7472. # JavaScript stack trace of when frame was attached, only set if frame initiated from script.
  7473. optional Runtime.StackTrace stack
  7474. # Fired when frame no longer has a scheduled navigation.
  7475. deprecated event frameClearedScheduledNavigation
  7476. parameters
  7477. # Id of the frame that has cleared its scheduled navigation.
  7478. FrameId frameId
  7479. # Fired when frame has been detached from its parent.
  7480. event frameDetached
  7481. parameters
  7482. # Id of the frame that has been detached.
  7483. FrameId frameId
  7484. experimental enum reason
  7485. # The frame is removed from the DOM.
  7486. remove
  7487. # The frame is being swapped out in favor of an out-of-process iframe.
  7488. # A new frame target will be created (see Target.attachedToTarget).
  7489. swap
  7490. # The type of a frameNavigated event.
  7491. experimental type NavigationType extends string
  7492. enum
  7493. Navigation
  7494. BackForwardCacheRestore
  7495. # Fired once navigation of the frame has completed. Frame is now associated with the new loader.
  7496. event frameNavigated
  7497. parameters
  7498. # Frame object.
  7499. Frame frame
  7500. experimental NavigationType type
  7501. # Fired when opening document to write to.
  7502. experimental event documentOpened
  7503. parameters
  7504. # Frame object.
  7505. Frame frame
  7506. experimental event frameResized
  7507. # Fired when a renderer-initiated navigation is requested.
  7508. # Navigation may still be cancelled after the event is issued.
  7509. experimental event frameRequestedNavigation
  7510. parameters
  7511. # Id of the frame that is being navigated.
  7512. FrameId frameId
  7513. # The reason for the navigation.
  7514. ClientNavigationReason reason
  7515. # The destination URL for the requested navigation.
  7516. string url
  7517. # The disposition for the navigation.
  7518. ClientNavigationDisposition disposition
  7519. # Fired when frame schedules a potential navigation.
  7520. deprecated event frameScheduledNavigation
  7521. parameters
  7522. # Id of the frame that has scheduled a navigation.
  7523. FrameId frameId
  7524. # Delay (in seconds) until the navigation is scheduled to begin. The navigation is not
  7525. # guaranteed to start.
  7526. number delay
  7527. # The reason for the navigation.
  7528. ClientNavigationReason reason
  7529. # The destination URL for the scheduled navigation.
  7530. string url
  7531. # Fired when frame has started loading.
  7532. experimental event frameStartedLoading
  7533. parameters
  7534. # Id of the frame that has started loading.
  7535. FrameId frameId
  7536. # Fired when frame has stopped loading.
  7537. experimental event frameStoppedLoading
  7538. parameters
  7539. # Id of the frame that has stopped loading.
  7540. FrameId frameId
  7541. # Fired when page is about to start a download.
  7542. # Deprecated. Use Browser.downloadWillBegin instead.
  7543. experimental deprecated event downloadWillBegin
  7544. parameters
  7545. # Id of the frame that caused download to begin.
  7546. FrameId frameId
  7547. # Global unique identifier of the download.
  7548. string guid
  7549. # URL of the resource being downloaded.
  7550. string url
  7551. # Suggested file name of the resource (the actual name of the file saved on disk may differ).
  7552. string suggestedFilename
  7553. # Fired when download makes progress. Last call has |done| == true.
  7554. # Deprecated. Use Browser.downloadProgress instead.
  7555. experimental deprecated event downloadProgress
  7556. parameters
  7557. # Global unique identifier of the download.
  7558. string guid
  7559. # Total expected bytes to download.
  7560. number totalBytes
  7561. # Total bytes received.
  7562. number receivedBytes
  7563. # Download status.
  7564. enum state
  7565. inProgress
  7566. completed
  7567. canceled
  7568. # Fired when interstitial page was hidden
  7569. event interstitialHidden
  7570. # Fired when interstitial page was shown
  7571. event interstitialShown
  7572. # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
  7573. # closed.
  7574. event javascriptDialogClosed
  7575. parameters
  7576. # Whether dialog was confirmed.
  7577. boolean result
  7578. # User input in case of prompt.
  7579. string userInput
  7580. # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
  7581. # open.
  7582. event javascriptDialogOpening
  7583. parameters
  7584. # Frame url.
  7585. string url
  7586. # Message that will be displayed by the dialog.
  7587. string message
  7588. # Dialog type.
  7589. DialogType type
  7590. # True iff browser is capable showing or acting on the given dialog. When browser has no
  7591. # dialog handler for given target, calling alert while Page domain is engaged will stall
  7592. # the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
  7593. boolean hasBrowserHandler
  7594. # Default dialog prompt.
  7595. optional string defaultPrompt
  7596. # Fired for top level page lifecycle events such as navigation, load, paint, etc.
  7597. event lifecycleEvent
  7598. parameters
  7599. # Id of the frame.
  7600. FrameId frameId
  7601. # Loader identifier. Empty string if the request is fetched from worker.
  7602. Network.LoaderId loaderId
  7603. string name
  7604. Network.MonotonicTime timestamp
  7605. # List of not restored reasons for back-forward cache.
  7606. experimental type BackForwardCacheNotRestoredReason extends string
  7607. enum
  7608. NotPrimaryMainFrame
  7609. BackForwardCacheDisabled
  7610. RelatedActiveContentsExist
  7611. HTTPStatusNotOK
  7612. SchemeNotHTTPOrHTTPS
  7613. Loading
  7614. WasGrantedMediaAccess
  7615. DisableForRenderFrameHostCalled
  7616. DomainNotAllowed
  7617. HTTPMethodNotGET
  7618. SubframeIsNavigating
  7619. Timeout
  7620. CacheLimit
  7621. JavaScriptExecution
  7622. RendererProcessKilled
  7623. RendererProcessCrashed
  7624. SchedulerTrackedFeatureUsed
  7625. ConflictingBrowsingInstance
  7626. CacheFlushed
  7627. ServiceWorkerVersionActivation
  7628. SessionRestored
  7629. ServiceWorkerPostMessage
  7630. EnteredBackForwardCacheBeforeServiceWorkerHostAdded
  7631. RenderFrameHostReused_SameSite
  7632. RenderFrameHostReused_CrossSite
  7633. ServiceWorkerClaim
  7634. IgnoreEventAndEvict
  7635. HaveInnerContents
  7636. TimeoutPuttingInCache
  7637. BackForwardCacheDisabledByLowMemory
  7638. BackForwardCacheDisabledByCommandLine
  7639. NetworkRequestDatapipeDrainedAsBytesConsumer
  7640. NetworkRequestRedirected
  7641. NetworkRequestTimeout
  7642. NetworkExceedsBufferLimit
  7643. NavigationCancelledWhileRestoring
  7644. NotMostRecentNavigationEntry
  7645. BackForwardCacheDisabledForPrerender
  7646. UserAgentOverrideDiffers
  7647. ForegroundCacheLimit
  7648. BrowsingInstanceNotSwapped
  7649. BackForwardCacheDisabledForDelegate
  7650. UnloadHandlerExistsInMainFrame
  7651. UnloadHandlerExistsInSubFrame
  7652. ServiceWorkerUnregistration
  7653. CacheControlNoStore
  7654. CacheControlNoStoreCookieModified
  7655. CacheControlNoStoreHTTPOnlyCookieModified
  7656. NoResponseHead
  7657. Unknown
  7658. ActivationNavigationsDisallowedForBug1234857
  7659. ErrorDocument
  7660. FencedFramesEmbedder
  7661. #Blocklisted features
  7662. WebSocket
  7663. WebTransport
  7664. WebRTC
  7665. MainResourceHasCacheControlNoStore
  7666. MainResourceHasCacheControlNoCache
  7667. SubresourceHasCacheControlNoStore
  7668. SubresourceHasCacheControlNoCache
  7669. ContainsPlugins
  7670. DocumentLoaded
  7671. DedicatedWorkerOrWorklet
  7672. OutstandingNetworkRequestOthers
  7673. OutstandingIndexedDBTransaction
  7674. RequestedMIDIPermission
  7675. RequestedAudioCapturePermission
  7676. RequestedVideoCapturePermission
  7677. RequestedBackForwardCacheBlockedSensors
  7678. RequestedBackgroundWorkPermission
  7679. BroadcastChannel
  7680. IndexedDBConnection
  7681. WebXR
  7682. SharedWorker
  7683. WebLocks
  7684. WebHID
  7685. WebShare
  7686. RequestedStorageAccessGrant
  7687. WebNfc
  7688. OutstandingNetworkRequestFetch
  7689. OutstandingNetworkRequestXHR
  7690. AppBanner
  7691. Printing
  7692. WebDatabase
  7693. PictureInPicture
  7694. Portal
  7695. SpeechRecognizer
  7696. IdleManager
  7697. PaymentManager
  7698. SpeechSynthesis
  7699. KeyboardLock
  7700. WebOTPService
  7701. OutstandingNetworkRequestDirectSocket
  7702. InjectedJavascript
  7703. InjectedStyleSheet
  7704. KeepaliveRequest
  7705. IndexedDBEvent
  7706. Dummy
  7707. AuthorizationHeader
  7708. # Disabled for RenderFrameHost reasons
  7709. # See content/browser/renderer_host/back_forward_cache_disable.h for explanations.
  7710. ContentSecurityHandler
  7711. ContentWebAuthenticationAPI
  7712. ContentFileChooser
  7713. ContentSerial
  7714. ContentFileSystemAccess
  7715. ContentMediaDevicesDispatcherHost
  7716. ContentWebBluetooth
  7717. ContentWebUSB
  7718. ContentMediaSessionService
  7719. ContentScreenReader
  7720. # See components/back_forward_cache/back_forward_cache_disable.h for explanations.
  7721. EmbedderPopupBlockerTabHelper
  7722. EmbedderSafeBrowsingTriggeredPopupBlocker
  7723. EmbedderSafeBrowsingThreatDetails
  7724. EmbedderAppBannerManager
  7725. EmbedderDomDistillerViewerSource
  7726. EmbedderDomDistillerSelfDeletingRequestDelegate
  7727. EmbedderOomInterventionTabHelper
  7728. EmbedderOfflinePage
  7729. EmbedderChromePasswordManagerClientBindCredentialManager
  7730. EmbedderPermissionRequestManager
  7731. EmbedderModalDialog
  7732. EmbedderExtensions
  7733. EmbedderExtensionMessaging
  7734. EmbedderExtensionMessagingForOpenPort
  7735. EmbedderExtensionSentMessageToCachedFrame
  7736. # Types of not restored reasons for back-forward cache.
  7737. experimental type BackForwardCacheNotRestoredReasonType extends string
  7738. enum
  7739. SupportPending
  7740. PageSupportNeeded
  7741. Circumstantial
  7742. experimental type BackForwardCacheNotRestoredExplanation extends object
  7743. properties
  7744. # Type of the reason
  7745. BackForwardCacheNotRestoredReasonType type
  7746. # Not restored reason
  7747. BackForwardCacheNotRestoredReason reason
  7748. # Context associated with the reason. The meaning of this context is
  7749. # dependent on the reason:
  7750. # - EmbedderExtensionSentMessageToCachedFrame: the extension ID.
  7751. #
  7752. optional string context
  7753. experimental type BackForwardCacheNotRestoredExplanationTree extends object
  7754. properties
  7755. # URL of each frame
  7756. string url
  7757. # Not restored reasons of each frame
  7758. array of BackForwardCacheNotRestoredExplanation explanations
  7759. # Array of children frame
  7760. array of BackForwardCacheNotRestoredExplanationTree children
  7761. # Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do
  7762. # not assume any ordering with the Page.frameNavigated event. This event is fired only for
  7763. # main-frame history navigation where the document changes (non-same-document navigations),
  7764. # when bfcache navigation fails.
  7765. experimental event backForwardCacheNotUsed
  7766. parameters
  7767. # The loader id for the associated navgation.
  7768. Network.LoaderId loaderId
  7769. # The frame id of the associated frame.
  7770. FrameId frameId
  7771. # Array of reasons why the page could not be cached. This must not be empty.
  7772. array of BackForwardCacheNotRestoredExplanation notRestoredExplanations
  7773. # Tree structure of reasons why the page could not be cached for each frame.
  7774. optional BackForwardCacheNotRestoredExplanationTree notRestoredExplanationsTree
  7775. event loadEventFired
  7776. parameters
  7777. Network.MonotonicTime timestamp
  7778. # Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
  7779. experimental event navigatedWithinDocument
  7780. parameters
  7781. # Id of the frame.
  7782. FrameId frameId
  7783. # Frame's new url.
  7784. string url
  7785. # Compressed image data requested by the `startScreencast`.
  7786. experimental event screencastFrame
  7787. parameters
  7788. # Base64-encoded compressed image.
  7789. binary data
  7790. # Screencast frame metadata.
  7791. ScreencastFrameMetadata metadata
  7792. # Frame number.
  7793. integer sessionId
  7794. # Fired when the page with currently enabled screencast was shown or hidden `.
  7795. experimental event screencastVisibilityChanged
  7796. parameters
  7797. # True if the page is visible.
  7798. boolean visible
  7799. # Fired when a new window is going to be opened, via window.open(), link click, form submission,
  7800. # etc.
  7801. event windowOpen
  7802. parameters
  7803. # The URL for the new window.
  7804. string url
  7805. # Window name.
  7806. string windowName
  7807. # An array of enabled window features.
  7808. array of string windowFeatures
  7809. # Whether or not it was triggered by user gesture.
  7810. boolean userGesture
  7811. # Issued for every compilation cache generated. Is only available
  7812. # if Page.setGenerateCompilationCache is enabled.
  7813. experimental event compilationCacheProduced
  7814. parameters
  7815. string url
  7816. # Base64-encoded data
  7817. binary data
  7818. domain Performance
  7819. # Run-time execution metric.
  7820. type Metric extends object
  7821. properties
  7822. # Metric name.
  7823. string name
  7824. # Metric value.
  7825. number value
  7826. # Disable collecting and reporting metrics.
  7827. command disable
  7828. # Enable collecting and reporting metrics.
  7829. command enable
  7830. parameters
  7831. # Time domain to use for collecting and reporting duration metrics.
  7832. optional enum timeDomain
  7833. # Use monotonically increasing abstract time (default).
  7834. timeTicks
  7835. # Use thread running time.
  7836. threadTicks
  7837. # Sets time domain to use for collecting and reporting duration metrics.
  7838. # Note that this must be called before enabling metrics collection. Calling
  7839. # this method while metrics collection is enabled returns an error.
  7840. experimental deprecated command setTimeDomain
  7841. parameters
  7842. # Time domain
  7843. enum timeDomain
  7844. # Use monotonically increasing abstract time (default).
  7845. timeTicks
  7846. # Use thread running time.
  7847. threadTicks
  7848. # Retrieve current values of run-time metrics.
  7849. command getMetrics
  7850. returns
  7851. # Current values for run-time metrics.
  7852. array of Metric metrics
  7853. # Current values of the metrics.
  7854. event metrics
  7855. parameters
  7856. # Current values of the metrics.
  7857. array of Metric metrics
  7858. # Timestamp title.
  7859. string title
  7860. # Reporting of performance timeline events, as specified in
  7861. # https://w3c.github.io/performance-timeline/#dom-performanceobserver.
  7862. experimental domain PerformanceTimeline
  7863. depends on DOM
  7864. depends on Network
  7865. # See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl
  7866. type LargestContentfulPaint extends object
  7867. properties
  7868. Network.TimeSinceEpoch renderTime
  7869. Network.TimeSinceEpoch loadTime
  7870. # The number of pixels being painted.
  7871. number size
  7872. # The id attribute of the element, if available.
  7873. optional string elementId
  7874. # The URL of the image (may be trimmed).
  7875. optional string url
  7876. optional DOM.BackendNodeId nodeId
  7877. type LayoutShiftAttribution extends object
  7878. properties
  7879. DOM.Rect previousRect
  7880. DOM.Rect currentRect
  7881. optional DOM.BackendNodeId nodeId
  7882. # See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl
  7883. type LayoutShift extends object
  7884. properties
  7885. # Score increment produced by this event.
  7886. number value
  7887. boolean hadRecentInput
  7888. Network.TimeSinceEpoch lastInputTime
  7889. array of LayoutShiftAttribution sources
  7890. type TimelineEvent extends object
  7891. properties
  7892. # Identifies the frame that this event is related to. Empty for non-frame targets.
  7893. Page.FrameId frameId
  7894. # The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
  7895. # This determines which of the optional "details" fiedls is present.
  7896. string type
  7897. # Name may be empty depending on the type.
  7898. string name
  7899. # Time in seconds since Epoch, monotonically increasing within document lifetime.
  7900. Network.TimeSinceEpoch time
  7901. # Event duration, if applicable.
  7902. optional number duration
  7903. optional LargestContentfulPaint lcpDetails
  7904. optional LayoutShift layoutShiftDetails
  7905. # Previously buffered events would be reported before method returns.
  7906. # See also: timelineEventAdded
  7907. command enable
  7908. parameters
  7909. # The types of event to report, as specified in
  7910. # https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
  7911. # The specified filter overrides any previous filters, passing empty
  7912. # filter disables recording.
  7913. # Note that not all types exposed to the web platform are currently supported.
  7914. array of string eventTypes
  7915. # Sent when a performance timeline event is added. See reportPerformanceTimeline method.
  7916. event timelineEventAdded
  7917. parameters
  7918. TimelineEvent event
  7919. # Security
  7920. domain Security
  7921. # An internal certificate ID value.
  7922. type CertificateId extends integer
  7923. # A description of mixed content (HTTP resources on HTTPS pages), as defined by
  7924. # https://www.w3.org/TR/mixed-content/#categories
  7925. type MixedContentType extends string
  7926. enum
  7927. blockable
  7928. optionally-blockable
  7929. none
  7930. # The security level of a page or resource.
  7931. type SecurityState extends string
  7932. enum
  7933. unknown
  7934. neutral
  7935. insecure
  7936. secure
  7937. info
  7938. insecure-broken
  7939. # Details about the security state of the page certificate.
  7940. experimental type CertificateSecurityState extends object
  7941. properties
  7942. # Protocol name (e.g. "TLS 1.2" or "QUIC").
  7943. string protocol
  7944. # Key Exchange used by the connection, or the empty string if not applicable.
  7945. string keyExchange
  7946. # (EC)DH group used by the connection, if applicable.
  7947. optional string keyExchangeGroup
  7948. # Cipher name.
  7949. string cipher
  7950. # TLS MAC. Note that AEAD ciphers do not have separate MACs.
  7951. optional string mac
  7952. # Page certificate.
  7953. array of string certificate
  7954. # Certificate subject name.
  7955. string subjectName
  7956. # Name of the issuing CA.
  7957. string issuer
  7958. # Certificate valid from date.
  7959. Network.TimeSinceEpoch validFrom
  7960. # Certificate valid to (expiration) date
  7961. Network.TimeSinceEpoch validTo
  7962. # The highest priority network error code, if the certificate has an error.
  7963. optional string certificateNetworkError
  7964. # True if the certificate uses a weak signature aglorithm.
  7965. boolean certificateHasWeakSignature
  7966. # True if the certificate has a SHA1 signature in the chain.
  7967. boolean certificateHasSha1Signature
  7968. # True if modern SSL
  7969. boolean modernSSL
  7970. # True if the connection is using an obsolete SSL protocol.
  7971. boolean obsoleteSslProtocol
  7972. # True if the connection is using an obsolete SSL key exchange.
  7973. boolean obsoleteSslKeyExchange
  7974. # True if the connection is using an obsolete SSL cipher.
  7975. boolean obsoleteSslCipher
  7976. # True if the connection is using an obsolete SSL signature.
  7977. boolean obsoleteSslSignature
  7978. experimental type SafetyTipStatus extends string
  7979. enum
  7980. badReputation
  7981. lookalike
  7982. experimental type SafetyTipInfo extends object
  7983. properties
  7984. # Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
  7985. SafetyTipStatus safetyTipStatus
  7986. # The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
  7987. optional string safeUrl
  7988. # Security state information about the page.
  7989. experimental type VisibleSecurityState extends object
  7990. properties
  7991. # The security level of the page.
  7992. SecurityState securityState
  7993. # Security state details about the page certificate.
  7994. optional CertificateSecurityState certificateSecurityState
  7995. # The type of Safety Tip triggered on the page. Note that this field will be set even if the Safety Tip UI was not actually shown.
  7996. optional SafetyTipInfo safetyTipInfo
  7997. # Array of security state issues ids.
  7998. array of string securityStateIssueIds
  7999. # An explanation of an factor contributing to the security state.
  8000. type SecurityStateExplanation extends object
  8001. properties
  8002. # Security state representing the severity of the factor being explained.
  8003. SecurityState securityState
  8004. # Title describing the type of factor.
  8005. string title
  8006. # Short phrase describing the type of factor.
  8007. string summary
  8008. # Full text explanation of the factor.
  8009. string description
  8010. # The type of mixed content described by the explanation.
  8011. MixedContentType mixedContentType
  8012. # Page certificate.
  8013. array of string certificate
  8014. # Recommendations to fix any issues.
  8015. optional array of string recommendations
  8016. # Information about insecure content on the page.
  8017. deprecated type InsecureContentStatus extends object
  8018. properties
  8019. # Always false.
  8020. boolean ranMixedContent
  8021. # Always false.
  8022. boolean displayedMixedContent
  8023. # Always false.
  8024. boolean containedMixedForm
  8025. # Always false.
  8026. boolean ranContentWithCertErrors
  8027. # Always false.
  8028. boolean displayedContentWithCertErrors
  8029. # Always set to unknown.
  8030. SecurityState ranInsecureContentStyle
  8031. # Always set to unknown.
  8032. SecurityState displayedInsecureContentStyle
  8033. # The action to take when a certificate error occurs. continue will continue processing the
  8034. # request and cancel will cancel the request.
  8035. type CertificateErrorAction extends string
  8036. enum
  8037. continue
  8038. cancel
  8039. # Disables tracking security state changes.
  8040. command disable
  8041. # Enables tracking security state changes.
  8042. command enable
  8043. # Enable/disable whether all certificate errors should be ignored.
  8044. experimental command setIgnoreCertificateErrors
  8045. parameters
  8046. # If true, all certificate errors will be ignored.
  8047. boolean ignore
  8048. # Handles a certificate error that fired a certificateError event.
  8049. deprecated command handleCertificateError
  8050. parameters
  8051. # The ID of the event.
  8052. integer eventId
  8053. # The action to take on the certificate error.
  8054. CertificateErrorAction action
  8055. # Enable/disable overriding certificate errors. If enabled, all certificate error events need to
  8056. # be handled by the DevTools client and should be answered with `handleCertificateError` commands.
  8057. deprecated command setOverrideCertificateErrors
  8058. parameters
  8059. # If true, certificate errors will be overridden.
  8060. boolean override
  8061. # There is a certificate error. If overriding certificate errors is enabled, then it should be
  8062. # handled with the `handleCertificateError` command. Note: this event does not fire if the
  8063. # certificate error has been allowed internally. Only one client per target should override
  8064. # certificate errors at the same time.
  8065. deprecated event certificateError
  8066. parameters
  8067. # The ID of the event.
  8068. integer eventId
  8069. # The type of the error.
  8070. string errorType
  8071. # The url that was requested.
  8072. string requestURL
  8073. # The security state of the page changed.
  8074. experimental event visibleSecurityStateChanged
  8075. parameters
  8076. # Security state information about the page.
  8077. VisibleSecurityState visibleSecurityState
  8078. # The security state of the page changed. No longer being sent.
  8079. deprecated event securityStateChanged
  8080. parameters
  8081. # Security state.
  8082. SecurityState securityState
  8083. # True if the page was loaded over cryptographic transport such as HTTPS.
  8084. deprecated boolean schemeIsCryptographic
  8085. # Previously a list of explanations for the security state. Now always
  8086. # empty.
  8087. deprecated array of SecurityStateExplanation explanations
  8088. # Information about insecure content on the page.
  8089. deprecated InsecureContentStatus insecureContentStatus
  8090. # Overrides user-visible description of the state. Always omitted.
  8091. deprecated optional string summary
  8092. experimental domain ServiceWorker
  8093. depends on Target
  8094. type RegistrationID extends string
  8095. # ServiceWorker registration.
  8096. type ServiceWorkerRegistration extends object
  8097. properties
  8098. RegistrationID registrationId
  8099. string scopeURL
  8100. boolean isDeleted
  8101. type ServiceWorkerVersionRunningStatus extends string
  8102. enum
  8103. stopped
  8104. starting
  8105. running
  8106. stopping
  8107. type ServiceWorkerVersionStatus extends string
  8108. enum
  8109. new
  8110. installing
  8111. installed
  8112. activating
  8113. activated
  8114. redundant
  8115. # ServiceWorker version.
  8116. type ServiceWorkerVersion extends object
  8117. properties
  8118. string versionId
  8119. RegistrationID registrationId
  8120. string scriptURL
  8121. ServiceWorkerVersionRunningStatus runningStatus
  8122. ServiceWorkerVersionStatus status
  8123. # The Last-Modified header value of the main script.
  8124. optional number scriptLastModified
  8125. # The time at which the response headers of the main script were received from the server.
  8126. # For cached script it is the last time the cache entry was validated.
  8127. optional number scriptResponseTime
  8128. optional array of Target.TargetID controlledClients
  8129. optional Target.TargetID targetId
  8130. # ServiceWorker error message.
  8131. type ServiceWorkerErrorMessage extends object
  8132. properties
  8133. string errorMessage
  8134. RegistrationID registrationId
  8135. string versionId
  8136. string sourceURL
  8137. integer lineNumber
  8138. integer columnNumber
  8139. command deliverPushMessage
  8140. parameters
  8141. string origin
  8142. RegistrationID registrationId
  8143. string data
  8144. command disable
  8145. command dispatchSyncEvent
  8146. parameters
  8147. string origin
  8148. RegistrationID registrationId
  8149. string tag
  8150. boolean lastChance
  8151. command dispatchPeriodicSyncEvent
  8152. parameters
  8153. string origin
  8154. RegistrationID registrationId
  8155. string tag
  8156. command enable
  8157. command inspectWorker
  8158. parameters
  8159. string versionId
  8160. command setForceUpdateOnPageLoad
  8161. parameters
  8162. boolean forceUpdateOnPageLoad
  8163. command skipWaiting
  8164. parameters
  8165. string scopeURL
  8166. command startWorker
  8167. parameters
  8168. string scopeURL
  8169. command stopAllWorkers
  8170. command stopWorker
  8171. parameters
  8172. string versionId
  8173. command unregister
  8174. parameters
  8175. string scopeURL
  8176. command updateRegistration
  8177. parameters
  8178. string scopeURL
  8179. event workerErrorReported
  8180. parameters
  8181. ServiceWorkerErrorMessage errorMessage
  8182. event workerRegistrationUpdated
  8183. parameters
  8184. array of ServiceWorkerRegistration registrations
  8185. event workerVersionUpdated
  8186. parameters
  8187. array of ServiceWorkerVersion versions
  8188. experimental domain Storage
  8189. depends on Browser
  8190. depends on Network
  8191. type SerializedStorageKey extends string
  8192. # Enum of possible storage types.
  8193. type StorageType extends string
  8194. enum
  8195. appcache
  8196. cookies
  8197. file_systems
  8198. indexeddb
  8199. local_storage
  8200. shader_cache
  8201. websql
  8202. service_workers
  8203. cache_storage
  8204. interest_groups
  8205. shared_storage
  8206. storage_buckets
  8207. all
  8208. other
  8209. # Usage for a storage type.
  8210. type UsageForType extends object
  8211. properties
  8212. # Name of storage type.
  8213. StorageType storageType
  8214. # Storage usage (bytes).
  8215. number usage
  8216. # Pair of issuer origin and number of available (signed, but not used) Trust
  8217. # Tokens from that issuer.
  8218. experimental type TrustTokens extends object
  8219. properties
  8220. string issuerOrigin
  8221. number count
  8222. # Enum of interest group access types.
  8223. type InterestGroupAccessType extends string
  8224. enum
  8225. join
  8226. leave
  8227. update
  8228. loaded
  8229. bid
  8230. win
  8231. # Ad advertising element inside an interest group.
  8232. type InterestGroupAd extends object
  8233. properties
  8234. string renderUrl
  8235. optional string metadata
  8236. # The full details of an interest group.
  8237. type InterestGroupDetails extends object
  8238. properties
  8239. string ownerOrigin
  8240. string name
  8241. Network.TimeSinceEpoch expirationTime
  8242. string joiningOrigin
  8243. optional string biddingUrl
  8244. optional string biddingWasmHelperUrl
  8245. optional string updateUrl
  8246. optional string trustedBiddingSignalsUrl
  8247. array of string trustedBiddingSignalsKeys
  8248. optional string userBiddingSignals
  8249. array of InterestGroupAd ads
  8250. array of InterestGroupAd adComponents
  8251. # Enum of shared storage access types.
  8252. type SharedStorageAccessType extends string
  8253. enum
  8254. documentAddModule
  8255. documentSelectURL
  8256. documentRun
  8257. documentSet
  8258. documentAppend
  8259. documentDelete
  8260. documentClear
  8261. workletSet
  8262. workletAppend
  8263. workletDelete
  8264. workletClear
  8265. workletGet
  8266. workletKeys
  8267. workletEntries
  8268. workletLength
  8269. workletRemainingBudget
  8270. # Struct for a single key-value pair in an origin's shared storage.
  8271. type SharedStorageEntry extends object
  8272. properties
  8273. string key
  8274. string value
  8275. # Details for an origin's shared storage.
  8276. type SharedStorageMetadata extends object
  8277. properties
  8278. Network.TimeSinceEpoch creationTime
  8279. integer length
  8280. number remainingBudget
  8281. # Pair of reporting metadata details for a candidate URL for `selectURL()`.
  8282. type SharedStorageReportingMetadata extends object
  8283. properties
  8284. string eventType
  8285. string reportingUrl
  8286. # Bundles a candidate URL with its reporting metadata.
  8287. type SharedStorageUrlWithMetadata extends object
  8288. properties
  8289. # Spec of candidate URL.
  8290. string url
  8291. # Any associated reporting metadata.
  8292. array of SharedStorageReportingMetadata reportingMetadata
  8293. # Bundles the parameters for shared storage access events whose
  8294. # presence/absence can vary according to SharedStorageAccessType.
  8295. type SharedStorageAccessParams extends object
  8296. properties
  8297. # Spec of the module script URL.
  8298. # Present only for SharedStorageAccessType.documentAddModule.
  8299. optional string scriptSourceUrl
  8300. # Name of the registered operation to be run.
  8301. # Present only for SharedStorageAccessType.documentRun and
  8302. # SharedStorageAccessType.documentSelectURL.
  8303. optional string operationName
  8304. # The operation's serialized data in bytes (converted to a string).
  8305. # Present only for SharedStorageAccessType.documentRun and
  8306. # SharedStorageAccessType.documentSelectURL.
  8307. optional string serializedData
  8308. # Array of candidate URLs' specs, along with any associated metadata.
  8309. # Present only for SharedStorageAccessType.documentSelectURL.
  8310. optional array of SharedStorageUrlWithMetadata urlsWithMetadata
  8311. # Key for a specific entry in an origin's shared storage.
  8312. # Present only for SharedStorageAccessType.documentSet,
  8313. # SharedStorageAccessType.documentAppend,
  8314. # SharedStorageAccessType.documentDelete,
  8315. # SharedStorageAccessType.workletSet,
  8316. # SharedStorageAccessType.workletAppend,
  8317. # SharedStorageAccessType.workletDelete, and
  8318. # SharedStorageAccessType.workletGet.
  8319. optional string key
  8320. # Value for a specific entry in an origin's shared storage.
  8321. # Present only for SharedStorageAccessType.documentSet,
  8322. # SharedStorageAccessType.documentAppend,
  8323. # SharedStorageAccessType.workletSet, and
  8324. # SharedStorageAccessType.workletAppend.
  8325. optional string value
  8326. # Whether or not to set an entry for a key if that key is already present.
  8327. # Present only for SharedStorageAccessType.documentSet and
  8328. # SharedStorageAccessType.workletSet.
  8329. optional boolean ignoreIfPresent
  8330. type StorageBucketsDurability extends string
  8331. enum
  8332. relaxed
  8333. strict
  8334. type StorageBucket extends object
  8335. properties
  8336. SerializedStorageKey storageKey
  8337. # If not specified, it is the default bucket of the storageKey.
  8338. optional string name
  8339. type StorageBucketInfo extends object
  8340. properties
  8341. StorageBucket bucket
  8342. string id
  8343. Network.TimeSinceEpoch expiration
  8344. # Storage quota (bytes).
  8345. number quota
  8346. boolean persistent
  8347. StorageBucketsDurability durability
  8348. # Returns a storage key given a frame id.
  8349. command getStorageKeyForFrame
  8350. parameters
  8351. Page.FrameId frameId
  8352. returns
  8353. SerializedStorageKey storageKey
  8354. # Clears storage for origin.
  8355. command clearDataForOrigin
  8356. parameters
  8357. # Security origin.
  8358. string origin
  8359. # Comma separated list of StorageType to clear.
  8360. string storageTypes
  8361. # Clears storage for storage key.
  8362. command clearDataForStorageKey
  8363. parameters
  8364. # Storage key.
  8365. string storageKey
  8366. # Comma separated list of StorageType to clear.
  8367. string storageTypes
  8368. # Returns all browser cookies.
  8369. command getCookies
  8370. parameters
  8371. # Browser context to use when called on the browser endpoint.
  8372. optional Browser.BrowserContextID browserContextId
  8373. returns
  8374. # Array of cookie objects.
  8375. array of Network.Cookie cookies
  8376. # Sets given cookies.
  8377. command setCookies
  8378. parameters
  8379. # Cookies to be set.
  8380. array of Network.CookieParam cookies
  8381. # Browser context to use when called on the browser endpoint.
  8382. optional Browser.BrowserContextID browserContextId
  8383. # Clears cookies.
  8384. command clearCookies
  8385. parameters
  8386. # Browser context to use when called on the browser endpoint.
  8387. optional Browser.BrowserContextID browserContextId
  8388. # Returns usage and quota in bytes.
  8389. command getUsageAndQuota
  8390. parameters
  8391. # Security origin.
  8392. string origin
  8393. returns
  8394. # Storage usage (bytes).
  8395. number usage
  8396. # Storage quota (bytes).
  8397. number quota
  8398. # Whether or not the origin has an active storage quota override
  8399. boolean overrideActive
  8400. # Storage usage per type (bytes).
  8401. array of UsageForType usageBreakdown
  8402. # Override quota for the specified origin
  8403. experimental command overrideQuotaForOrigin
  8404. parameters
  8405. # Security origin.
  8406. string origin
  8407. # The quota size (in bytes) to override the original quota with.
  8408. # If this is called multiple times, the overridden quota will be equal to
  8409. # the quotaSize provided in the final call. If this is called without
  8410. # specifying a quotaSize, the quota will be reset to the default value for
  8411. # the specified origin. If this is called multiple times with different
  8412. # origins, the override will be maintained for each origin until it is
  8413. # disabled (called without a quotaSize).
  8414. optional number quotaSize
  8415. # Registers origin to be notified when an update occurs to its cache storage list.
  8416. command trackCacheStorageForOrigin
  8417. parameters
  8418. # Security origin.
  8419. string origin
  8420. # Registers storage key to be notified when an update occurs to its cache storage list.
  8421. command trackCacheStorageForStorageKey
  8422. parameters
  8423. # Storage key.
  8424. string storageKey
  8425. # Registers origin to be notified when an update occurs to its IndexedDB.
  8426. command trackIndexedDBForOrigin
  8427. parameters
  8428. # Security origin.
  8429. string origin
  8430. # Registers storage key to be notified when an update occurs to its IndexedDB.
  8431. command trackIndexedDBForStorageKey
  8432. parameters
  8433. # Storage key.
  8434. string storageKey
  8435. # Unregisters origin from receiving notifications for cache storage.
  8436. command untrackCacheStorageForOrigin
  8437. parameters
  8438. # Security origin.
  8439. string origin
  8440. # Unregisters storage key from receiving notifications for cache storage.
  8441. command untrackCacheStorageForStorageKey
  8442. parameters
  8443. # Storage key.
  8444. string storageKey
  8445. # Unregisters origin from receiving notifications for IndexedDB.
  8446. command untrackIndexedDBForOrigin
  8447. parameters
  8448. # Security origin.
  8449. string origin
  8450. # Unregisters storage key from receiving notifications for IndexedDB.
  8451. command untrackIndexedDBForStorageKey
  8452. parameters
  8453. # Storage key.
  8454. string storageKey
  8455. # Returns the number of stored Trust Tokens per issuer for the
  8456. # current browsing context.
  8457. experimental command getTrustTokens
  8458. returns
  8459. array of TrustTokens tokens
  8460. # Removes all Trust Tokens issued by the provided issuerOrigin.
  8461. # Leaves other stored data, including the issuer's Redemption Records, intact.
  8462. experimental command clearTrustTokens
  8463. parameters
  8464. string issuerOrigin
  8465. returns
  8466. # True if any tokens were deleted, false otherwise.
  8467. boolean didDeleteTokens
  8468. # Gets details for a named interest group.
  8469. experimental command getInterestGroupDetails
  8470. parameters
  8471. string ownerOrigin
  8472. string name
  8473. returns
  8474. InterestGroupDetails details
  8475. # Enables/Disables issuing of interestGroupAccessed events.
  8476. experimental command setInterestGroupTracking
  8477. parameters
  8478. boolean enable
  8479. # Gets metadata for an origin's shared storage.
  8480. experimental command getSharedStorageMetadata
  8481. parameters
  8482. string ownerOrigin
  8483. returns
  8484. SharedStorageMetadata metadata
  8485. # Gets the entries in an given origin's shared storage.
  8486. experimental command getSharedStorageEntries
  8487. parameters
  8488. string ownerOrigin
  8489. returns
  8490. array of SharedStorageEntry entries
  8491. # Sets entry with `key` and `value` for a given origin's shared storage.
  8492. experimental command setSharedStorageEntry
  8493. parameters
  8494. string ownerOrigin
  8495. string key
  8496. string value
  8497. # If `ignoreIfPresent` is included and true, then only sets the entry if
  8498. # `key` doesn't already exist.
  8499. optional boolean ignoreIfPresent
  8500. # Deletes entry for `key` (if it exists) for a given origin's shared storage.
  8501. experimental command deleteSharedStorageEntry
  8502. parameters
  8503. string ownerOrigin
  8504. string key
  8505. # Clears all entries for a given origin's shared storage.
  8506. experimental command clearSharedStorageEntries
  8507. parameters
  8508. string ownerOrigin
  8509. # Resets the budget for `ownerOrigin` by clearing all budget withdrawals.
  8510. experimental command resetSharedStorageBudget
  8511. parameters
  8512. string ownerOrigin
  8513. # Enables/disables issuing of sharedStorageAccessed events.
  8514. experimental command setSharedStorageTracking
  8515. parameters
  8516. boolean enable
  8517. # Set tracking for a storage key's buckets.
  8518. experimental command setStorageBucketTracking
  8519. parameters
  8520. string storageKey
  8521. boolean enable
  8522. # Deletes the Storage Bucket with the given storage key and bucket name.
  8523. experimental command deleteStorageBucket
  8524. parameters
  8525. StorageBucket bucket
  8526. # Deletes state for sites identified as potential bounce trackers, immediately.
  8527. experimental command runBounceTrackingMitigations
  8528. returns
  8529. array of string deletedSites
  8530. # A cache's contents have been modified.
  8531. event cacheStorageContentUpdated
  8532. parameters
  8533. # Origin to update.
  8534. string origin
  8535. # Storage key to update.
  8536. string storageKey
  8537. # Storage bucket to update.
  8538. string bucketId
  8539. # Name of cache in origin.
  8540. string cacheName
  8541. # A cache has been added/deleted.
  8542. event cacheStorageListUpdated
  8543. parameters
  8544. # Origin to update.
  8545. string origin
  8546. # Storage key to update.
  8547. string storageKey
  8548. # Storage bucket to update.
  8549. string bucketId
  8550. # The origin's IndexedDB object store has been modified.
  8551. event indexedDBContentUpdated
  8552. parameters
  8553. # Origin to update.
  8554. string origin
  8555. # Storage key to update.
  8556. string storageKey
  8557. # Storage bucket to update.
  8558. string bucketId
  8559. # Database to update.
  8560. string databaseName
  8561. # ObjectStore to update.
  8562. string objectStoreName
  8563. # The origin's IndexedDB database list has been modified.
  8564. event indexedDBListUpdated
  8565. parameters
  8566. # Origin to update.
  8567. string origin
  8568. # Storage key to update.
  8569. string storageKey
  8570. # Storage bucket to update.
  8571. string bucketId
  8572. # One of the interest groups was accessed by the associated page.
  8573. event interestGroupAccessed
  8574. parameters
  8575. Network.TimeSinceEpoch accessTime
  8576. InterestGroupAccessType type
  8577. string ownerOrigin
  8578. string name
  8579. # Shared storage was accessed by the associated page.
  8580. # The following parameters are included in all events.
  8581. event sharedStorageAccessed
  8582. parameters
  8583. # Time of the access.
  8584. Network.TimeSinceEpoch accessTime
  8585. # Enum value indicating the Shared Storage API method invoked.
  8586. SharedStorageAccessType type
  8587. # DevTools Frame Token for the primary frame tree's root.
  8588. Page.FrameId mainFrameId
  8589. # Serialized origin for the context that invoked the Shared Storage API.
  8590. string ownerOrigin
  8591. # The sub-parameters warapped by `params` are all optional and their
  8592. # presence/absence depends on `type`.
  8593. SharedStorageAccessParams params
  8594. event storageBucketCreatedOrUpdated
  8595. parameters
  8596. StorageBucketInfo bucketInfo
  8597. event storageBucketDeleted
  8598. parameters
  8599. string bucketId
  8600. # The SystemInfo domain defines methods and events for querying low-level system information.
  8601. experimental domain SystemInfo
  8602. # Describes a single graphics processor (GPU).
  8603. type GPUDevice extends object
  8604. properties
  8605. # PCI ID of the GPU vendor, if available; 0 otherwise.
  8606. number vendorId
  8607. # PCI ID of the GPU device, if available; 0 otherwise.
  8608. number deviceId
  8609. # Sub sys ID of the GPU, only available on Windows.
  8610. optional number subSysId
  8611. # Revision of the GPU, only available on Windows.
  8612. optional number revision
  8613. # String description of the GPU vendor, if the PCI ID is not available.
  8614. string vendorString
  8615. # String description of the GPU device, if the PCI ID is not available.
  8616. string deviceString
  8617. # String description of the GPU driver vendor.
  8618. string driverVendor
  8619. # String description of the GPU driver version.
  8620. string driverVersion
  8621. # Describes the width and height dimensions of an entity.
  8622. type Size extends object
  8623. properties
  8624. # Width in pixels.
  8625. integer width
  8626. # Height in pixels.
  8627. integer height
  8628. # Describes a supported video decoding profile with its associated minimum and
  8629. # maximum resolutions.
  8630. type VideoDecodeAcceleratorCapability extends object
  8631. properties
  8632. # Video codec profile that is supported, e.g. VP9 Profile 2.
  8633. string profile
  8634. # Maximum video dimensions in pixels supported for this |profile|.
  8635. Size maxResolution
  8636. # Minimum video dimensions in pixels supported for this |profile|.
  8637. Size minResolution
  8638. # Describes a supported video encoding profile with its associated maximum
  8639. # resolution and maximum framerate.
  8640. type VideoEncodeAcceleratorCapability extends object
  8641. properties
  8642. # Video codec profile that is supported, e.g H264 Main.
  8643. string profile
  8644. # Maximum video dimensions in pixels supported for this |profile|.
  8645. Size maxResolution
  8646. # Maximum encoding framerate in frames per second supported for this
  8647. # |profile|, as fraction's numerator and denominator, e.g. 24/1 fps,
  8648. # 24000/1001 fps, etc.
  8649. integer maxFramerateNumerator
  8650. integer maxFramerateDenominator
  8651. # YUV subsampling type of the pixels of a given image.
  8652. type SubsamplingFormat extends string
  8653. enum
  8654. yuv420
  8655. yuv422
  8656. yuv444
  8657. # Image format of a given image.
  8658. type ImageType extends string
  8659. enum
  8660. jpeg
  8661. webp
  8662. unknown
  8663. # Describes a supported image decoding profile with its associated minimum and
  8664. # maximum resolutions and subsampling.
  8665. type ImageDecodeAcceleratorCapability extends object
  8666. properties
  8667. # Image coded, e.g. Jpeg.
  8668. ImageType imageType
  8669. # Maximum supported dimensions of the image in pixels.
  8670. Size maxDimensions
  8671. # Minimum supported dimensions of the image in pixels.
  8672. Size minDimensions
  8673. # Optional array of supported subsampling formats, e.g. 4:2:0, if known.
  8674. array of SubsamplingFormat subsamplings
  8675. # Provides information about the GPU(s) on the system.
  8676. type GPUInfo extends object
  8677. properties
  8678. # The graphics devices on the system. Element 0 is the primary GPU.
  8679. array of GPUDevice devices
  8680. # An optional dictionary of additional GPU related attributes.
  8681. optional object auxAttributes
  8682. # An optional dictionary of graphics features and their status.
  8683. optional object featureStatus
  8684. # An optional array of GPU driver bug workarounds.
  8685. array of string driverBugWorkarounds
  8686. # Supported accelerated video decoding capabilities.
  8687. array of VideoDecodeAcceleratorCapability videoDecoding
  8688. # Supported accelerated video encoding capabilities.
  8689. array of VideoEncodeAcceleratorCapability videoEncoding
  8690. # Supported accelerated image decoding capabilities.
  8691. array of ImageDecodeAcceleratorCapability imageDecoding
  8692. # Represents process info.
  8693. type ProcessInfo extends object
  8694. properties
  8695. # Specifies process type.
  8696. string type
  8697. # Specifies process id.
  8698. integer id
  8699. # Specifies cumulative CPU usage in seconds across all threads of the
  8700. # process since the process start.
  8701. number cpuTime
  8702. # Returns information about the system.
  8703. command getInfo
  8704. returns
  8705. # Information about the GPUs on the system.
  8706. GPUInfo gpu
  8707. # A platform-dependent description of the model of the machine. On Mac OS, this is, for
  8708. # example, 'MacBookPro'. Will be the empty string if not supported.
  8709. string modelName
  8710. # A platform-dependent description of the version of the machine. On Mac OS, this is, for
  8711. # example, '10.1'. Will be the empty string if not supported.
  8712. string modelVersion
  8713. # The command line string used to launch the browser. Will be the empty string if not
  8714. # supported.
  8715. string commandLine
  8716. # Returns information about the feature state.
  8717. command getFeatureState
  8718. parameters
  8719. string featureState
  8720. returns
  8721. boolean featureEnabled
  8722. # Returns information about all running processes.
  8723. command getProcessInfo
  8724. returns
  8725. # An array of process info blocks.
  8726. array of ProcessInfo processInfo
  8727. # Supports additional targets discovery and allows to attach to them.
  8728. domain Target
  8729. type TargetID extends string
  8730. # Unique identifier of attached debugging session.
  8731. type SessionID extends string
  8732. type TargetInfo extends object
  8733. properties
  8734. TargetID targetId
  8735. string type
  8736. string title
  8737. string url
  8738. # Whether the target has an attached client.
  8739. boolean attached
  8740. # Opener target Id
  8741. optional TargetID openerId
  8742. # Whether the target has access to the originating window.
  8743. experimental boolean canAccessOpener
  8744. # Frame id of originating window (is only set if target has an opener).
  8745. experimental optional Page.FrameId openerFrameId
  8746. experimental optional Browser.BrowserContextID browserContextId
  8747. # Provides additional details for specific target types. For example, for
  8748. # the type of "page", this may be set to "portal" or "prerender".
  8749. experimental optional string subtype
  8750. # A filter used by target query/discovery/auto-attach operations.
  8751. experimental type FilterEntry extends object
  8752. properties
  8753. # If set, causes exclusion of mathcing targets from the list.
  8754. optional boolean exclude
  8755. # If not present, matches any type.
  8756. optional string type
  8757. # The entries in TargetFilter are matched sequentially against targets and
  8758. # the first entry that matches determines if the target is included or not,
  8759. # depending on the value of `exclude` field in the entry.
  8760. # If filter is not specified, the one assumed is
  8761. # [{type: "browser", exclude: true}, {type: "tab", exclude: true}, {}]
  8762. # (i.e. include everything but `browser` and `tab`).
  8763. experimental type TargetFilter extends array of FilterEntry
  8764. experimental type RemoteLocation extends object
  8765. properties
  8766. string host
  8767. integer port
  8768. # Activates (focuses) the target.
  8769. command activateTarget
  8770. parameters
  8771. TargetID targetId
  8772. # Attaches to the target with given id.
  8773. command attachToTarget
  8774. parameters
  8775. TargetID targetId
  8776. # Enables "flat" access to the session via specifying sessionId attribute in the commands.
  8777. # We plan to make this the default, deprecate non-flattened mode,
  8778. # and eventually retire it. See crbug.com/991325.
  8779. optional boolean flatten
  8780. returns
  8781. # Id assigned to the session.
  8782. SessionID sessionId
  8783. # Attaches to the browser target, only uses flat sessionId mode.
  8784. experimental command attachToBrowserTarget
  8785. returns
  8786. # Id assigned to the session.
  8787. SessionID sessionId
  8788. # Closes the target. If the target is a page that gets closed too.
  8789. command closeTarget
  8790. parameters
  8791. TargetID targetId
  8792. returns
  8793. # Always set to true. If an error occurs, the response indicates protocol error.
  8794. deprecated boolean success
  8795. # Inject object to the target's main frame that provides a communication
  8796. # channel with browser target.
  8797. #
  8798. # Injected object will be available as `window[bindingName]`.
  8799. #
  8800. # The object has the follwing API:
  8801. # - `binding.send(json)` - a method to send messages over the remote debugging protocol
  8802. # - `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.
  8803. experimental command exposeDevToolsProtocol
  8804. parameters
  8805. TargetID targetId
  8806. # Binding name, 'cdp' if not specified.
  8807. optional string bindingName
  8808. # Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than
  8809. # one.
  8810. experimental command createBrowserContext
  8811. parameters
  8812. # If specified, disposes this context when debugging session disconnects.
  8813. optional boolean disposeOnDetach
  8814. # Proxy server, similar to the one passed to --proxy-server
  8815. optional string proxyServer
  8816. # Proxy bypass list, similar to the one passed to --proxy-bypass-list
  8817. optional string proxyBypassList
  8818. # An optional list of origins to grant unlimited cross-origin access to.
  8819. # Parts of the URL other than those constituting origin are ignored.
  8820. optional array of string originsWithUniversalNetworkAccess
  8821. returns
  8822. # The id of the context created.
  8823. Browser.BrowserContextID browserContextId
  8824. # Returns all browser contexts created with `Target.createBrowserContext` method.
  8825. experimental command getBrowserContexts
  8826. returns
  8827. # An array of browser context ids.
  8828. array of Browser.BrowserContextID browserContextIds
  8829. # Creates a new page.
  8830. command createTarget
  8831. parameters
  8832. # The initial URL the page will be navigated to. An empty string indicates about:blank.
  8833. string url
  8834. # Frame width in DIP (headless chrome only).
  8835. optional integer width
  8836. # Frame height in DIP (headless chrome only).
  8837. optional integer height
  8838. # The browser context to create the page in.
  8839. experimental optional Browser.BrowserContextID browserContextId
  8840. # Whether BeginFrames for this target will be controlled via DevTools (headless chrome only,
  8841. # not supported on MacOS yet, false by default).
  8842. experimental optional boolean enableBeginFrameControl
  8843. # Whether to create a new Window or Tab (chrome-only, false by default).
  8844. optional boolean newWindow
  8845. # Whether to create the target in background or foreground (chrome-only,
  8846. # false by default).
  8847. optional boolean background
  8848. # Whether to create the target of type "tab".
  8849. experimental optional boolean forTab
  8850. returns
  8851. # The id of the page opened.
  8852. TargetID targetId
  8853. # Detaches session with given id.
  8854. command detachFromTarget
  8855. parameters
  8856. # Session to detach.
  8857. optional SessionID sessionId
  8858. # Deprecated.
  8859. deprecated optional TargetID targetId
  8860. # Deletes a BrowserContext. All the belonging pages will be closed without calling their
  8861. # beforeunload hooks.
  8862. experimental command disposeBrowserContext
  8863. parameters
  8864. Browser.BrowserContextID browserContextId
  8865. # Returns information about a target.
  8866. experimental command getTargetInfo
  8867. parameters
  8868. optional TargetID targetId
  8869. returns
  8870. TargetInfo targetInfo
  8871. # Retrieves a list of available targets.
  8872. command getTargets
  8873. parameters
  8874. # Only targets matching filter will be reported. If filter is not specified
  8875. # and target discovery is currently enabled, a filter used for target discovery
  8876. # is used for consistency.
  8877. experimental optional TargetFilter filter
  8878. returns
  8879. # The list of targets.
  8880. array of TargetInfo targetInfos
  8881. # Sends protocol message over session with given id.
  8882. # Consider using flat mode instead; see commands attachToTarget, setAutoAttach,
  8883. # and crbug.com/991325.
  8884. deprecated command sendMessageToTarget
  8885. parameters
  8886. string message
  8887. # Identifier of the session.
  8888. optional SessionID sessionId
  8889. # Deprecated.
  8890. deprecated optional TargetID targetId
  8891. # Controls whether to automatically attach to new targets which are considered to be related to
  8892. # this one. When turned on, attaches to all existing related targets as well. When turned off,
  8893. # automatically detaches from all currently attached targets.
  8894. # This also clears all targets added by `autoAttachRelated` from the list of targets to watch
  8895. # for creation of related targets.
  8896. experimental command setAutoAttach
  8897. parameters
  8898. # Whether to auto-attach to related targets.
  8899. boolean autoAttach
  8900. # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
  8901. # to run paused targets.
  8902. boolean waitForDebuggerOnStart
  8903. # Enables "flat" access to the session via specifying sessionId attribute in the commands.
  8904. # We plan to make this the default, deprecate non-flattened mode,
  8905. # and eventually retire it. See crbug.com/991325.
  8906. optional boolean flatten
  8907. # Only targets matching filter will be attached.
  8908. experimental optional TargetFilter filter
  8909. # Adds the specified target to the list of targets that will be monitored for any related target
  8910. # creation (such as child frames, child workers and new versions of service worker) and reported
  8911. # through `attachedToTarget`. The specified target is also auto-attached.
  8912. # This cancels the effect of any previous `setAutoAttach` and is also cancelled by subsequent
  8913. # `setAutoAttach`. Only available at the Browser target.
  8914. experimental command autoAttachRelated
  8915. parameters
  8916. TargetID targetId
  8917. # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
  8918. # to run paused targets.
  8919. boolean waitForDebuggerOnStart
  8920. # Only targets matching filter will be attached.
  8921. experimental optional TargetFilter filter
  8922. # Controls whether to discover available targets and notify via
  8923. # `targetCreated/targetInfoChanged/targetDestroyed` events.
  8924. command setDiscoverTargets
  8925. parameters
  8926. # Whether to discover available targets.
  8927. boolean discover
  8928. # Only targets matching filter will be attached. If `discover` is false,
  8929. # `filter` must be omitted or empty.
  8930. experimental optional TargetFilter filter
  8931. # Enables target discovery for the specified locations, when `setDiscoverTargets` was set to
  8932. # `true`.
  8933. experimental command setRemoteLocations
  8934. parameters
  8935. # List of remote locations.
  8936. array of RemoteLocation locations
  8937. # Issued when attached to target because of auto-attach or `attachToTarget` command.
  8938. experimental event attachedToTarget
  8939. parameters
  8940. # Identifier assigned to the session used to send/receive messages.
  8941. SessionID sessionId
  8942. TargetInfo targetInfo
  8943. boolean waitingForDebugger
  8944. # Issued when detached from target for any reason (including `detachFromTarget` command). Can be
  8945. # issued multiple times per target if multiple sessions have been attached to it.
  8946. experimental event detachedFromTarget
  8947. parameters
  8948. # Detached session identifier.
  8949. SessionID sessionId
  8950. # Deprecated.
  8951. deprecated optional TargetID targetId
  8952. # Notifies about a new protocol message received from the session (as reported in
  8953. # `attachedToTarget` event).
  8954. event receivedMessageFromTarget
  8955. parameters
  8956. # Identifier of a session which sends a message.
  8957. SessionID sessionId
  8958. string message
  8959. # Deprecated.
  8960. deprecated optional TargetID targetId
  8961. # Issued when a possible inspection target is created.
  8962. event targetCreated
  8963. parameters
  8964. TargetInfo targetInfo
  8965. # Issued when a target is destroyed.
  8966. event targetDestroyed
  8967. parameters
  8968. TargetID targetId
  8969. # Issued when a target has crashed.
  8970. event targetCrashed
  8971. parameters
  8972. TargetID targetId
  8973. # Termination status type.
  8974. string status
  8975. # Termination error code.
  8976. integer errorCode
  8977. # Issued when some information about a target has changed. This only happens between
  8978. # `targetCreated` and `targetDestroyed`.
  8979. event targetInfoChanged
  8980. parameters
  8981. TargetInfo targetInfo
  8982. # The Tethering domain defines methods and events for browser port binding.
  8983. experimental domain Tethering
  8984. # Request browser port binding.
  8985. command bind
  8986. parameters
  8987. # Port number to bind.
  8988. integer port
  8989. # Request browser port unbinding.
  8990. command unbind
  8991. parameters
  8992. # Port number to unbind.
  8993. integer port
  8994. # Informs that port was successfully bound and got a specified connection id.
  8995. event accepted
  8996. parameters
  8997. # Port number that was successfully bound.
  8998. integer port
  8999. # Connection id to be used.
  9000. string connectionId
  9001. experimental domain Tracing
  9002. depends on IO
  9003. # Configuration for memory dump. Used only when "memory-infra" category is enabled.
  9004. type MemoryDumpConfig extends object
  9005. type TraceConfig extends object
  9006. properties
  9007. # Controls how the trace buffer stores data.
  9008. optional enum recordMode
  9009. recordUntilFull
  9010. recordContinuously
  9011. recordAsMuchAsPossible
  9012. echoToConsole
  9013. # Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value
  9014. # of 200 MB would be used.
  9015. optional number traceBufferSizeInKb
  9016. # Turns on JavaScript stack sampling.
  9017. optional boolean enableSampling
  9018. # Turns on system tracing.
  9019. optional boolean enableSystrace
  9020. # Turns on argument filter.
  9021. optional boolean enableArgumentFilter
  9022. # Included category filters.
  9023. optional array of string includedCategories
  9024. # Excluded category filters.
  9025. optional array of string excludedCategories
  9026. # Configuration to synthesize the delays in tracing.
  9027. optional array of string syntheticDelays
  9028. # Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.
  9029. optional MemoryDumpConfig memoryDumpConfig
  9030. # Data format of a trace. Can be either the legacy JSON format or the
  9031. # protocol buffer format. Note that the JSON format will be deprecated soon.
  9032. type StreamFormat extends string
  9033. enum
  9034. json
  9035. proto
  9036. # Compression type to use for traces returned via streams.
  9037. type StreamCompression extends string
  9038. enum
  9039. none
  9040. gzip
  9041. # Details exposed when memory request explicitly declared.
  9042. # Keep consistent with memory_dump_request_args.h and
  9043. # memory_instrumentation.mojom
  9044. type MemoryDumpLevelOfDetail extends string
  9045. enum
  9046. background
  9047. light
  9048. detailed
  9049. # Backend type to use for tracing. `chrome` uses the Chrome-integrated
  9050. # tracing service and is supported on all platforms. `system` is only
  9051. # supported on Chrome OS and uses the Perfetto system tracing service.
  9052. # `auto` chooses `system` when the perfettoConfig provided to Tracing.start
  9053. # specifies at least one non-Chrome data source; otherwise uses `chrome`.
  9054. type TracingBackend extends string
  9055. enum
  9056. auto
  9057. chrome
  9058. system
  9059. # Stop trace events collection.
  9060. command end
  9061. # Gets supported tracing categories.
  9062. command getCategories
  9063. returns
  9064. # A list of supported tracing categories.
  9065. array of string categories
  9066. # Record a clock sync marker in the trace.
  9067. command recordClockSyncMarker
  9068. parameters
  9069. # The ID of this clock sync marker
  9070. string syncId
  9071. # Request a global memory dump.
  9072. command requestMemoryDump
  9073. parameters
  9074. # Enables more deterministic results by forcing garbage collection
  9075. optional boolean deterministic
  9076. # Specifies level of details in memory dump. Defaults to "detailed".
  9077. optional MemoryDumpLevelOfDetail levelOfDetail
  9078. returns
  9079. # GUID of the resulting global memory dump.
  9080. string dumpGuid
  9081. # True iff the global memory dump succeeded.
  9082. boolean success
  9083. # Start trace events collection.
  9084. command start
  9085. parameters
  9086. # Category/tag filter
  9087. deprecated optional string categories
  9088. # Tracing options
  9089. deprecated optional string options
  9090. # If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
  9091. optional number bufferUsageReportingInterval
  9092. # Whether to report trace events as series of dataCollected events or to save trace to a
  9093. # stream (defaults to `ReportEvents`).
  9094. optional enum transferMode
  9095. ReportEvents
  9096. ReturnAsStream
  9097. # Trace data format to use. This only applies when using `ReturnAsStream`
  9098. # transfer mode (defaults to `json`).
  9099. optional StreamFormat streamFormat
  9100. # Compression format to use. This only applies when using `ReturnAsStream`
  9101. # transfer mode (defaults to `none`)
  9102. optional StreamCompression streamCompression
  9103. optional TraceConfig traceConfig
  9104. # Base64-encoded serialized perfetto.protos.TraceConfig protobuf message
  9105. # When specified, the parameters `categories`, `options`, `traceConfig`
  9106. # are ignored.
  9107. optional binary perfettoConfig
  9108. # Backend type (defaults to `auto`)
  9109. optional TracingBackend tracingBackend
  9110. event bufferUsage
  9111. parameters
  9112. # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
  9113. # total size.
  9114. optional number percentFull
  9115. # An approximate number of events in the trace log.
  9116. optional number eventCount
  9117. # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
  9118. # total size.
  9119. optional number value
  9120. # Contains a bucket of collected trace events. When tracing is stopped collected events will be
  9121. # sent as a sequence of dataCollected events followed by tracingComplete event.
  9122. event dataCollected
  9123. parameters
  9124. array of object value
  9125. # Signals that tracing is stopped and there is no trace buffers pending flush, all data were
  9126. # delivered via dataCollected events.
  9127. event tracingComplete
  9128. parameters
  9129. # Indicates whether some trace data is known to have been lost, e.g. because the trace ring
  9130. # buffer wrapped around.
  9131. boolean dataLossOccurred
  9132. # A handle of the stream that holds resulting trace data.
  9133. optional IO.StreamHandle stream
  9134. # Trace data format of returned stream.
  9135. optional StreamFormat traceFormat
  9136. # Compression format of returned stream.
  9137. optional StreamCompression streamCompression
  9138. # A domain for letting clients substitute browser's network layer with client code.
  9139. domain Fetch
  9140. depends on Network
  9141. depends on IO
  9142. depends on Page
  9143. # Unique request identifier.
  9144. type RequestId extends string
  9145. # Stages of the request to handle. Request will intercept before the request is
  9146. # sent. Response will intercept after the response is received (but before response
  9147. # body is received).
  9148. type RequestStage extends string
  9149. enum
  9150. Request
  9151. Response
  9152. type RequestPattern extends object
  9153. properties
  9154. # Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
  9155. # backslash. Omitting is equivalent to `"*"`.
  9156. optional string urlPattern
  9157. # If set, only requests for matching resource types will be intercepted.
  9158. optional Network.ResourceType resourceType
  9159. # Stage at which to begin intercepting requests. Default is Request.
  9160. optional RequestStage requestStage
  9161. # Response HTTP header entry
  9162. type HeaderEntry extends object
  9163. properties
  9164. string name
  9165. string value
  9166. # Authorization challenge for HTTP status code 401 or 407.
  9167. type AuthChallenge extends object
  9168. properties
  9169. # Source of the authentication challenge.
  9170. optional enum source
  9171. Server
  9172. Proxy
  9173. # Origin of the challenger.
  9174. string origin
  9175. # The authentication scheme used, such as basic or digest
  9176. string scheme
  9177. # The realm of the challenge. May be empty.
  9178. string realm
  9179. # Response to an AuthChallenge.
  9180. type AuthChallengeResponse extends object
  9181. properties
  9182. # The decision on what to do in response to the authorization challenge. Default means
  9183. # deferring to the default behavior of the net stack, which will likely either the Cancel
  9184. # authentication or display a popup dialog box.
  9185. enum response
  9186. Default
  9187. CancelAuth
  9188. ProvideCredentials
  9189. # The username to provide, possibly empty. Should only be set if response is
  9190. # ProvideCredentials.
  9191. optional string username
  9192. # The password to provide, possibly empty. Should only be set if response is
  9193. # ProvideCredentials.
  9194. optional string password
  9195. # Disables the fetch domain.
  9196. command disable
  9197. # Enables issuing of requestPaused events. A request will be paused until client
  9198. # calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
  9199. command enable
  9200. parameters
  9201. # If specified, only requests matching any of these patterns will produce
  9202. # fetchRequested event and will be paused until clients response. If not set,
  9203. # all requests will be affected.
  9204. optional array of RequestPattern patterns
  9205. # If true, authRequired events will be issued and requests will be paused
  9206. # expecting a call to continueWithAuth.
  9207. optional boolean handleAuthRequests
  9208. # Causes the request to fail with specified reason.
  9209. command failRequest
  9210. parameters
  9211. # An id the client received in requestPaused event.
  9212. RequestId requestId
  9213. # Causes the request to fail with the given reason.
  9214. Network.ErrorReason errorReason
  9215. # Provides response to the request.
  9216. command fulfillRequest
  9217. parameters
  9218. # An id the client received in requestPaused event.
  9219. RequestId requestId
  9220. # An HTTP response code.
  9221. integer responseCode
  9222. # Response headers.
  9223. optional array of HeaderEntry responseHeaders
  9224. # Alternative way of specifying response headers as a \0-separated
  9225. # series of name: value pairs. Prefer the above method unless you
  9226. # need to represent some non-UTF8 values that can't be transmitted
  9227. # over the protocol as text.
  9228. optional binary binaryResponseHeaders
  9229. # A response body. If absent, original response body will be used if
  9230. # the request is intercepted at the response stage and empty body
  9231. # will be used if the request is intercepted at the request stage.
  9232. optional binary body
  9233. # A textual representation of responseCode.
  9234. # If absent, a standard phrase matching responseCode is used.
  9235. optional string responsePhrase
  9236. # Continues the request, optionally modifying some of its parameters.
  9237. command continueRequest
  9238. parameters
  9239. # An id the client received in requestPaused event.
  9240. RequestId requestId
  9241. # If set, the request url will be modified in a way that's not observable by page.
  9242. optional string url
  9243. # If set, the request method is overridden.
  9244. optional string method
  9245. # If set, overrides the post data in the request.
  9246. optional binary postData
  9247. # If set, overrides the request headers. Note that the overrides do not
  9248. # extend to subsequent redirect hops, if a redirect happens. Another override
  9249. # may be applied to a different request produced by a redirect.
  9250. optional array of HeaderEntry headers
  9251. # If set, overrides response interception behavior for this request.
  9252. experimental optional boolean interceptResponse
  9253. # Continues a request supplying authChallengeResponse following authRequired event.
  9254. command continueWithAuth
  9255. parameters
  9256. # An id the client received in authRequired event.
  9257. RequestId requestId
  9258. # Response to with an authChallenge.
  9259. AuthChallengeResponse authChallengeResponse
  9260. # Continues loading of the paused response, optionally modifying the
  9261. # response headers. If either responseCode or headers are modified, all of them
  9262. # must be present.
  9263. experimental command continueResponse
  9264. parameters
  9265. # An id the client received in requestPaused event.
  9266. RequestId requestId
  9267. # An HTTP response code. If absent, original response code will be used.
  9268. optional integer responseCode
  9269. # A textual representation of responseCode.
  9270. # If absent, a standard phrase matching responseCode is used.
  9271. optional string responsePhrase
  9272. # Response headers. If absent, original response headers will be used.
  9273. optional array of HeaderEntry responseHeaders
  9274. # Alternative way of specifying response headers as a \0-separated
  9275. # series of name: value pairs. Prefer the above method unless you
  9276. # need to represent some non-UTF8 values that can't be transmitted
  9277. # over the protocol as text.
  9278. optional binary binaryResponseHeaders
  9279. # Causes the body of the response to be received from the server and
  9280. # returned as a single string. May only be issued for a request that
  9281. # is paused in the Response stage and is mutually exclusive with
  9282. # takeResponseBodyForInterceptionAsStream. Calling other methods that
  9283. # affect the request or disabling fetch domain before body is received
  9284. # results in an undefined behavior.
  9285. command getResponseBody
  9286. parameters
  9287. # Identifier for the intercepted request to get body for.
  9288. RequestId requestId
  9289. returns
  9290. # Response body.
  9291. string body
  9292. # True, if content was sent as base64.
  9293. boolean base64Encoded
  9294. # Returns a handle to the stream representing the response body.
  9295. # The request must be paused in the HeadersReceived stage.
  9296. # Note that after this command the request can't be continued
  9297. # as is -- client either needs to cancel it or to provide the
  9298. # response body.
  9299. # The stream only supports sequential read, IO.read will fail if the position
  9300. # is specified.
  9301. # This method is mutually exclusive with getResponseBody.
  9302. # Calling other methods that affect the request or disabling fetch
  9303. # domain before body is received results in an undefined behavior.
  9304. command takeResponseBodyAsStream
  9305. parameters
  9306. RequestId requestId
  9307. returns
  9308. IO.StreamHandle stream
  9309. # Issued when the domain is enabled and the request URL matches the
  9310. # specified filter. The request is paused until the client responds
  9311. # with one of continueRequest, failRequest or fulfillRequest.
  9312. # The stage of the request can be determined by presence of responseErrorReason
  9313. # and responseStatusCode -- the request is at the response stage if either
  9314. # of these fields is present and in the request stage otherwise.
  9315. event requestPaused
  9316. parameters
  9317. # Each request the page makes will have a unique id.
  9318. RequestId requestId
  9319. # The details of the request.
  9320. Network.Request request
  9321. # The id of the frame that initiated the request.
  9322. Page.FrameId frameId
  9323. # How the requested resource will be used.
  9324. Network.ResourceType resourceType
  9325. # Response error if intercepted at response stage.
  9326. optional Network.ErrorReason responseErrorReason
  9327. # Response code if intercepted at response stage.
  9328. optional integer responseStatusCode
  9329. # Response status text if intercepted at response stage.
  9330. optional string responseStatusText
  9331. # Response headers if intercepted at the response stage.
  9332. optional array of HeaderEntry responseHeaders
  9333. # If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
  9334. # then this networkId will be the same as the requestId present in the requestWillBeSent event.
  9335. optional Network.RequestId networkId
  9336. # If the request is due to a redirect response from the server, the id of the request that
  9337. # has caused the redirect.
  9338. experimental optional RequestId redirectedRequestId
  9339. # Issued when the domain is enabled with handleAuthRequests set to true.
  9340. # The request is paused until client responds with continueWithAuth.
  9341. event authRequired
  9342. parameters
  9343. # Each request the page makes will have a unique id.
  9344. RequestId requestId
  9345. # The details of the request.
  9346. Network.Request request
  9347. # The id of the frame that initiated the request.
  9348. Page.FrameId frameId
  9349. # How the requested resource will be used.
  9350. Network.ResourceType resourceType
  9351. # Details of the Authorization Challenge encountered.
  9352. # If this is set, client should respond with continueRequest that
  9353. # contains AuthChallengeResponse.
  9354. AuthChallenge authChallenge
  9355. # This domain allows inspection of Web Audio API.
  9356. # https://webaudio.github.io/web-audio-api/
  9357. experimental domain WebAudio
  9358. # An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
  9359. type GraphObjectId extends string
  9360. # Enum of BaseAudioContext types
  9361. type ContextType extends string
  9362. enum
  9363. realtime
  9364. offline
  9365. # Enum of AudioContextState from the spec
  9366. type ContextState extends string
  9367. enum
  9368. suspended
  9369. running
  9370. closed
  9371. # Enum of AudioNode types
  9372. type NodeType extends string
  9373. # Enum of AudioNode::ChannelCountMode from the spec
  9374. type ChannelCountMode extends string
  9375. enum
  9376. clamped-max
  9377. explicit
  9378. max
  9379. # Enum of AudioNode::ChannelInterpretation from the spec
  9380. type ChannelInterpretation extends string
  9381. enum
  9382. discrete
  9383. speakers
  9384. # Enum of AudioParam types
  9385. type ParamType extends string
  9386. # Enum of AudioParam::AutomationRate from the spec
  9387. type AutomationRate extends string
  9388. enum
  9389. a-rate
  9390. k-rate
  9391. # Fields in AudioContext that change in real-time.
  9392. type ContextRealtimeData extends object
  9393. properties
  9394. # The current context time in second in BaseAudioContext.
  9395. number currentTime
  9396. # The time spent on rendering graph divided by render quantum duration,
  9397. # and multiplied by 100. 100 means the audio renderer reached the full
  9398. # capacity and glitch may occur.
  9399. number renderCapacity
  9400. # A running mean of callback interval.
  9401. number callbackIntervalMean
  9402. # A running variance of callback interval.
  9403. number callbackIntervalVariance
  9404. # Protocol object for BaseAudioContext
  9405. type BaseAudioContext extends object
  9406. properties
  9407. GraphObjectId contextId
  9408. ContextType contextType
  9409. ContextState contextState
  9410. optional ContextRealtimeData realtimeData
  9411. # Platform-dependent callback buffer size.
  9412. number callbackBufferSize
  9413. # Number of output channels supported by audio hardware in use.
  9414. number maxOutputChannelCount
  9415. # Context sample rate.
  9416. number sampleRate
  9417. # Protocol object for AudioListener
  9418. type AudioListener extends object
  9419. properties
  9420. GraphObjectId listenerId
  9421. GraphObjectId contextId
  9422. # Protocol object for AudioNode
  9423. type AudioNode extends object
  9424. properties
  9425. GraphObjectId nodeId
  9426. GraphObjectId contextId
  9427. NodeType nodeType
  9428. number numberOfInputs
  9429. number numberOfOutputs
  9430. number channelCount
  9431. ChannelCountMode channelCountMode
  9432. ChannelInterpretation channelInterpretation
  9433. # Protocol object for AudioParam
  9434. type AudioParam extends object
  9435. properties
  9436. GraphObjectId paramId
  9437. GraphObjectId nodeId
  9438. GraphObjectId contextId
  9439. ParamType paramType
  9440. AutomationRate rate
  9441. number defaultValue
  9442. number minValue
  9443. number maxValue
  9444. # Enables the WebAudio domain and starts sending context lifetime events.
  9445. command enable
  9446. # Disables the WebAudio domain.
  9447. command disable
  9448. # Fetch the realtime data from the registered contexts.
  9449. command getRealtimeData
  9450. parameters
  9451. GraphObjectId contextId
  9452. returns
  9453. ContextRealtimeData realtimeData
  9454. # Notifies that a new BaseAudioContext has been created.
  9455. event contextCreated
  9456. parameters
  9457. BaseAudioContext context
  9458. # Notifies that an existing BaseAudioContext will be destroyed.
  9459. event contextWillBeDestroyed
  9460. parameters
  9461. GraphObjectId contextId
  9462. # Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
  9463. event contextChanged
  9464. parameters
  9465. BaseAudioContext context
  9466. # Notifies that the construction of an AudioListener has finished.
  9467. event audioListenerCreated
  9468. parameters
  9469. AudioListener listener
  9470. # Notifies that a new AudioListener has been created.
  9471. event audioListenerWillBeDestroyed
  9472. parameters
  9473. GraphObjectId contextId
  9474. GraphObjectId listenerId
  9475. # Notifies that a new AudioNode has been created.
  9476. event audioNodeCreated
  9477. parameters
  9478. AudioNode node
  9479. # Notifies that an existing AudioNode has been destroyed.
  9480. event audioNodeWillBeDestroyed
  9481. parameters
  9482. GraphObjectId contextId
  9483. GraphObjectId nodeId
  9484. # Notifies that a new AudioParam has been created.
  9485. event audioParamCreated
  9486. parameters
  9487. AudioParam param
  9488. # Notifies that an existing AudioParam has been destroyed.
  9489. event audioParamWillBeDestroyed
  9490. parameters
  9491. GraphObjectId contextId
  9492. GraphObjectId nodeId
  9493. GraphObjectId paramId
  9494. # Notifies that two AudioNodes are connected.
  9495. event nodesConnected
  9496. parameters
  9497. GraphObjectId contextId
  9498. GraphObjectId sourceId
  9499. GraphObjectId destinationId
  9500. optional number sourceOutputIndex
  9501. optional number destinationInputIndex
  9502. # Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
  9503. event nodesDisconnected
  9504. parameters
  9505. GraphObjectId contextId
  9506. GraphObjectId sourceId
  9507. GraphObjectId destinationId
  9508. optional number sourceOutputIndex
  9509. optional number destinationInputIndex
  9510. # Notifies that an AudioNode is connected to an AudioParam.
  9511. event nodeParamConnected
  9512. parameters
  9513. GraphObjectId contextId
  9514. GraphObjectId sourceId
  9515. GraphObjectId destinationId
  9516. optional number sourceOutputIndex
  9517. # Notifies that an AudioNode is disconnected to an AudioParam.
  9518. event nodeParamDisconnected
  9519. parameters
  9520. GraphObjectId contextId
  9521. GraphObjectId sourceId
  9522. GraphObjectId destinationId
  9523. optional number sourceOutputIndex
  9524. # This domain allows configuring virtual authenticators to test the WebAuthn
  9525. # API.
  9526. experimental domain WebAuthn
  9527. type AuthenticatorId extends string
  9528. type AuthenticatorProtocol extends string
  9529. enum
  9530. # Universal 2nd Factor.
  9531. u2f
  9532. # Client To Authenticator Protocol 2.
  9533. ctap2
  9534. type Ctap2Version extends string
  9535. enum
  9536. ctap2_0
  9537. ctap2_1
  9538. type AuthenticatorTransport extends string
  9539. enum
  9540. # Cross-Platform authenticator attachments:
  9541. usb
  9542. nfc
  9543. ble
  9544. cable
  9545. # Platform authenticator attachment:
  9546. internal
  9547. type VirtualAuthenticatorOptions extends object
  9548. properties
  9549. AuthenticatorProtocol protocol
  9550. # Defaults to ctap2_0. Ignored if |protocol| == u2f.
  9551. optional Ctap2Version ctap2Version
  9552. AuthenticatorTransport transport
  9553. # Defaults to false.
  9554. optional boolean hasResidentKey
  9555. # Defaults to false.
  9556. optional boolean hasUserVerification
  9557. # If set to true, the authenticator will support the largeBlob extension.
  9558. # https://w3c.github.io/webauthn#largeBlob
  9559. # Defaults to false.
  9560. optional boolean hasLargeBlob
  9561. # If set to true, the authenticator will support the credBlob extension.
  9562. # https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
  9563. # Defaults to false.
  9564. optional boolean hasCredBlob
  9565. # If set to true, the authenticator will support the minPinLength extension.
  9566. # https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension
  9567. # Defaults to false.
  9568. optional boolean hasMinPinLength
  9569. # If set to true, the authenticator will support the prf extension.
  9570. # https://w3c.github.io/webauthn/#prf-extension
  9571. # Defaults to false.
  9572. optional boolean hasPrf
  9573. # If set to true, tests of user presence will succeed immediately.
  9574. # Otherwise, they will not be resolved. Defaults to true.
  9575. optional boolean automaticPresenceSimulation
  9576. # Sets whether User Verification succeeds or fails for an authenticator.
  9577. # Defaults to false.
  9578. optional boolean isUserVerified
  9579. type Credential extends object
  9580. properties
  9581. binary credentialId
  9582. boolean isResidentCredential
  9583. # Relying Party ID the credential is scoped to. Must be set when adding a
  9584. # credential.
  9585. optional string rpId
  9586. # The ECDSA P-256 private key in PKCS#8 format.
  9587. binary privateKey
  9588. # An opaque byte sequence with a maximum size of 64 bytes mapping the
  9589. # credential to a specific user.
  9590. optional binary userHandle
  9591. # Signature counter. This is incremented by one for each successful
  9592. # assertion.
  9593. # See https://w3c.github.io/webauthn/#signature-counter
  9594. integer signCount
  9595. # The large blob associated with the credential.
  9596. # See https://w3c.github.io/webauthn/#sctn-large-blob-extension
  9597. optional binary largeBlob
  9598. # Enable the WebAuthn domain and start intercepting credential storage and
  9599. # retrieval with a virtual authenticator.
  9600. command enable
  9601. parameters
  9602. # Whether to enable the WebAuthn user interface. Enabling the UI is
  9603. # recommended for debugging and demo purposes, as it is closer to the real
  9604. # experience. Disabling the UI is recommended for automated testing.
  9605. # Supported at the embedder's discretion if UI is available.
  9606. # Defaults to false.
  9607. optional boolean enableUI
  9608. # Disable the WebAuthn domain.
  9609. command disable
  9610. # Creates and adds a virtual authenticator.
  9611. command addVirtualAuthenticator
  9612. parameters
  9613. VirtualAuthenticatorOptions options
  9614. returns
  9615. AuthenticatorId authenticatorId
  9616. # Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
  9617. command setResponseOverrideBits
  9618. parameters
  9619. AuthenticatorId authenticatorId
  9620. # If isBogusSignature is set, overrides the signature in the authenticator response to be zero.
  9621. # Defaults to false.
  9622. optional boolean isBogusSignature
  9623. # If isBadUV is set, overrides the UV bit in the flags in the authenticator response to
  9624. # be zero. Defaults to false.
  9625. optional boolean isBadUV
  9626. # If isBadUP is set, overrides the UP bit in the flags in the authenticator response to
  9627. # be zero. Defaults to false.
  9628. optional boolean isBadUP
  9629. # Removes the given authenticator.
  9630. command removeVirtualAuthenticator
  9631. parameters
  9632. AuthenticatorId authenticatorId
  9633. # Adds the credential to the specified authenticator.
  9634. command addCredential
  9635. parameters
  9636. AuthenticatorId authenticatorId
  9637. Credential credential
  9638. # Returns a single credential stored in the given virtual authenticator that
  9639. # matches the credential ID.
  9640. command getCredential
  9641. parameters
  9642. AuthenticatorId authenticatorId
  9643. binary credentialId
  9644. returns
  9645. Credential credential
  9646. # Returns all the credentials stored in the given virtual authenticator.
  9647. command getCredentials
  9648. parameters
  9649. AuthenticatorId authenticatorId
  9650. returns
  9651. array of Credential credentials
  9652. # Removes a credential from the authenticator.
  9653. command removeCredential
  9654. parameters
  9655. AuthenticatorId authenticatorId
  9656. binary credentialId
  9657. # Clears all the credentials from the specified device.
  9658. command clearCredentials
  9659. parameters
  9660. AuthenticatorId authenticatorId
  9661. # Sets whether User Verification succeeds or fails for an authenticator.
  9662. # The default is true.
  9663. command setUserVerified
  9664. parameters
  9665. AuthenticatorId authenticatorId
  9666. boolean isUserVerified
  9667. # Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
  9668. # The default is true.
  9669. command setAutomaticPresenceSimulation
  9670. parameters
  9671. AuthenticatorId authenticatorId
  9672. boolean enabled
  9673. # Triggered when a credential is added to an authenticator.
  9674. event credentialAdded
  9675. parameters
  9676. AuthenticatorId authenticatorId
  9677. Credential credential
  9678. # Triggered when a credential is used in a webauthn assertion.
  9679. event credentialAsserted
  9680. parameters
  9681. AuthenticatorId authenticatorId
  9682. Credential credential
  9683. # This domain allows detailed inspection of media elements
  9684. experimental domain Media
  9685. # Players will get an ID that is unique within the agent context.
  9686. type PlayerId extends string
  9687. type Timestamp extends number
  9688. # Have one type per entry in MediaLogRecord::Type
  9689. # Corresponds to kMessage
  9690. type PlayerMessage extends object
  9691. properties
  9692. # Keep in sync with MediaLogMessageLevel
  9693. # We are currently keeping the message level 'error' separate from the
  9694. # PlayerError type because right now they represent different things,
  9695. # this one being a DVLOG(ERROR) style log message that gets printed
  9696. # based on what log level is selected in the UI, and the other is a
  9697. # representation of a media::PipelineStatus object. Soon however we're
  9698. # going to be moving away from using PipelineStatus for errors and
  9699. # introducing a new error type which should hopefully let us integrate
  9700. # the error log level into the PlayerError type.
  9701. enum level
  9702. error
  9703. warning
  9704. info
  9705. debug
  9706. string message
  9707. # Corresponds to kMediaPropertyChange
  9708. type PlayerProperty extends object
  9709. properties
  9710. string name
  9711. string value
  9712. # Corresponds to kMediaEventTriggered
  9713. type PlayerEvent extends object
  9714. properties
  9715. Timestamp timestamp
  9716. string value
  9717. # Represents logged source line numbers reported in an error.
  9718. # NOTE: file and line are from chromium c++ implementation code, not js.
  9719. type PlayerErrorSourceLocation extends object
  9720. properties
  9721. string file
  9722. integer line
  9723. # Corresponds to kMediaError
  9724. type PlayerError extends object
  9725. properties
  9726. string errorType
  9727. # Code is the numeric enum entry for a specific set of error codes, such
  9728. # as PipelineStatusCodes in media/base/pipeline_status.h
  9729. integer code
  9730. # A trace of where this error was caused / where it passed through.
  9731. array of PlayerErrorSourceLocation stack
  9732. # Errors potentially have a root cause error, ie, a DecoderError might be
  9733. # caused by an WindowsError
  9734. array of PlayerError cause
  9735. # Extra data attached to an error, such as an HRESULT, Video Codec, etc.
  9736. object data
  9737. # This can be called multiple times, and can be used to set / override /
  9738. # remove player properties. A null propValue indicates removal.
  9739. event playerPropertiesChanged
  9740. parameters
  9741. PlayerId playerId
  9742. array of PlayerProperty properties
  9743. # Send events as a list, allowing them to be batched on the browser for less
  9744. # congestion. If batched, events must ALWAYS be in chronological order.
  9745. event playerEventsAdded
  9746. parameters
  9747. PlayerId playerId
  9748. array of PlayerEvent events
  9749. # Send a list of any messages that need to be delivered.
  9750. event playerMessagesLogged
  9751. parameters
  9752. PlayerId playerId
  9753. array of PlayerMessage messages
  9754. # Send a list of any errors that need to be delivered.
  9755. event playerErrorsRaised
  9756. parameters
  9757. PlayerId playerId
  9758. array of PlayerError errors
  9759. # Called whenever a player is created, or when a new agent joins and receives
  9760. # a list of active players. If an agent is restored, it will receive the full
  9761. # list of player ids and all events again.
  9762. event playersCreated
  9763. parameters
  9764. array of PlayerId players
  9765. # Enables the Media domain
  9766. command enable
  9767. # Disables the Media domain.
  9768. command disable
  9769. experimental domain DeviceAccess
  9770. # Device request id.
  9771. type RequestId extends string
  9772. # A device id.
  9773. type DeviceId extends string
  9774. # Device information displayed in a user prompt to select a device.
  9775. type PromptDevice extends object
  9776. properties
  9777. DeviceId id
  9778. # Display name as it appears in a device request user prompt.
  9779. string name
  9780. # Enable events in this domain.
  9781. command enable
  9782. # Disable events in this domain.
  9783. command disable
  9784. # Select a device in response to a DeviceAccess.deviceRequestPrompted event.
  9785. command selectPrompt
  9786. parameters
  9787. RequestId id
  9788. DeviceId deviceId
  9789. # Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
  9790. command cancelPrompt
  9791. parameters
  9792. RequestId id
  9793. # A device request opened a user prompt to select a device. Respond with the
  9794. # selectPrompt or cancelPrompt command.
  9795. event deviceRequestPrompted
  9796. parameters
  9797. RequestId id
  9798. array of PromptDevice devices
  9799. experimental domain Preload
  9800. # Unique id
  9801. type RuleSetId extends string
  9802. # Corresponds to SpeculationRuleSet
  9803. type RuleSet extends object
  9804. properties
  9805. RuleSetId id
  9806. # Identifies a document which the rule set is associated with.
  9807. Network.LoaderId loaderId
  9808. # Source text of JSON representing the rule set. If it comes from
  9809. # <script> tag, it is the textContent of the node. Note that it is
  9810. # a JSON for valid case.
  9811. #
  9812. # See also:
  9813. # - https://wicg.github.io/nav-speculation/speculation-rules.html
  9814. # - https://github.com/WICG/nav-speculation/blob/main/triggers.md
  9815. string sourceText
  9816. # A speculation rule set is either added through an inline
  9817. # <script> tag or through an external resource via the
  9818. # 'Speculation-Rules' HTTP header. For the first case, we include
  9819. # the BackendNodeId of the relevant <script> tag. For the second
  9820. # case, we include the external URL where the rule set was loaded
  9821. # from, and also RequestId if Network domain is enabled.
  9822. #
  9823. # See also:
  9824. # - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
  9825. # - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
  9826. optional DOM.BackendNodeId backendNodeId
  9827. optional string url
  9828. optional Network.RequestId requestId
  9829. # Error information
  9830. # `errorMessage` is null iff `errorType` is null.
  9831. optional RuleSetErrorType errorType
  9832. # TODO(https://crbug.com/1425354): Replace this property with structured error.
  9833. deprecated optional string errorMessage
  9834. type RuleSetErrorType extends string
  9835. enum
  9836. SourceIsNotJsonObject
  9837. InvalidRulesSkipped
  9838. # The type of preloading attempted. It corresponds to
  9839. # mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
  9840. # isn't being used by clients).
  9841. type SpeculationAction extends string
  9842. enum
  9843. Prefetch
  9844. Prerender
  9845. # Corresponds to mojom::SpeculationTargetHint.
  9846. # See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
  9847. type SpeculationTargetHint extends string
  9848. enum
  9849. Blank
  9850. Self
  9851. # A key that identifies a preloading attempt.
  9852. #
  9853. # The url used is the url specified by the trigger (i.e. the initial URL), and
  9854. # not the final url that is navigated to. For example, prerendering allows
  9855. # same-origin main frame navigations during the attempt, but the attempt is
  9856. # still keyed with the initial URL.
  9857. type PreloadingAttemptKey extends object
  9858. properties
  9859. Network.LoaderId loaderId
  9860. SpeculationAction action
  9861. string url
  9862. optional SpeculationTargetHint targetHint
  9863. # Lists sources for a preloading attempt, specifically the ids of rule sets
  9864. # that had a speculation rule that triggered the attempt, and the
  9865. # BackendNodeIds of <a href> or <area href> elements that triggered the
  9866. # attempt (in the case of attempts triggered by a document rule). It is
  9867. # possible for mulitple rule sets and links to trigger a single attempt.
  9868. type PreloadingAttemptSource extends object
  9869. properties
  9870. PreloadingAttemptKey key
  9871. array of RuleSetId ruleSetIds
  9872. array of DOM.BackendNodeId nodeIds
  9873. command enable
  9874. command disable
  9875. # Upsert. Currently, it is only emitted when a rule set added.
  9876. event ruleSetUpdated
  9877. parameters
  9878. RuleSet ruleSet
  9879. event ruleSetRemoved
  9880. parameters
  9881. RuleSetId id
  9882. # List of FinalStatus reasons for Prerender2.
  9883. type PrerenderFinalStatus extends string
  9884. enum
  9885. Activated
  9886. Destroyed
  9887. LowEndDevice
  9888. InvalidSchemeRedirect
  9889. InvalidSchemeNavigation
  9890. InProgressNavigation
  9891. NavigationRequestBlockedByCsp
  9892. MainFrameNavigation
  9893. MojoBinderPolicy
  9894. RendererProcessCrashed
  9895. RendererProcessKilled
  9896. Download
  9897. TriggerDestroyed
  9898. NavigationNotCommitted
  9899. NavigationBadHttpStatus
  9900. ClientCertRequested
  9901. NavigationRequestNetworkError
  9902. MaxNumOfRunningPrerendersExceeded
  9903. CancelAllHostsForTesting
  9904. DidFailLoad
  9905. Stop
  9906. SslCertificateError
  9907. LoginAuthRequested
  9908. UaChangeRequiresReload
  9909. BlockedByClient
  9910. AudioOutputDeviceRequested
  9911. MixedContent
  9912. TriggerBackgrounded
  9913. EmbedderTriggeredAndCrossOriginRedirected
  9914. MemoryLimitExceeded
  9915. # Prerenders can be cancelled when Chrome uses excessive memory. This is
  9916. # recorded when it fails to get the memory usage.
  9917. FailToGetMemoryUsage
  9918. DataSaverEnabled
  9919. HasEffectiveUrl
  9920. ActivatedBeforeStarted
  9921. InactivePageRestriction
  9922. StartFailed
  9923. TimeoutBackgrounded
  9924. CrossSiteRedirectInInitialNavigation
  9925. CrossSiteNavigationInInitialNavigation
  9926. SameSiteCrossOriginRedirectNotOptInInInitialNavigation
  9927. SameSiteCrossOriginNavigationNotOptInInInitialNavigation
  9928. ActivationNavigationParameterMismatch
  9929. ActivatedInBackground
  9930. EmbedderHostDisallowed
  9931. ActivationNavigationDestroyedBeforeSuccess
  9932. TabClosedByUserGesture
  9933. TabClosedWithoutUserGesture
  9934. PrimaryMainFrameRendererProcessCrashed
  9935. PrimaryMainFrameRendererProcessKilled
  9936. ActivationFramePolicyNotCompatible
  9937. PreloadingDisabled
  9938. BatterySaverEnabled
  9939. ActivatedDuringMainFrameNavigation
  9940. PreloadingUnsupportedByWebContents
  9941. CrossSiteRedirectInMainFrameNavigation
  9942. CrossSiteNavigationInMainFrameNavigation
  9943. SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation
  9944. SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation
  9945. MemoryPressureOnTrigger
  9946. MemoryPressureAfterTriggered
  9947. # Fired when a prerender attempt is completed.
  9948. event prerenderAttemptCompleted
  9949. parameters
  9950. PreloadingAttemptKey key
  9951. # The frame id of the frame initiating prerendering.
  9952. Page.FrameId initiatingFrameId
  9953. string prerenderingUrl
  9954. PrerenderFinalStatus finalStatus
  9955. # This is used to give users more information about the name of the API call
  9956. # that is incompatible with prerender and has caused the cancellation of the attempt
  9957. optional string disallowedApiMethod
  9958. # Fired when a preload enabled state is updated.
  9959. event preloadEnabledStateUpdated
  9960. parameters
  9961. boolean disabledByPreference
  9962. boolean disabledByDataSaver
  9963. boolean disabledByBatterySaver
  9964. # Preloading status values, see also PreloadingTriggeringOutcome. This
  9965. # status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
  9966. type PreloadingStatus extends string
  9967. enum
  9968. Pending
  9969. Running
  9970. Ready
  9971. Success
  9972. Failure
  9973. # PreloadingTriggeringOutcome which not used by prefetch nor prerender.
  9974. NotSupported
  9975. # TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
  9976. # filter out the ones that aren't necessary to the developers.
  9977. type PrefetchStatus extends string
  9978. enum
  9979. # Prefetch is not disabled by PrefetchHeldback.
  9980. PrefetchAllowed
  9981. PrefetchFailedIneligibleRedirect
  9982. PrefetchFailedInvalidRedirect
  9983. PrefetchFailedMIMENotSupported
  9984. PrefetchFailedNetError
  9985. PrefetchFailedNon2XX
  9986. PrefetchFailedPerPageLimitExceeded
  9987. PrefetchEvicted
  9988. PrefetchHeldback
  9989. # A previous prefetch to the origin got a HTTP 503 response with an
  9990. # Retry-After header that has no elapsed yet.
  9991. PrefetchIneligibleRetryAfter
  9992. PrefetchIsPrivacyDecoy
  9993. PrefetchIsStale
  9994. PrefetchNotEligibleBrowserContextOffTheRecord
  9995. PrefetchNotEligibleDataSaverEnabled
  9996. PrefetchNotEligibleExistingProxy
  9997. PrefetchNotEligibleHostIsNonUnique
  9998. PrefetchNotEligibleNonDefaultStoragePartition
  9999. PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy
  10000. PrefetchNotEligibleSchemeIsNotHttps
  10001. PrefetchNotEligibleUserHasCookies
  10002. PrefetchNotEligibleUserHasServiceWorker
  10003. PrefetchNotEligibleBatterySaverEnabled
  10004. PrefetchNotEligiblePreloadingDisabled
  10005. PrefetchNotFinishedInTime
  10006. PrefetchNotStarted
  10007. PrefetchNotUsedCookiesChanged
  10008. PrefetchProxyNotAvailable
  10009. # The response of the prefetch is used for the next navigation. This is
  10010. # the final successful state.
  10011. PrefetchResponseUsed
  10012. # The prefetch finished successfully but was never used.
  10013. PrefetchSuccessfulButNotUsed
  10014. PrefetchNotUsedProbeFailed
  10015. # Fired when a prefetch attempt is updated.
  10016. event prefetchStatusUpdated
  10017. parameters
  10018. PreloadingAttemptKey key
  10019. # The frame id of the frame initiating prefetch.
  10020. Page.FrameId initiatingFrameId
  10021. string prefetchUrl
  10022. PreloadingStatus status
  10023. PrefetchStatus prefetchStatus
  10024. # Fired when a prerender attempt is updated.
  10025. event prerenderStatusUpdated
  10026. parameters
  10027. PreloadingAttemptKey key
  10028. PreloadingStatus status
  10029. optional PrerenderFinalStatus prerenderStatus
  10030. # Send a list of sources for all preloading attempts in a document.
  10031. event preloadingAttemptSourcesUpdated
  10032. parameters
  10033. Network.LoaderId loaderId
  10034. array of PreloadingAttemptSource preloadingAttemptSources
  10035. # This domain allows interacting with the FedCM dialog.
  10036. experimental domain FedCm
  10037. # Whether this is a sign-up or sign-in action for this account, i.e.
  10038. # whether this account has ever been used to sign in to this RP before.
  10039. type LoginState extends string
  10040. enum
  10041. SignIn
  10042. SignUp
  10043. # Whether the dialog shown is an account chooser or an auto re-authentication dialog.
  10044. type DialogType extends string
  10045. enum
  10046. AccountChooser
  10047. AutoReauthn
  10048. # Corresponds to IdentityRequestAccount
  10049. type Account extends object
  10050. properties
  10051. string accountId
  10052. string email
  10053. string name
  10054. string givenName
  10055. string pictureUrl
  10056. string idpConfigUrl
  10057. string idpSigninUrl
  10058. LoginState loginState
  10059. # These two are only set if the loginState is signUp
  10060. optional string termsOfServiceUrl
  10061. optional string privacyPolicyUrl
  10062. event dialogShown
  10063. parameters
  10064. string dialogId
  10065. DialogType dialogType
  10066. array of Account accounts
  10067. # These exist primarily so that the caller can verify the
  10068. # RP context was used appropriately.
  10069. string title
  10070. optional string subtitle
  10071. command enable
  10072. parameters
  10073. # Allows callers to disable the promise rejection delay that would
  10074. # normally happen, if this is unimportant to what's being tested.
  10075. # (step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
  10076. optional boolean disableRejectionDelay
  10077. command disable
  10078. command selectAccount
  10079. parameters
  10080. string dialogId
  10081. integer accountIndex
  10082. command dismissDialog
  10083. parameters
  10084. string dialogId
  10085. optional boolean triggerCooldown
  10086. # Resets the cooldown time, if any, to allow the next FedCM call to show
  10087. # a dialog even if one was recently dismissed by the user.
  10088. command resetCooldown