Software zum Installieren eines Smart-Mirror Frameworks , zum Nutzen von hochschulrelevanten Informationen, auf einem Raspberry-Pi.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

browser_protocol.pdl 283KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460
  1. # Copyright 2017 The Chromium Authors. All rights reserved.
  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://docs.google.com/document/d/1c-COD2kaK__5iMM5SEx-PzNA7HFmgttcYfOHHX0HaOM/edit?usp=sharing
  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. figcaption
  46. label
  47. labelfor
  48. labelwrapped
  49. legend
  50. tablecaption
  51. title
  52. other
  53. # A single source for a computed AX property.
  54. type AXValueSource extends object
  55. properties
  56. # What type of source this is.
  57. AXValueSourceType type
  58. # The value of this property source.
  59. optional AXValue value
  60. # The name of the relevant attribute, if any.
  61. optional string attribute
  62. # The value of the relevant attribute, if any.
  63. optional AXValue attributeValue
  64. # Whether this source is superseded by a higher priority source.
  65. optional boolean superseded
  66. # The native markup source for this value, e.g. a <label> element.
  67. optional AXValueNativeSourceType nativeSource
  68. # The value, such as a node or node list, of the native source.
  69. optional AXValue nativeSourceValue
  70. # Whether the value for this property is invalid.
  71. optional boolean invalid
  72. # Reason for the value being invalid, if it is.
  73. optional string invalidReason
  74. type AXRelatedNode extends object
  75. properties
  76. # The BackendNodeId of the related DOM node.
  77. DOM.BackendNodeId backendDOMNodeId
  78. # The IDRef value provided, if any.
  79. optional string idref
  80. # The text alternative of this node in the current context.
  81. optional string text
  82. type AXProperty extends object
  83. properties
  84. # The name of this property.
  85. AXPropertyName name
  86. # The value of this property.
  87. AXValue value
  88. # A single computed AX property.
  89. type AXValue extends object
  90. properties
  91. # The type of this value.
  92. AXValueType type
  93. # The computed value of this property.
  94. optional any value
  95. # One or more related nodes, if applicable.
  96. optional array of AXRelatedNode relatedNodes
  97. # The sources which contributed to the computation of this property.
  98. optional array of AXValueSource sources
  99. # Values of AXProperty name:
  100. # - from 'busy' to 'roledescription': states which apply to every AX node
  101. # - from 'live' to 'root': attributes which apply to nodes in live regions
  102. # - from 'autocomplete' to 'valuetext': attributes which apply to widgets
  103. # - from 'checked' to 'selected': states which apply to widgets
  104. # - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
  105. type AXPropertyName extends string
  106. enum
  107. busy
  108. disabled
  109. editable
  110. focusable
  111. focused
  112. hidden
  113. hiddenRoot
  114. invalid
  115. keyshortcuts
  116. settable
  117. roledescription
  118. live
  119. atomic
  120. relevant
  121. root
  122. autocomplete
  123. hasPopup
  124. level
  125. multiselectable
  126. orientation
  127. multiline
  128. readonly
  129. required
  130. valuemin
  131. valuemax
  132. valuetext
  133. checked
  134. expanded
  135. modal
  136. pressed
  137. selected
  138. activedescendant
  139. controls
  140. describedby
  141. details
  142. errormessage
  143. flowto
  144. labelledby
  145. owns
  146. # A node in the accessibility tree.
  147. type AXNode extends object
  148. properties
  149. # Unique identifier for this node.
  150. AXNodeId nodeId
  151. # Whether this node is ignored for accessibility
  152. boolean ignored
  153. # Collection of reasons why this node is hidden.
  154. optional array of AXProperty ignoredReasons
  155. # This `Node`'s role, whether explicit or implicit.
  156. optional AXValue role
  157. # The accessible name for this `Node`.
  158. optional AXValue name
  159. # The accessible description for this `Node`.
  160. optional AXValue description
  161. # The value for this `Node`.
  162. optional AXValue value
  163. # All other properties
  164. optional array of AXProperty properties
  165. # IDs for each of this node's child nodes.
  166. optional array of AXNodeId childIds
  167. # The backend ID for the associated DOM node, if any.
  168. optional DOM.BackendNodeId backendDOMNodeId
  169. # Disables the accessibility domain.
  170. command disable
  171. # Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
  172. # This turns on accessibility for the page, which can impact performance until accessibility is disabled.
  173. command enable
  174. # Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
  175. experimental command getPartialAXTree
  176. parameters
  177. # Identifier of the node to get the partial accessibility tree for.
  178. optional DOM.NodeId nodeId
  179. # Identifier of the backend node to get the partial accessibility tree for.
  180. optional DOM.BackendNodeId backendNodeId
  181. # JavaScript object id of the node wrapper to get the partial accessibility tree for.
  182. optional Runtime.RemoteObjectId objectId
  183. # Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
  184. optional boolean fetchRelatives
  185. returns
  186. # The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and
  187. # children, if requested.
  188. array of AXNode nodes
  189. # Fetches the entire accessibility tree
  190. experimental command getFullAXTree
  191. returns
  192. array of AXNode nodes
  193. # Query a DOM node's accessibility subtree for accessible name and role.
  194. # This command computes the name and role for all nodes in the subtree, including those that are
  195. # ignored for accessibility, and returns those that mactch the specified name and role. If no DOM
  196. # node is specified, or the DOM node does not exist, the command returns an error. If neither
  197. # `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree.
  198. experimental command queryAXTree
  199. parameters
  200. # Identifier of the node for the root to query.
  201. optional DOM.NodeId nodeId
  202. # Identifier of the backend node for the root to query.
  203. optional DOM.BackendNodeId backendNodeId
  204. # JavaScript object id of the node wrapper for the root to query.
  205. optional Runtime.RemoteObjectId objectId
  206. # Find nodes with this computed name.
  207. optional string accessibleName
  208. # Find nodes with this computed role.
  209. optional string role
  210. returns
  211. # A list of `Accessibility.AXNode` matching the specified attributes,
  212. # including nodes that are ignored for accessibility.
  213. array of AXNode nodes
  214. experimental domain Animation
  215. depends on Runtime
  216. depends on DOM
  217. # Animation instance.
  218. type Animation extends object
  219. properties
  220. # `Animation`'s id.
  221. string id
  222. # `Animation`'s name.
  223. string name
  224. # `Animation`'s internal paused state.
  225. boolean pausedState
  226. # `Animation`'s play state.
  227. string playState
  228. # `Animation`'s playback rate.
  229. number playbackRate
  230. # `Animation`'s start time.
  231. number startTime
  232. # `Animation`'s current time.
  233. number currentTime
  234. # Animation type of `Animation`.
  235. enum type
  236. CSSTransition
  237. CSSAnimation
  238. WebAnimation
  239. # `Animation`'s source animation node.
  240. optional AnimationEffect source
  241. # A unique ID for `Animation` representing the sources that triggered this CSS
  242. # animation/transition.
  243. optional string cssId
  244. # AnimationEffect instance
  245. type AnimationEffect extends object
  246. properties
  247. # `AnimationEffect`'s delay.
  248. number delay
  249. # `AnimationEffect`'s end delay.
  250. number endDelay
  251. # `AnimationEffect`'s iteration start.
  252. number iterationStart
  253. # `AnimationEffect`'s iterations.
  254. number iterations
  255. # `AnimationEffect`'s iteration duration.
  256. number duration
  257. # `AnimationEffect`'s playback direction.
  258. string direction
  259. # `AnimationEffect`'s fill mode.
  260. string fill
  261. # `AnimationEffect`'s target node.
  262. optional DOM.BackendNodeId backendNodeId
  263. # `AnimationEffect`'s keyframes.
  264. optional KeyframesRule keyframesRule
  265. # `AnimationEffect`'s timing function.
  266. string easing
  267. # Keyframes Rule
  268. type KeyframesRule extends object
  269. properties
  270. # CSS keyframed animation's name.
  271. optional string name
  272. # List of animation keyframes.
  273. array of KeyframeStyle keyframes
  274. # Keyframe Style
  275. type KeyframeStyle extends object
  276. properties
  277. # Keyframe's time offset.
  278. string offset
  279. # `AnimationEffect`'s timing function.
  280. string easing
  281. # Disables animation domain notifications.
  282. command disable
  283. # Enables animation domain notifications.
  284. command enable
  285. # Returns the current time of the an animation.
  286. command getCurrentTime
  287. parameters
  288. # Id of animation.
  289. string id
  290. returns
  291. # Current time of the page.
  292. number currentTime
  293. # Gets the playback rate of the document timeline.
  294. command getPlaybackRate
  295. returns
  296. # Playback rate for animations on page.
  297. number playbackRate
  298. # Releases a set of animations to no longer be manipulated.
  299. command releaseAnimations
  300. parameters
  301. # List of animation ids to seek.
  302. array of string animations
  303. # Gets the remote object of the Animation.
  304. command resolveAnimation
  305. parameters
  306. # Animation id.
  307. string animationId
  308. returns
  309. # Corresponding remote object.
  310. Runtime.RemoteObject remoteObject
  311. # Seek a set of animations to a particular time within each animation.
  312. command seekAnimations
  313. parameters
  314. # List of animation ids to seek.
  315. array of string animations
  316. # Set the current time of each animation.
  317. number currentTime
  318. # Sets the paused state of a set of animations.
  319. command setPaused
  320. parameters
  321. # Animations to set the pause state of.
  322. array of string animations
  323. # Paused state to set to.
  324. boolean paused
  325. # Sets the playback rate of the document timeline.
  326. command setPlaybackRate
  327. parameters
  328. # Playback rate for animations on page
  329. number playbackRate
  330. # Sets the timing of an animation node.
  331. command setTiming
  332. parameters
  333. # Animation id.
  334. string animationId
  335. # Duration of the animation.
  336. number duration
  337. # Delay of the animation.
  338. number delay
  339. # Event for when an animation has been cancelled.
  340. event animationCanceled
  341. parameters
  342. # Id of the animation that was cancelled.
  343. string id
  344. # Event for each animation that has been created.
  345. event animationCreated
  346. parameters
  347. # Id of the animation that was created.
  348. string id
  349. # Event for animation that has been started.
  350. event animationStarted
  351. parameters
  352. # Animation that was started.
  353. Animation animation
  354. experimental domain ApplicationCache
  355. depends on Page
  356. # Detailed application cache resource information.
  357. type ApplicationCacheResource extends object
  358. properties
  359. # Resource url.
  360. string url
  361. # Resource size.
  362. integer size
  363. # Resource type.
  364. string type
  365. # Detailed application cache information.
  366. type ApplicationCache extends object
  367. properties
  368. # Manifest URL.
  369. string manifestURL
  370. # Application cache size.
  371. number size
  372. # Application cache creation time.
  373. number creationTime
  374. # Application cache update time.
  375. number updateTime
  376. # Application cache resources.
  377. array of ApplicationCacheResource resources
  378. # Frame identifier - manifest URL pair.
  379. type FrameWithManifest extends object
  380. properties
  381. # Frame identifier.
  382. Page.FrameId frameId
  383. # Manifest URL.
  384. string manifestURL
  385. # Application cache status.
  386. integer status
  387. # Enables application cache domain notifications.
  388. command enable
  389. # Returns relevant application cache data for the document in given frame.
  390. command getApplicationCacheForFrame
  391. parameters
  392. # Identifier of the frame containing document whose application cache is retrieved.
  393. Page.FrameId frameId
  394. returns
  395. # Relevant application cache data for the document in given frame.
  396. ApplicationCache applicationCache
  397. # Returns array of frame identifiers with manifest urls for each frame containing a document
  398. # associated with some application cache.
  399. command getFramesWithManifests
  400. returns
  401. # Array of frame identifiers with manifest urls for each frame containing a document
  402. # associated with some application cache.
  403. array of FrameWithManifest frameIds
  404. # Returns manifest URL for document in the given frame.
  405. command getManifestForFrame
  406. parameters
  407. # Identifier of the frame containing document whose manifest is retrieved.
  408. Page.FrameId frameId
  409. returns
  410. # Manifest URL for document in the given frame.
  411. string manifestURL
  412. event applicationCacheStatusUpdated
  413. parameters
  414. # Identifier of the frame containing document whose application cache updated status.
  415. Page.FrameId frameId
  416. # Manifest URL.
  417. string manifestURL
  418. # Updated application cache status.
  419. integer status
  420. event networkStateUpdated
  421. parameters
  422. boolean isNowOnline
  423. # Audits domain allows investigation of page violations and possible improvements.
  424. experimental domain Audits
  425. depends on Network
  426. # Information about a cookie that is affected by an inspector issue.
  427. type AffectedCookie extends object
  428. properties
  429. # The following three properties uniquely identify a cookie
  430. string name
  431. string path
  432. string domain
  433. # Information about a request that is affected by an inspector issue.
  434. type AffectedRequest extends object
  435. properties
  436. # The unique request id.
  437. Network.RequestId requestId
  438. optional string url
  439. # Information about the frame affected by an inspector issue.
  440. type AffectedFrame extends object
  441. properties
  442. Page.FrameId frameId
  443. type SameSiteCookieExclusionReason extends string
  444. enum
  445. ExcludeSameSiteUnspecifiedTreatedAsLax
  446. ExcludeSameSiteNoneInsecure
  447. ExcludeSameSiteLax
  448. ExcludeSameSiteStrict
  449. type SameSiteCookieWarningReason extends string
  450. enum
  451. WarnSameSiteUnspecifiedCrossSiteContext
  452. WarnSameSiteNoneInsecure
  453. WarnSameSiteUnspecifiedLaxAllowUnsafe
  454. WarnSameSiteStrictLaxDowngradeStrict
  455. WarnSameSiteStrictCrossDowngradeStrict
  456. WarnSameSiteStrictCrossDowngradeLax
  457. WarnSameSiteLaxCrossDowngradeStrict
  458. WarnSameSiteLaxCrossDowngradeLax
  459. type SameSiteCookieOperation extends string
  460. enum
  461. SetCookie
  462. ReadCookie
  463. # This information is currently necessary, as the front-end has a difficult
  464. # time finding a specific cookie. With this, we can convey specific error
  465. # information without the cookie.
  466. type SameSiteCookieIssueDetails extends object
  467. properties
  468. AffectedCookie cookie
  469. array of SameSiteCookieWarningReason cookieWarningReasons
  470. array of SameSiteCookieExclusionReason cookieExclusionReasons
  471. # Optionally identifies the site-for-cookies and the cookie url, which
  472. # may be used by the front-end as additional context.
  473. SameSiteCookieOperation operation
  474. optional string siteForCookies
  475. optional string cookieUrl
  476. optional AffectedRequest request
  477. type MixedContentResolutionStatus extends string
  478. enum
  479. MixedContentBlocked
  480. MixedContentAutomaticallyUpgraded
  481. MixedContentWarning
  482. type MixedContentResourceType extends string
  483. enum
  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. type SourceCodeLocation extends object
  571. properties
  572. string url
  573. integer lineNumber
  574. integer columnNumber
  575. type ContentSecurityPolicyIssueDetails extends object
  576. properties
  577. # The url not included in allowed sources.
  578. optional string blockedURL
  579. # Specific directive that is violated, causing the CSP issue.
  580. string violatedDirective
  581. boolean isReportOnly
  582. ContentSecurityPolicyViolationType contentSecurityPolicyViolationType
  583. optional AffectedFrame frameAncestor
  584. optional SourceCodeLocation sourceCodeLocation
  585. optional DOM.BackendNodeId violatingNodeId
  586. # A unique identifier for the type of issue. Each type may use one of the
  587. # optional fields in InspectorIssueDetails to convey more specific
  588. # information about the kind of issue.
  589. type InspectorIssueCode extends string
  590. enum
  591. SameSiteCookieIssue
  592. MixedContentIssue
  593. BlockedByResponseIssue
  594. HeavyAdIssue
  595. ContentSecurityPolicyIssue
  596. # This struct holds a list of optional fields with additional information
  597. # specific to the kind of issue. When adding a new issue code, please also
  598. # add a new optional field to this type.
  599. type InspectorIssueDetails extends object
  600. properties
  601. optional SameSiteCookieIssueDetails sameSiteCookieIssueDetails
  602. optional MixedContentIssueDetails mixedContentIssueDetails
  603. optional BlockedByResponseIssueDetails blockedByResponseIssueDetails
  604. optional HeavyAdIssueDetails heavyAdIssueDetails
  605. optional ContentSecurityPolicyIssueDetails contentSecurityPolicyIssueDetails
  606. # An inspector issue reported from the back-end.
  607. type InspectorIssue extends object
  608. properties
  609. InspectorIssueCode code
  610. InspectorIssueDetails details
  611. # Returns the response body and size if it were re-encoded with the specified settings. Only
  612. # applies to images.
  613. command getEncodedResponse
  614. parameters
  615. # Identifier of the network request to get content for.
  616. Network.RequestId requestId
  617. # The encoding to use.
  618. enum encoding
  619. webp
  620. jpeg
  621. png
  622. # The quality of the encoding (0-1). (defaults to 1)
  623. optional number quality
  624. # Whether to only return the size information (defaults to false).
  625. optional boolean sizeOnly
  626. returns
  627. # The encoded body as a base64 string. Omitted if sizeOnly is true.
  628. optional binary body
  629. # Size before re-encoding.
  630. integer originalSize
  631. # Size after re-encoding.
  632. integer encodedSize
  633. # Disables issues domain, prevents further issues from being reported to the client.
  634. command disable
  635. # Enables issues domain, sends the issues collected so far to the client by means of the
  636. # `issueAdded` event.
  637. command enable
  638. event issueAdded
  639. parameters
  640. InspectorIssue issue
  641. # Defines events for background web platform features.
  642. experimental domain BackgroundService
  643. # The Background Service that will be associated with the commands/events.
  644. # Every Background Service operates independently, but they share the same
  645. # API.
  646. type ServiceName extends string
  647. enum
  648. backgroundFetch
  649. backgroundSync
  650. pushMessaging
  651. notifications
  652. paymentHandler
  653. periodicBackgroundSync
  654. # Enables event updates for the service.
  655. command startObserving
  656. parameters
  657. ServiceName service
  658. # Disables event updates for the service.
  659. command stopObserving
  660. parameters
  661. ServiceName service
  662. # Set the recording state for the service.
  663. command setRecording
  664. parameters
  665. boolean shouldRecord
  666. ServiceName service
  667. # Clears all stored data for the service.
  668. command clearEvents
  669. parameters
  670. ServiceName service
  671. # Called when the recording state for the service has been updated.
  672. event recordingStateChanged
  673. parameters
  674. boolean isRecording
  675. ServiceName service
  676. # A key-value pair for additional event information to pass along.
  677. type EventMetadata extends object
  678. properties
  679. string key
  680. string value
  681. type BackgroundServiceEvent extends object
  682. properties
  683. # Timestamp of the event (in seconds).
  684. Network.TimeSinceEpoch timestamp
  685. # The origin this event belongs to.
  686. string origin
  687. # The Service Worker ID that initiated the event.
  688. ServiceWorker.RegistrationID serviceWorkerRegistrationId
  689. # The Background Service this event belongs to.
  690. ServiceName service
  691. # A description of the event.
  692. string eventName
  693. # An identifier that groups related events together.
  694. string instanceId
  695. # A list of event-specific information.
  696. array of EventMetadata eventMetadata
  697. # Called with all existing backgroundServiceEvents when enabled, and all new
  698. # events afterwards if enabled and recording.
  699. event backgroundServiceEventReceived
  700. parameters
  701. BackgroundServiceEvent backgroundServiceEvent
  702. # The Browser domain defines methods and events for browser managing.
  703. domain Browser
  704. experimental type BrowserContextID extends string
  705. experimental type WindowID extends integer
  706. # The state of the browser window.
  707. experimental type WindowState extends string
  708. enum
  709. normal
  710. minimized
  711. maximized
  712. fullscreen
  713. # Browser window bounds information
  714. experimental type Bounds extends object
  715. properties
  716. # The offset from the left edge of the screen to the window in pixels.
  717. optional integer left
  718. # The offset from the top edge of the screen to the window in pixels.
  719. optional integer top
  720. # The window width in pixels.
  721. optional integer width
  722. # The window height in pixels.
  723. optional integer height
  724. # The window state. Default to normal.
  725. optional WindowState windowState
  726. experimental type PermissionType extends string
  727. enum
  728. accessibilityEvents
  729. audioCapture
  730. backgroundSync
  731. backgroundFetch
  732. clipboardReadWrite
  733. clipboardSanitizedWrite
  734. durableStorage
  735. flash
  736. geolocation
  737. midi
  738. midiSysex
  739. nfc
  740. notifications
  741. paymentHandler
  742. periodicBackgroundSync
  743. protectedMediaIdentifier
  744. sensors
  745. videoCapture
  746. videoCapturePanTiltZoom
  747. idleDetection
  748. wakeLockScreen
  749. wakeLockSystem
  750. experimental type PermissionSetting extends string
  751. enum
  752. granted
  753. denied
  754. prompt
  755. # Definition of PermissionDescriptor defined in the Permissions API:
  756. # https://w3c.github.io/permissions/#dictdef-permissiondescriptor.
  757. experimental type PermissionDescriptor extends object
  758. properties
  759. # Name of permission.
  760. # See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
  761. string name
  762. # For "midi" permission, may also specify sysex control.
  763. optional boolean sysex
  764. # For "push" permission, may specify userVisibleOnly.
  765. # Note that userVisibleOnly = true is the only currently supported type.
  766. optional boolean userVisibleOnly
  767. # For "clipboard" permission, may specify allowWithoutSanitization.
  768. optional boolean allowWithoutSanitization
  769. # For "camera" permission, may specify panTiltZoom.
  770. optional boolean panTiltZoom
  771. # Set permission settings for given origin.
  772. experimental command setPermission
  773. parameters
  774. # Descriptor of permission to override.
  775. PermissionDescriptor permission
  776. # Setting of the permission.
  777. PermissionSetting setting
  778. # Origin the permission applies to, all origins if not specified.
  779. optional string origin
  780. # Context to override. When omitted, default browser context is used.
  781. optional BrowserContextID browserContextId
  782. # Grant specific permissions to the given origin and reject all others.
  783. experimental command grantPermissions
  784. parameters
  785. array of PermissionType permissions
  786. # Origin the permission applies to, all origins if not specified.
  787. optional string origin
  788. # BrowserContext to override permissions. When omitted, default browser context is used.
  789. optional BrowserContextID browserContextId
  790. # Reset all permission management for all origins.
  791. experimental command resetPermissions
  792. parameters
  793. # BrowserContext to reset permissions. When omitted, default browser context is used.
  794. optional BrowserContextID browserContextId
  795. # Set the behavior when downloading a file.
  796. experimental command setDownloadBehavior
  797. parameters
  798. # Whether to allow all or deny all download requests, or use default Chrome behavior if
  799. # available (otherwise deny). |allowAndName| allows download and names files according to
  800. # their dowmload guids.
  801. enum behavior
  802. deny
  803. allow
  804. allowAndName
  805. default
  806. # BrowserContext to set download behavior. When omitted, default browser context is used.
  807. optional BrowserContextID browserContextId
  808. # The default path to save downloaded files to. This is requred if behavior is set to 'allow'
  809. # or 'allowAndName'.
  810. optional string downloadPath
  811. # Close browser gracefully.
  812. command close
  813. # Crashes browser on the main thread.
  814. experimental command crash
  815. # Crashes GPU process.
  816. experimental command crashGpuProcess
  817. # Returns version information.
  818. command getVersion
  819. returns
  820. # Protocol version.
  821. string protocolVersion
  822. # Product name.
  823. string product
  824. # Product revision.
  825. string revision
  826. # User-Agent.
  827. string userAgent
  828. # V8 version.
  829. string jsVersion
  830. # Returns the command line switches for the browser process if, and only if
  831. # --enable-automation is on the commandline.
  832. experimental command getBrowserCommandLine
  833. returns
  834. # Commandline parameters
  835. array of string arguments
  836. # Chrome histogram bucket.
  837. experimental type Bucket extends object
  838. properties
  839. # Minimum value (inclusive).
  840. integer low
  841. # Maximum value (exclusive).
  842. integer high
  843. # Number of samples.
  844. integer count
  845. # Chrome histogram.
  846. experimental type Histogram extends object
  847. properties
  848. # Name.
  849. string name
  850. # Sum of sample values.
  851. integer sum
  852. # Total number of samples.
  853. integer count
  854. # Buckets.
  855. array of Bucket buckets
  856. # Get Chrome histograms.
  857. experimental command getHistograms
  858. parameters
  859. # Requested substring in name. Only histograms which have query as a
  860. # substring in their name are extracted. An empty or absent query returns
  861. # all histograms.
  862. optional string query
  863. # If true, retrieve delta since last call.
  864. optional boolean delta
  865. returns
  866. # Histograms.
  867. array of Histogram histograms
  868. # Get a Chrome histogram by name.
  869. experimental command getHistogram
  870. parameters
  871. # Requested histogram name.
  872. string name
  873. # If true, retrieve delta since last call.
  874. optional boolean delta
  875. returns
  876. # Histogram.
  877. Histogram histogram
  878. # Get position and size of the browser window.
  879. experimental command getWindowBounds
  880. parameters
  881. # Browser window id.
  882. WindowID windowId
  883. returns
  884. # Bounds information of the window. When window state is 'minimized', the restored window
  885. # position and size are returned.
  886. Bounds bounds
  887. # Get the browser window that contains the devtools target.
  888. experimental command getWindowForTarget
  889. parameters
  890. # Devtools agent host id. If called as a part of the session, associated targetId is used.
  891. optional Target.TargetID targetId
  892. returns
  893. # Browser window id.
  894. WindowID windowId
  895. # Bounds information of the window. When window state is 'minimized', the restored window
  896. # position and size are returned.
  897. Bounds bounds
  898. # Set position and/or size of the browser window.
  899. experimental command setWindowBounds
  900. parameters
  901. # Browser window id.
  902. WindowID windowId
  903. # New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
  904. # with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
  905. Bounds bounds
  906. # Set dock tile details, platform-specific.
  907. experimental command setDockTile
  908. parameters
  909. optional string badgeLabel
  910. # Png encoded image.
  911. optional binary image
  912. # This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
  913. # have an associated `id` used in subsequent operations on the related object. Each object type has
  914. # a specific `id` structure, and those are not interchangeable between objects of different kinds.
  915. # CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
  916. # can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
  917. # subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
  918. experimental domain CSS
  919. depends on DOM
  920. depends on Page
  921. type StyleSheetId extends string
  922. # Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
  923. # stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
  924. # inspector" rules), "regular" for regular stylesheets.
  925. type StyleSheetOrigin extends string
  926. enum
  927. injected
  928. user-agent
  929. inspector
  930. regular
  931. # CSS rule collection for a single pseudo style.
  932. type PseudoElementMatches extends object
  933. properties
  934. # Pseudo element type.
  935. DOM.PseudoType pseudoType
  936. # Matches of CSS rules applicable to the pseudo style.
  937. array of RuleMatch matches
  938. # Inherited CSS rule collection from ancestor node.
  939. type InheritedStyleEntry extends object
  940. properties
  941. # The ancestor node's inline style, if any, in the style inheritance chain.
  942. optional CSSStyle inlineStyle
  943. # Matches of CSS rules matching the ancestor node in the style inheritance chain.
  944. array of RuleMatch matchedCSSRules
  945. # Match data for a CSS rule.
  946. type RuleMatch extends object
  947. properties
  948. # CSS rule in the match.
  949. CSSRule rule
  950. # Matching selector indices in the rule's selectorList selectors (0-based).
  951. array of integer matchingSelectors
  952. # Data for a simple selector (these are delimited by commas in a selector list).
  953. type Value extends object
  954. properties
  955. # Value text.
  956. string text
  957. # Value range in the underlying resource (if available).
  958. optional SourceRange range
  959. # Selector list data.
  960. type SelectorList extends object
  961. properties
  962. # Selectors in the list.
  963. array of Value selectors
  964. # Rule selector text.
  965. string text
  966. # CSS stylesheet metainformation.
  967. type CSSStyleSheetHeader extends object
  968. properties
  969. # The stylesheet identifier.
  970. StyleSheetId styleSheetId
  971. # Owner frame identifier.
  972. Page.FrameId frameId
  973. # Stylesheet resource URL.
  974. string sourceURL
  975. # URL of source map associated with the stylesheet (if any).
  976. optional string sourceMapURL
  977. # Stylesheet origin.
  978. StyleSheetOrigin origin
  979. # Stylesheet title.
  980. string title
  981. # The backend id for the owner node of the stylesheet.
  982. optional DOM.BackendNodeId ownerNode
  983. # Denotes whether the stylesheet is disabled.
  984. boolean disabled
  985. # Whether the sourceURL field value comes from the sourceURL comment.
  986. optional boolean hasSourceURL
  987. # Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
  988. # document.written STYLE tags.
  989. boolean isInline
  990. # Whether this stylesheet is mutable. Inline stylesheets become mutable
  991. # after they have been modified via CSSOM API.
  992. # <link> element's stylesheets become mutable only if DevTools modifies them.
  993. # Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
  994. boolean isMutable
  995. # Whether this stylesheet is a constructed stylesheet (created using new CSSStyleSheet()).
  996. boolean isConstructed
  997. # Line offset of the stylesheet within the resource (zero based).
  998. number startLine
  999. # Column offset of the stylesheet within the resource (zero based).
  1000. number startColumn
  1001. # Size of the content (in characters).
  1002. number length
  1003. # Line offset of the end of the stylesheet within the resource (zero based).
  1004. number endLine
  1005. # Column offset of the end of the stylesheet within the resource (zero based).
  1006. number endColumn
  1007. # CSS rule representation.
  1008. type CSSRule extends object
  1009. properties
  1010. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1011. # stylesheet rules) this rule came from.
  1012. optional StyleSheetId styleSheetId
  1013. # Rule selector data.
  1014. SelectorList selectorList
  1015. # Parent stylesheet's origin.
  1016. StyleSheetOrigin origin
  1017. # Associated style declaration.
  1018. CSSStyle style
  1019. # Media list array (for rules involving media queries). The array enumerates media queries
  1020. # starting with the innermost one, going outwards.
  1021. optional array of CSSMedia media
  1022. # CSS coverage information.
  1023. type RuleUsage extends object
  1024. properties
  1025. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1026. # stylesheet rules) this rule came from.
  1027. StyleSheetId styleSheetId
  1028. # Offset of the start of the rule (including selector) from the beginning of the stylesheet.
  1029. number startOffset
  1030. # Offset of the end of the rule body from the beginning of the stylesheet.
  1031. number endOffset
  1032. # Indicates whether the rule was actually used by some element in the page.
  1033. boolean used
  1034. # Text range within a resource. All numbers are zero-based.
  1035. type SourceRange extends object
  1036. properties
  1037. # Start line of range.
  1038. integer startLine
  1039. # Start column of range (inclusive).
  1040. integer startColumn
  1041. # End line of range
  1042. integer endLine
  1043. # End column of range (exclusive).
  1044. integer endColumn
  1045. type ShorthandEntry extends object
  1046. properties
  1047. # Shorthand name.
  1048. string name
  1049. # Shorthand value.
  1050. string value
  1051. # Whether the property has "!important" annotation (implies `false` if absent).
  1052. optional boolean important
  1053. type CSSComputedStyleProperty extends object
  1054. properties
  1055. # Computed style property name.
  1056. string name
  1057. # Computed style property value.
  1058. string value
  1059. # CSS style representation.
  1060. type CSSStyle extends object
  1061. properties
  1062. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1063. # stylesheet rules) this rule came from.
  1064. optional StyleSheetId styleSheetId
  1065. # CSS properties in the style.
  1066. array of CSSProperty cssProperties
  1067. # Computed values for all shorthands found in the style.
  1068. array of ShorthandEntry shorthandEntries
  1069. # Style declaration text (if available).
  1070. optional string cssText
  1071. # Style declaration range in the enclosing stylesheet (if available).
  1072. optional SourceRange range
  1073. # CSS property declaration data.
  1074. type CSSProperty extends object
  1075. properties
  1076. # The property name.
  1077. string name
  1078. # The property value.
  1079. string value
  1080. # Whether the property has "!important" annotation (implies `false` if absent).
  1081. optional boolean important
  1082. # Whether the property is implicit (implies `false` if absent).
  1083. optional boolean implicit
  1084. # The full property text as specified in the style.
  1085. optional string text
  1086. # Whether the property is understood by the browser (implies `true` if absent).
  1087. optional boolean parsedOk
  1088. # Whether the property is disabled by the user (present for source-based properties only).
  1089. optional boolean disabled
  1090. # The entire property range in the enclosing style declaration (if available).
  1091. optional SourceRange range
  1092. # CSS media rule descriptor.
  1093. type CSSMedia extends object
  1094. properties
  1095. # Media query text.
  1096. string text
  1097. # Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
  1098. # specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
  1099. # stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
  1100. # stylesheet's STYLE tag.
  1101. enum source
  1102. mediaRule
  1103. importRule
  1104. linkedSheet
  1105. inlineSheet
  1106. # URL of the document containing the media query description.
  1107. optional string sourceURL
  1108. # The associated rule (@media or @import) header range in the enclosing stylesheet (if
  1109. # available).
  1110. optional SourceRange range
  1111. # Identifier of the stylesheet containing this object (if exists).
  1112. optional StyleSheetId styleSheetId
  1113. # Array of media queries.
  1114. optional array of MediaQuery mediaList
  1115. # Media query descriptor.
  1116. type MediaQuery extends object
  1117. properties
  1118. # Array of media query expressions.
  1119. array of MediaQueryExpression expressions
  1120. # Whether the media query condition is satisfied.
  1121. boolean active
  1122. # Media query expression descriptor.
  1123. type MediaQueryExpression extends object
  1124. properties
  1125. # Media query expression value.
  1126. number value
  1127. # Media query expression units.
  1128. string unit
  1129. # Media query expression feature.
  1130. string feature
  1131. # The associated range of the value text in the enclosing stylesheet (if available).
  1132. optional SourceRange valueRange
  1133. # Computed length of media query expression (if applicable).
  1134. optional number computedLength
  1135. # Information about amount of glyphs that were rendered with given font.
  1136. type PlatformFontUsage extends object
  1137. properties
  1138. # Font's family name reported by platform.
  1139. string familyName
  1140. # Indicates if the font was downloaded or resolved locally.
  1141. boolean isCustomFont
  1142. # Amount of glyphs that were rendered with this font.
  1143. number glyphCount
  1144. # Information about font variation axes for variable fonts
  1145. type FontVariationAxis extends object
  1146. properties
  1147. # The font-variation-setting tag (a.k.a. "axis tag").
  1148. string tag
  1149. # Human-readable variation name in the default language (normally, "en").
  1150. string name
  1151. # The minimum value (inclusive) the font supports for this tag.
  1152. number minValue
  1153. # The maximum value (inclusive) the font supports for this tag.
  1154. number maxValue
  1155. # The default value.
  1156. number defaultValue
  1157. # Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
  1158. # and additional information such as platformFontFamily and fontVariationAxes.
  1159. type FontFace extends object
  1160. properties
  1161. # The font-family.
  1162. string fontFamily
  1163. # The font-style.
  1164. string fontStyle
  1165. # The font-variant.
  1166. string fontVariant
  1167. # The font-weight.
  1168. string fontWeight
  1169. # The font-stretch.
  1170. string fontStretch
  1171. # The unicode-range.
  1172. string unicodeRange
  1173. # The src.
  1174. string src
  1175. # The resolved platform font family
  1176. string platformFontFamily
  1177. # Available variation settings (a.k.a. "axes").
  1178. optional array of FontVariationAxis fontVariationAxes
  1179. # CSS keyframes rule representation.
  1180. type CSSKeyframesRule extends object
  1181. properties
  1182. # Animation name.
  1183. Value animationName
  1184. # List of keyframes.
  1185. array of CSSKeyframeRule keyframes
  1186. # CSS keyframe rule representation.
  1187. type CSSKeyframeRule extends object
  1188. properties
  1189. # The css style sheet identifier (absent for user agent stylesheet and user-specified
  1190. # stylesheet rules) this rule came from.
  1191. optional StyleSheetId styleSheetId
  1192. # Parent stylesheet's origin.
  1193. StyleSheetOrigin origin
  1194. # Associated key text.
  1195. Value keyText
  1196. # Associated style declaration.
  1197. CSSStyle style
  1198. # A descriptor of operation to mutate style declaration text.
  1199. type StyleDeclarationEdit extends object
  1200. properties
  1201. # The css style sheet identifier.
  1202. StyleSheetId styleSheetId
  1203. # The range of the style text in the enclosing stylesheet.
  1204. SourceRange range
  1205. # New style text.
  1206. string text
  1207. # Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
  1208. # position specified by `location`.
  1209. command addRule
  1210. parameters
  1211. # The css style sheet identifier where a new rule should be inserted.
  1212. StyleSheetId styleSheetId
  1213. # The text of a new rule.
  1214. string ruleText
  1215. # Text position of a new rule in the target style sheet.
  1216. SourceRange location
  1217. returns
  1218. # The newly created rule.
  1219. CSSRule rule
  1220. # Returns all class names from specified stylesheet.
  1221. command collectClassNames
  1222. parameters
  1223. StyleSheetId styleSheetId
  1224. returns
  1225. # Class name list.
  1226. array of string classNames
  1227. # Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
  1228. command createStyleSheet
  1229. parameters
  1230. # Identifier of the frame where "via-inspector" stylesheet should be created.
  1231. Page.FrameId frameId
  1232. returns
  1233. # Identifier of the created "via-inspector" stylesheet.
  1234. StyleSheetId styleSheetId
  1235. # Disables the CSS agent for the given page.
  1236. command disable
  1237. # Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
  1238. # enabled until the result of this command is received.
  1239. command enable
  1240. # Ensures that the given node will have specified pseudo-classes whenever its style is computed by
  1241. # the browser.
  1242. command forcePseudoState
  1243. parameters
  1244. # The element id for which to force the pseudo state.
  1245. DOM.NodeId nodeId
  1246. # Element pseudo classes to force when computing the element's style.
  1247. array of string forcedPseudoClasses
  1248. command getBackgroundColors
  1249. parameters
  1250. # Id of the node to get background colors for.
  1251. DOM.NodeId nodeId
  1252. returns
  1253. # The range of background colors behind this element, if it contains any visible text. If no
  1254. # visible text is present, this will be undefined. In the case of a flat background color,
  1255. # this will consist of simply that color. In the case of a gradient, this will consist of each
  1256. # of the color stops. For anything more complicated, this will be an empty array. Images will
  1257. # be ignored (as if the image had failed to load).
  1258. optional array of string backgroundColors
  1259. # The computed font size for this node, as a CSS computed value string (e.g. '12px').
  1260. optional string computedFontSize
  1261. # The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
  1262. # '100').
  1263. optional string computedFontWeight
  1264. # Returns the computed style for a DOM node identified by `nodeId`.
  1265. command getComputedStyleForNode
  1266. parameters
  1267. DOM.NodeId nodeId
  1268. returns
  1269. # Computed style for the specified DOM node.
  1270. array of CSSComputedStyleProperty computedStyle
  1271. # Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
  1272. # attributes) for a DOM node identified by `nodeId`.
  1273. command getInlineStylesForNode
  1274. parameters
  1275. DOM.NodeId nodeId
  1276. returns
  1277. # Inline style for the specified DOM node.
  1278. optional CSSStyle inlineStyle
  1279. # Attribute-defined element style (e.g. resulting from "width=20 height=100%").
  1280. optional CSSStyle attributesStyle
  1281. # Returns requested styles for a DOM node identified by `nodeId`.
  1282. command getMatchedStylesForNode
  1283. parameters
  1284. DOM.NodeId nodeId
  1285. returns
  1286. # Inline style for the specified DOM node.
  1287. optional CSSStyle inlineStyle
  1288. # Attribute-defined element style (e.g. resulting from "width=20 height=100%").
  1289. optional CSSStyle attributesStyle
  1290. # CSS rules matching this node, from all applicable stylesheets.
  1291. optional array of RuleMatch matchedCSSRules
  1292. # Pseudo style matches for this node.
  1293. optional array of PseudoElementMatches pseudoElements
  1294. # A chain of inherited styles (from the immediate node parent up to the DOM tree root).
  1295. optional array of InheritedStyleEntry inherited
  1296. # A list of CSS keyframed animations matching this node.
  1297. optional array of CSSKeyframesRule cssKeyframesRules
  1298. # Returns all media queries parsed by the rendering engine.
  1299. command getMediaQueries
  1300. returns
  1301. array of CSSMedia medias
  1302. # Requests information about platform fonts which we used to render child TextNodes in the given
  1303. # node.
  1304. command getPlatformFontsForNode
  1305. parameters
  1306. DOM.NodeId nodeId
  1307. returns
  1308. # Usage statistics for every employed platform font.
  1309. array of PlatformFontUsage fonts
  1310. # Returns the current textual content for a stylesheet.
  1311. command getStyleSheetText
  1312. parameters
  1313. StyleSheetId styleSheetId
  1314. returns
  1315. # The stylesheet text.
  1316. string text
  1317. # Starts tracking the given computed styles for updates. The specified array of properties
  1318. # replaces the one previously specified. Pass empty array to disable tracking.
  1319. # Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
  1320. # The changes to computed style properties are only tracked for nodes pushed to the front-end
  1321. # by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
  1322. # to the front-end, no updates will be issued for the node.
  1323. experimental command trackComputedStyleUpdates
  1324. parameters
  1325. array of CSSComputedStyleProperty propertiesToTrack
  1326. # Polls the next batch of computed style updates.
  1327. experimental command takeComputedStyleUpdates
  1328. returns
  1329. # The list of node Ids that have their tracked computed styles updated
  1330. array of DOM.NodeId nodeIds
  1331. # Find a rule with the given active property for the given node and set the new value for this
  1332. # property
  1333. command setEffectivePropertyValueForNode
  1334. parameters
  1335. # The element id for which to set property.
  1336. DOM.NodeId nodeId
  1337. string propertyName
  1338. string value
  1339. # Modifies the keyframe rule key text.
  1340. command setKeyframeKey
  1341. parameters
  1342. StyleSheetId styleSheetId
  1343. SourceRange range
  1344. string keyText
  1345. returns
  1346. # The resulting key text after modification.
  1347. Value keyText
  1348. # Modifies the rule selector.
  1349. command setMediaText
  1350. parameters
  1351. StyleSheetId styleSheetId
  1352. SourceRange range
  1353. string text
  1354. returns
  1355. # The resulting CSS media rule after modification.
  1356. CSSMedia media
  1357. # Modifies the rule selector.
  1358. command setRuleSelector
  1359. parameters
  1360. StyleSheetId styleSheetId
  1361. SourceRange range
  1362. string selector
  1363. returns
  1364. # The resulting selector list after modification.
  1365. SelectorList selectorList
  1366. # Sets the new stylesheet text.
  1367. command setStyleSheetText
  1368. parameters
  1369. StyleSheetId styleSheetId
  1370. string text
  1371. returns
  1372. # URL of source map associated with script (if any).
  1373. optional string sourceMapURL
  1374. # Applies specified style edits one after another in the given order.
  1375. command setStyleTexts
  1376. parameters
  1377. array of StyleDeclarationEdit edits
  1378. returns
  1379. # The resulting styles after modification.
  1380. array of CSSStyle styles
  1381. # Enables the selector recording.
  1382. command startRuleUsageTracking
  1383. # Stop tracking rule usage and return the list of rules that were used since last call to
  1384. # `takeCoverageDelta` (or since start of coverage instrumentation)
  1385. command stopRuleUsageTracking
  1386. returns
  1387. array of RuleUsage ruleUsage
  1388. # Obtain list of rules that became used since last call to this method (or since start of coverage
  1389. # instrumentation)
  1390. command takeCoverageDelta
  1391. returns
  1392. array of RuleUsage coverage
  1393. # Monotonically increasing time, in seconds.
  1394. number timestamp
  1395. # Enables/disables rendering of local CSS fonts (enabled by default).
  1396. experimental command setLocalFontsEnabled
  1397. parameters
  1398. # Whether rendering of local fonts is enabled.
  1399. boolean enabled
  1400. # Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
  1401. # web font
  1402. event fontsUpdated
  1403. parameters
  1404. # The web font that has loaded.
  1405. optional FontFace font
  1406. # Fires whenever a MediaQuery result changes (for example, after a browser window has been
  1407. # resized.) The current implementation considers only viewport-dependent media features.
  1408. event mediaQueryResultChanged
  1409. # Fired whenever an active document stylesheet is added.
  1410. event styleSheetAdded
  1411. parameters
  1412. # Added stylesheet metainfo.
  1413. CSSStyleSheetHeader header
  1414. # Fired whenever a stylesheet is changed as a result of the client operation.
  1415. event styleSheetChanged
  1416. parameters
  1417. StyleSheetId styleSheetId
  1418. # Fired whenever an active document stylesheet is removed.
  1419. event styleSheetRemoved
  1420. parameters
  1421. # Identifier of the removed stylesheet.
  1422. StyleSheetId styleSheetId
  1423. experimental domain CacheStorage
  1424. # Unique identifier of the Cache object.
  1425. type CacheId extends string
  1426. # type of HTTP response cached
  1427. type CachedResponseType extends string
  1428. enum
  1429. basic
  1430. cors
  1431. default
  1432. error
  1433. opaqueResponse
  1434. opaqueRedirect
  1435. # Data entry.
  1436. type DataEntry extends object
  1437. properties
  1438. # Request URL.
  1439. string requestURL
  1440. # Request method.
  1441. string requestMethod
  1442. # Request headers
  1443. array of Header requestHeaders
  1444. # Number of seconds since epoch.
  1445. number responseTime
  1446. # HTTP response status code.
  1447. integer responseStatus
  1448. # HTTP response status text.
  1449. string responseStatusText
  1450. # HTTP response type
  1451. CachedResponseType responseType
  1452. # Response headers
  1453. array of Header responseHeaders
  1454. # Cache identifier.
  1455. type Cache extends object
  1456. properties
  1457. # An opaque unique id of the cache.
  1458. CacheId cacheId
  1459. # Security origin of the cache.
  1460. string securityOrigin
  1461. # The name of the cache.
  1462. string cacheName
  1463. type Header extends object
  1464. properties
  1465. string name
  1466. string value
  1467. # Cached response
  1468. type CachedResponse extends object
  1469. properties
  1470. # Entry content, base64-encoded.
  1471. binary body
  1472. # Deletes a cache.
  1473. command deleteCache
  1474. parameters
  1475. # Id of cache for deletion.
  1476. CacheId cacheId
  1477. # Deletes a cache entry.
  1478. command deleteEntry
  1479. parameters
  1480. # Id of cache where the entry will be deleted.
  1481. CacheId cacheId
  1482. # URL spec of the request.
  1483. string request
  1484. # Requests cache names.
  1485. command requestCacheNames
  1486. parameters
  1487. # Security origin.
  1488. string securityOrigin
  1489. returns
  1490. # Caches for the security origin.
  1491. array of Cache caches
  1492. # Fetches cache entry.
  1493. command requestCachedResponse
  1494. parameters
  1495. # Id of cache that contains the entry.
  1496. CacheId cacheId
  1497. # URL spec of the request.
  1498. string requestURL
  1499. # headers of the request.
  1500. array of Header requestHeaders
  1501. returns
  1502. # Response read from the cache.
  1503. CachedResponse response
  1504. # Requests data from cache.
  1505. command requestEntries
  1506. parameters
  1507. # ID of cache to get entries from.
  1508. CacheId cacheId
  1509. # Number of records to skip.
  1510. optional integer skipCount
  1511. # Number of records to fetch.
  1512. optional integer pageSize
  1513. # If present, only return the entries containing this substring in the path
  1514. optional string pathFilter
  1515. returns
  1516. # Array of object store data entries.
  1517. array of DataEntry cacheDataEntries
  1518. # Count of returned entries from this storage. If pathFilter is empty, it
  1519. # is the count of all entries from this storage.
  1520. number returnCount
  1521. # A domain for interacting with Cast, Presentation API, and Remote Playback API
  1522. # functionalities.
  1523. experimental domain Cast
  1524. type Sink extends object
  1525. properties
  1526. string name
  1527. string id
  1528. # Text describing the current session. Present only if there is an active
  1529. # session on the sink.
  1530. optional string session
  1531. # Starts observing for sinks that can be used for tab mirroring, and if set,
  1532. # sinks compatible with |presentationUrl| as well. When sinks are found, a
  1533. # |sinksUpdated| event is fired.
  1534. # Also starts observing for issue messages. When an issue is added or removed,
  1535. # an |issueUpdated| event is fired.
  1536. command enable
  1537. parameters
  1538. optional string presentationUrl
  1539. # Stops observing for sinks and issues.
  1540. command disable
  1541. # Sets a sink to be used when the web page requests the browser to choose a
  1542. # sink via Presentation API, Remote Playback API, or Cast SDK.
  1543. command setSinkToUse
  1544. parameters
  1545. string sinkName
  1546. # Starts mirroring the tab to the sink.
  1547. command startTabMirroring
  1548. parameters
  1549. string sinkName
  1550. # Stops the active Cast session on the sink.
  1551. command stopCasting
  1552. parameters
  1553. string sinkName
  1554. # This is fired whenever the list of available sinks changes. A sink is a
  1555. # device or a software surface that you can cast to.
  1556. event sinksUpdated
  1557. parameters
  1558. array of Sink sinks
  1559. # This is fired whenever the outstanding issue/error message changes.
  1560. # |issueMessage| is empty if there is no issue.
  1561. event issueUpdated
  1562. parameters
  1563. string issueMessage
  1564. # This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
  1565. # that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
  1566. # the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
  1567. # nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
  1568. # and never sends the same node twice. It is client's responsibility to collect information about
  1569. # the nodes that were sent to the client.<p>Note that `iframe` owner elements will return
  1570. # corresponding document elements as their child nodes.</p>
  1571. domain DOM
  1572. depends on Runtime
  1573. # Unique DOM node identifier.
  1574. type NodeId extends integer
  1575. # Unique DOM node identifier used to reference a node that may not have been pushed to the
  1576. # front-end.
  1577. type BackendNodeId extends integer
  1578. # Backend node with a friendly name.
  1579. type BackendNode extends object
  1580. properties
  1581. # `Node`'s nodeType.
  1582. integer nodeType
  1583. # `Node`'s nodeName.
  1584. string nodeName
  1585. BackendNodeId backendNodeId
  1586. # Pseudo element type.
  1587. type PseudoType extends string
  1588. enum
  1589. first-line
  1590. first-letter
  1591. before
  1592. after
  1593. marker
  1594. backdrop
  1595. selection
  1596. first-line-inherited
  1597. scrollbar
  1598. scrollbar-thumb
  1599. scrollbar-button
  1600. scrollbar-track
  1601. scrollbar-track-piece
  1602. scrollbar-corner
  1603. resizer
  1604. input-list-button
  1605. # Shadow root type.
  1606. type ShadowRootType extends string
  1607. enum
  1608. user-agent
  1609. open
  1610. closed
  1611. # DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
  1612. # DOMNode is a base node mirror type.
  1613. type Node extends object
  1614. properties
  1615. # Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
  1616. # will only push node with given `id` once. It is aware of all requested nodes and will only
  1617. # fire DOM events for nodes known to the client.
  1618. NodeId nodeId
  1619. # The id of the parent node if any.
  1620. optional NodeId parentId
  1621. # The BackendNodeId for this node.
  1622. BackendNodeId backendNodeId
  1623. # `Node`'s nodeType.
  1624. integer nodeType
  1625. # `Node`'s nodeName.
  1626. string nodeName
  1627. # `Node`'s localName.
  1628. string localName
  1629. # `Node`'s nodeValue.
  1630. string nodeValue
  1631. # Child count for `Container` nodes.
  1632. optional integer childNodeCount
  1633. # Child nodes of this node when requested with children.
  1634. optional array of Node children
  1635. # Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
  1636. optional array of string attributes
  1637. # Document URL that `Document` or `FrameOwner` node points to.
  1638. optional string documentURL
  1639. # Base URL that `Document` or `FrameOwner` node uses for URL completion.
  1640. optional string baseURL
  1641. # `DocumentType`'s publicId.
  1642. optional string publicId
  1643. # `DocumentType`'s systemId.
  1644. optional string systemId
  1645. # `DocumentType`'s internalSubset.
  1646. optional string internalSubset
  1647. # `Document`'s XML version in case of XML documents.
  1648. optional string xmlVersion
  1649. # `Attr`'s name.
  1650. optional string name
  1651. # `Attr`'s value.
  1652. optional string value
  1653. # Pseudo element type for this node.
  1654. optional PseudoType pseudoType
  1655. # Shadow root type.
  1656. optional ShadowRootType shadowRootType
  1657. # Frame ID for frame owner elements.
  1658. optional Page.FrameId frameId
  1659. # Content document for frame owner elements.
  1660. optional Node contentDocument
  1661. # Shadow root list for given element host.
  1662. optional array of Node shadowRoots
  1663. # Content document fragment for template elements.
  1664. optional Node templateContent
  1665. # Pseudo elements associated with this node.
  1666. optional array of Node pseudoElements
  1667. # Import document for the HTMLImport links.
  1668. optional Node importedDocument
  1669. # Distributed nodes for given insertion point.
  1670. optional array of BackendNode distributedNodes
  1671. # Whether the node is SVG.
  1672. optional boolean isSVG
  1673. # A structure holding an RGBA color.
  1674. type RGBA extends object
  1675. properties
  1676. # The red component, in the [0-255] range.
  1677. integer r
  1678. # The green component, in the [0-255] range.
  1679. integer g
  1680. # The blue component, in the [0-255] range.
  1681. integer b
  1682. # The alpha component, in the [0-1] range (default: 1).
  1683. optional number a
  1684. # An array of quad vertices, x immediately followed by y for each point, points clock-wise.
  1685. type Quad extends array of number
  1686. # Box model.
  1687. type BoxModel extends object
  1688. properties
  1689. # Content box
  1690. Quad content
  1691. # Padding box
  1692. Quad padding
  1693. # Border box
  1694. Quad border
  1695. # Margin box
  1696. Quad margin
  1697. # Node width
  1698. integer width
  1699. # Node height
  1700. integer height
  1701. # Shape outside coordinates
  1702. optional ShapeOutsideInfo shapeOutside
  1703. # CSS Shape Outside details.
  1704. type ShapeOutsideInfo extends object
  1705. properties
  1706. # Shape bounds
  1707. Quad bounds
  1708. # Shape coordinate details
  1709. array of any shape
  1710. # Margin shape bounds
  1711. array of any marginShape
  1712. # Rectangle.
  1713. type Rect extends object
  1714. properties
  1715. # X coordinate
  1716. number x
  1717. # Y coordinate
  1718. number y
  1719. # Rectangle width
  1720. number width
  1721. # Rectangle height
  1722. number height
  1723. type CSSComputedStyleProperty extends object
  1724. properties
  1725. # Computed style property name.
  1726. string name
  1727. # Computed style property value.
  1728. string value
  1729. # Collects class names for the node with given id and all of it's child nodes.
  1730. experimental command collectClassNamesFromSubtree
  1731. parameters
  1732. # Id of the node to collect class names.
  1733. NodeId nodeId
  1734. returns
  1735. # Class name list.
  1736. array of string classNames
  1737. # Creates a deep copy of the specified node and places it into the target container before the
  1738. # given anchor.
  1739. experimental command copyTo
  1740. parameters
  1741. # Id of the node to copy.
  1742. NodeId nodeId
  1743. # Id of the element to drop the copy into.
  1744. NodeId targetNodeId
  1745. # Drop the copy before this node (if absent, the copy becomes the last child of
  1746. # `targetNodeId`).
  1747. optional NodeId insertBeforeNodeId
  1748. returns
  1749. # Id of the node clone.
  1750. NodeId nodeId
  1751. # Describes node given its id, does not require domain to be enabled. Does not start tracking any
  1752. # objects, can be used for automation.
  1753. command describeNode
  1754. parameters
  1755. # Identifier of the node.
  1756. optional NodeId nodeId
  1757. # Identifier of the backend node.
  1758. optional BackendNodeId backendNodeId
  1759. # JavaScript object id of the node wrapper.
  1760. optional Runtime.RemoteObjectId objectId
  1761. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  1762. # entire subtree or provide an integer larger than 0.
  1763. optional integer depth
  1764. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  1765. # (default is false).
  1766. optional boolean pierce
  1767. returns
  1768. # Node description.
  1769. Node node
  1770. # Scrolls the specified rect of the given node into view if not already visible.
  1771. # Note: exactly one between nodeId, backendNodeId and objectId should be passed
  1772. # to identify the node.
  1773. experimental command scrollIntoViewIfNeeded
  1774. parameters
  1775. # Identifier of the node.
  1776. optional NodeId nodeId
  1777. # Identifier of the backend node.
  1778. optional BackendNodeId backendNodeId
  1779. # JavaScript object id of the node wrapper.
  1780. optional Runtime.RemoteObjectId objectId
  1781. # The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
  1782. # When omitted, center of the node will be used, similar to Element.scrollIntoView.
  1783. optional Rect rect
  1784. # Disables DOM agent for the given page.
  1785. command disable
  1786. # Discards search results from the session with the given id. `getSearchResults` should no longer
  1787. # be called for that search.
  1788. experimental command discardSearchResults
  1789. parameters
  1790. # Unique search session identifier.
  1791. string searchId
  1792. # Enables DOM agent for the given page.
  1793. command enable
  1794. # Focuses the given element.
  1795. command focus
  1796. parameters
  1797. # Identifier of the node.
  1798. optional NodeId nodeId
  1799. # Identifier of the backend node.
  1800. optional BackendNodeId backendNodeId
  1801. # JavaScript object id of the node wrapper.
  1802. optional Runtime.RemoteObjectId objectId
  1803. # Returns attributes for the specified node.
  1804. command getAttributes
  1805. parameters
  1806. # Id of the node to retrieve attibutes for.
  1807. NodeId nodeId
  1808. returns
  1809. # An interleaved array of node attribute names and values.
  1810. array of string attributes
  1811. # Returns boxes for the given node.
  1812. command getBoxModel
  1813. parameters
  1814. # Identifier of the node.
  1815. optional NodeId nodeId
  1816. # Identifier of the backend node.
  1817. optional BackendNodeId backendNodeId
  1818. # JavaScript object id of the node wrapper.
  1819. optional Runtime.RemoteObjectId objectId
  1820. returns
  1821. # Box model for the node.
  1822. BoxModel model
  1823. # Returns quads that describe node position on the page. This method
  1824. # might return multiple quads for inline nodes.
  1825. experimental command getContentQuads
  1826. parameters
  1827. # Identifier of the node.
  1828. optional NodeId nodeId
  1829. # Identifier of the backend node.
  1830. optional BackendNodeId backendNodeId
  1831. # JavaScript object id of the node wrapper.
  1832. optional Runtime.RemoteObjectId objectId
  1833. returns
  1834. # Quads that describe node layout relative to viewport.
  1835. array of Quad quads
  1836. # Returns the root DOM node (and optionally the subtree) to the caller.
  1837. command getDocument
  1838. parameters
  1839. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  1840. # entire subtree or provide an integer larger than 0.
  1841. optional integer depth
  1842. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  1843. # (default is false).
  1844. optional boolean pierce
  1845. returns
  1846. # Resulting node.
  1847. Node root
  1848. # Returns the root DOM node (and optionally the subtree) to the caller.
  1849. # Deprecated, as it is not designed to work well with the rest of the DOM agent.
  1850. # Use DOMSnapshot.captureSnapshot instead.
  1851. deprecated command getFlattenedDocument
  1852. parameters
  1853. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  1854. # entire subtree or provide an integer larger than 0.
  1855. optional integer depth
  1856. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  1857. # (default is false).
  1858. optional boolean pierce
  1859. returns
  1860. # Resulting node.
  1861. array of Node nodes
  1862. # Finds nodes with a given computed style in a subtree.
  1863. experimental command getNodesForSubtreeByStyle
  1864. parameters
  1865. # Node ID pointing to the root of a subtree.
  1866. NodeId nodeId
  1867. # The style to filter nodes by (includes nodes if any of properties matches).
  1868. array of CSSComputedStyleProperty computedStyles
  1869. # Whether or not iframes and shadow roots in the same target should be traversed when returning the
  1870. # results (default is false).
  1871. optional boolean pierce
  1872. returns
  1873. # Resulting nodes.
  1874. array of NodeId nodeIds
  1875. # Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
  1876. # either returned or not.
  1877. command getNodeForLocation
  1878. parameters
  1879. # X coordinate.
  1880. integer x
  1881. # Y coordinate.
  1882. integer y
  1883. # False to skip to the nearest non-UA shadow root ancestor (default: false).
  1884. optional boolean includeUserAgentShadowDOM
  1885. # Whether to ignore pointer-events: none on elements and hit test them.
  1886. optional boolean ignorePointerEventsNone
  1887. returns
  1888. # Resulting node.
  1889. BackendNodeId backendNodeId
  1890. # Frame this node belongs to.
  1891. Page.FrameId frameId
  1892. # Id of the node at given coordinates, only when enabled and requested document.
  1893. optional NodeId nodeId
  1894. # Returns node's HTML markup.
  1895. command getOuterHTML
  1896. parameters
  1897. # Identifier of the node.
  1898. optional NodeId nodeId
  1899. # Identifier of the backend node.
  1900. optional BackendNodeId backendNodeId
  1901. # JavaScript object id of the node wrapper.
  1902. optional Runtime.RemoteObjectId objectId
  1903. returns
  1904. # Outer HTML markup.
  1905. string outerHTML
  1906. # Returns the id of the nearest ancestor that is a relayout boundary.
  1907. experimental command getRelayoutBoundary
  1908. parameters
  1909. # Id of the node.
  1910. NodeId nodeId
  1911. returns
  1912. # Relayout boundary node id for the given node.
  1913. NodeId nodeId
  1914. # Returns search results from given `fromIndex` to given `toIndex` from the search with the given
  1915. # identifier.
  1916. experimental command getSearchResults
  1917. parameters
  1918. # Unique search session identifier.
  1919. string searchId
  1920. # Start index of the search result to be returned.
  1921. integer fromIndex
  1922. # End index of the search result to be returned.
  1923. integer toIndex
  1924. returns
  1925. # Ids of the search result nodes.
  1926. array of NodeId nodeIds
  1927. # Hides any highlight.
  1928. command hideHighlight
  1929. # Use 'Overlay.hideHighlight' instead
  1930. redirect Overlay
  1931. # Highlights DOM node.
  1932. command highlightNode
  1933. # Use 'Overlay.highlightNode' instead
  1934. redirect Overlay
  1935. # Highlights given rectangle.
  1936. command highlightRect
  1937. # Use 'Overlay.highlightRect' instead
  1938. redirect Overlay
  1939. # Marks last undoable state.
  1940. experimental command markUndoableState
  1941. # Moves node into the new container, places it before the given anchor.
  1942. command moveTo
  1943. parameters
  1944. # Id of the node to move.
  1945. NodeId nodeId
  1946. # Id of the element to drop the moved node into.
  1947. NodeId targetNodeId
  1948. # Drop node before this one (if absent, the moved node becomes the last child of
  1949. # `targetNodeId`).
  1950. optional NodeId insertBeforeNodeId
  1951. returns
  1952. # New id of the moved node.
  1953. NodeId nodeId
  1954. # Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
  1955. # `cancelSearch` to end this search session.
  1956. experimental command performSearch
  1957. parameters
  1958. # Plain text or query selector or XPath search query.
  1959. string query
  1960. # True to search in user agent shadow DOM.
  1961. optional boolean includeUserAgentShadowDOM
  1962. returns
  1963. # Unique search session identifier.
  1964. string searchId
  1965. # Number of search results.
  1966. integer resultCount
  1967. # Requests that the node is sent to the caller given its path. // FIXME, use XPath
  1968. experimental command pushNodeByPathToFrontend
  1969. parameters
  1970. # Path to node in the proprietary format.
  1971. string path
  1972. returns
  1973. # Id of the node for given path.
  1974. NodeId nodeId
  1975. # Requests that a batch of nodes is sent to the caller given their backend node ids.
  1976. experimental command pushNodesByBackendIdsToFrontend
  1977. parameters
  1978. # The array of backend node ids.
  1979. array of BackendNodeId backendNodeIds
  1980. returns
  1981. # The array of ids of pushed nodes that correspond to the backend ids specified in
  1982. # backendNodeIds.
  1983. array of NodeId nodeIds
  1984. # Executes `querySelector` on a given node.
  1985. command querySelector
  1986. parameters
  1987. # Id of the node to query upon.
  1988. NodeId nodeId
  1989. # Selector string.
  1990. string selector
  1991. returns
  1992. # Query selector result.
  1993. NodeId nodeId
  1994. # Executes `querySelectorAll` on a given node.
  1995. command querySelectorAll
  1996. parameters
  1997. # Id of the node to query upon.
  1998. NodeId nodeId
  1999. # Selector string.
  2000. string selector
  2001. returns
  2002. # Query selector result.
  2003. array of NodeId nodeIds
  2004. # Re-does the last undone action.
  2005. experimental command redo
  2006. # Removes attribute with given name from an element with given id.
  2007. command removeAttribute
  2008. parameters
  2009. # Id of the element to remove attribute from.
  2010. NodeId nodeId
  2011. # Name of the attribute to remove.
  2012. string name
  2013. # Removes node with given id.
  2014. command removeNode
  2015. parameters
  2016. # Id of the node to remove.
  2017. NodeId nodeId
  2018. # Requests that children of the node with given id are returned to the caller in form of
  2019. # `setChildNodes` events where not only immediate children are retrieved, but all children down to
  2020. # the specified depth.
  2021. command requestChildNodes
  2022. parameters
  2023. # Id of the node to get children for.
  2024. NodeId nodeId
  2025. # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
  2026. # entire subtree or provide an integer larger than 0.
  2027. optional integer depth
  2028. # Whether or not iframes and shadow roots should be traversed when returning the sub-tree
  2029. # (default is false).
  2030. optional boolean pierce
  2031. # Requests that the node is sent to the caller given the JavaScript node object reference. All
  2032. # nodes that form the path from the node to the root are also sent to the client as a series of
  2033. # `setChildNodes` notifications.
  2034. command requestNode
  2035. parameters
  2036. # JavaScript object id to convert into node.
  2037. Runtime.RemoteObjectId objectId
  2038. returns
  2039. # Node id for given object.
  2040. NodeId nodeId
  2041. # Resolves the JavaScript node object for a given NodeId or BackendNodeId.
  2042. command resolveNode
  2043. parameters
  2044. # Id of the node to resolve.
  2045. optional NodeId nodeId
  2046. # Backend identifier of the node to resolve.
  2047. optional DOM.BackendNodeId backendNodeId
  2048. # Symbolic group name that can be used to release multiple objects.
  2049. optional string objectGroup
  2050. # Execution context in which to resolve the node.
  2051. optional Runtime.ExecutionContextId executionContextId
  2052. returns
  2053. # JavaScript object wrapper for given node.
  2054. Runtime.RemoteObject object
  2055. # Sets attribute for an element with given id.
  2056. command setAttributeValue
  2057. parameters
  2058. # Id of the element to set attribute for.
  2059. NodeId nodeId
  2060. # Attribute name.
  2061. string name
  2062. # Attribute value.
  2063. string value
  2064. # Sets attributes on element with given id. This method is useful when user edits some existing
  2065. # attribute value and types in several attribute name/value pairs.
  2066. command setAttributesAsText
  2067. parameters
  2068. # Id of the element to set attributes for.
  2069. NodeId nodeId
  2070. # Text with a number of attributes. Will parse this text using HTML parser.
  2071. string text
  2072. # Attribute name to replace with new attributes derived from text in case text parsed
  2073. # successfully.
  2074. optional string name
  2075. # Sets files for the given file input element.
  2076. command setFileInputFiles
  2077. parameters
  2078. # Array of file paths to set.
  2079. array of string files
  2080. # Identifier of the node.
  2081. optional NodeId nodeId
  2082. # Identifier of the backend node.
  2083. optional BackendNodeId backendNodeId
  2084. # JavaScript object id of the node wrapper.
  2085. optional Runtime.RemoteObjectId objectId
  2086. # Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
  2087. experimental command setNodeStackTracesEnabled
  2088. parameters
  2089. # Enable or disable.
  2090. boolean enable
  2091. # Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
  2092. experimental command getNodeStackTraces
  2093. parameters
  2094. # Id of the node to get stack traces for.
  2095. NodeId nodeId
  2096. returns
  2097. # Creation stack trace, if available.
  2098. optional Runtime.StackTrace creation
  2099. # Returns file information for the given
  2100. # File wrapper.
  2101. experimental command getFileInfo
  2102. parameters
  2103. # JavaScript object id of the node wrapper.
  2104. Runtime.RemoteObjectId objectId
  2105. returns
  2106. string path
  2107. # Enables console to refer to the node with given id via $x (see Command Line API for more details
  2108. # $x functions).
  2109. experimental command setInspectedNode
  2110. parameters
  2111. # DOM node id to be accessible by means of $x command line API.
  2112. NodeId nodeId
  2113. # Sets node name for a node with given id.
  2114. command setNodeName
  2115. parameters
  2116. # Id of the node to set name for.
  2117. NodeId nodeId
  2118. # New node's name.
  2119. string name
  2120. returns
  2121. # New node's id.
  2122. NodeId nodeId
  2123. # Sets node value for a node with given id.
  2124. command setNodeValue
  2125. parameters
  2126. # Id of the node to set value for.
  2127. NodeId nodeId
  2128. # New node's value.
  2129. string value
  2130. # Sets node HTML markup, returns new node id.
  2131. command setOuterHTML
  2132. parameters
  2133. # Id of the node to set markup for.
  2134. NodeId nodeId
  2135. # Outer HTML markup to set.
  2136. string outerHTML
  2137. # Undoes the last performed action.
  2138. experimental command undo
  2139. # Returns iframe node that owns iframe with the given domain.
  2140. experimental command getFrameOwner
  2141. parameters
  2142. Page.FrameId frameId
  2143. returns
  2144. # Resulting node.
  2145. BackendNodeId backendNodeId
  2146. # Id of the node at given coordinates, only when enabled and requested document.
  2147. optional NodeId nodeId
  2148. # Fired when `Element`'s attribute is modified.
  2149. event attributeModified
  2150. parameters
  2151. # Id of the node that has changed.
  2152. NodeId nodeId
  2153. # Attribute name.
  2154. string name
  2155. # Attribute value.
  2156. string value
  2157. # Fired when `Element`'s attribute is removed.
  2158. event attributeRemoved
  2159. parameters
  2160. # Id of the node that has changed.
  2161. NodeId nodeId
  2162. # A ttribute name.
  2163. string name
  2164. # Mirrors `DOMCharacterDataModified` event.
  2165. event characterDataModified
  2166. parameters
  2167. # Id of the node that has changed.
  2168. NodeId nodeId
  2169. # New text value.
  2170. string characterData
  2171. # Fired when `Container`'s child node count has changed.
  2172. event childNodeCountUpdated
  2173. parameters
  2174. # Id of the node that has changed.
  2175. NodeId nodeId
  2176. # New node count.
  2177. integer childNodeCount
  2178. # Mirrors `DOMNodeInserted` event.
  2179. event childNodeInserted
  2180. parameters
  2181. # Id of the node that has changed.
  2182. NodeId parentNodeId
  2183. # If of the previous siblint.
  2184. NodeId previousNodeId
  2185. # Inserted node data.
  2186. Node node
  2187. # Mirrors `DOMNodeRemoved` event.
  2188. event childNodeRemoved
  2189. parameters
  2190. # Parent id.
  2191. NodeId parentNodeId
  2192. # Id of the node that has been removed.
  2193. NodeId nodeId
  2194. # Called when distrubution is changed.
  2195. experimental event distributedNodesUpdated
  2196. parameters
  2197. # Insertion point where distrubuted nodes were updated.
  2198. NodeId insertionPointId
  2199. # Distributed nodes for given insertion point.
  2200. array of BackendNode distributedNodes
  2201. # Fired when `Document` has been totally updated. Node ids are no longer valid.
  2202. event documentUpdated
  2203. # Fired when `Element`'s inline style is modified via a CSS property modification.
  2204. experimental event inlineStyleInvalidated
  2205. parameters
  2206. # Ids of the nodes for which the inline styles have been invalidated.
  2207. array of NodeId nodeIds
  2208. # Called when a pseudo element is added to an element.
  2209. experimental event pseudoElementAdded
  2210. parameters
  2211. # Pseudo element's parent element id.
  2212. NodeId parentId
  2213. # The added pseudo element.
  2214. Node pseudoElement
  2215. # Called when a pseudo element is removed from an element.
  2216. experimental event pseudoElementRemoved
  2217. parameters
  2218. # Pseudo element's parent element id.
  2219. NodeId parentId
  2220. # The removed pseudo element id.
  2221. NodeId pseudoElementId
  2222. # Fired when backend wants to provide client with the missing DOM structure. This happens upon
  2223. # most of the calls requesting node ids.
  2224. event setChildNodes
  2225. parameters
  2226. # Parent node id to populate with children.
  2227. NodeId parentId
  2228. # Child nodes array.
  2229. array of Node nodes
  2230. # Called when shadow root is popped from the element.
  2231. experimental event shadowRootPopped
  2232. parameters
  2233. # Host element id.
  2234. NodeId hostId
  2235. # Shadow root id.
  2236. NodeId rootId
  2237. # Called when shadow root is pushed into the element.
  2238. experimental event shadowRootPushed
  2239. parameters
  2240. # Host element id.
  2241. NodeId hostId
  2242. # Shadow root.
  2243. Node root
  2244. # DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
  2245. # execution will stop on these operations as if there was a regular breakpoint set.
  2246. domain DOMDebugger
  2247. depends on DOM
  2248. depends on Debugger
  2249. depends on Runtime
  2250. # DOM breakpoint type.
  2251. type DOMBreakpointType extends string
  2252. enum
  2253. subtree-modified
  2254. attribute-modified
  2255. node-removed
  2256. # Object event listener.
  2257. type EventListener extends object
  2258. properties
  2259. # `EventListener`'s type.
  2260. string type
  2261. # `EventListener`'s useCapture.
  2262. boolean useCapture
  2263. # `EventListener`'s passive flag.
  2264. boolean passive
  2265. # `EventListener`'s once flag.
  2266. boolean once
  2267. # Script id of the handler code.
  2268. Runtime.ScriptId scriptId
  2269. # Line number in the script (0-based).
  2270. integer lineNumber
  2271. # Column number in the script (0-based).
  2272. integer columnNumber
  2273. # Event handler function value.
  2274. optional Runtime.RemoteObject handler
  2275. # Event original handler function value.
  2276. optional Runtime.RemoteObject originalHandler
  2277. # Node the listener is added to (if any).
  2278. optional DOM.BackendNodeId backendNodeId
  2279. # Returns event listeners of the given object.
  2280. command getEventListeners
  2281. parameters
  2282. # Identifier of the object to return listeners for.
  2283. Runtime.RemoteObjectId objectId
  2284. # The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
  2285. # entire subtree or provide an integer larger than 0.
  2286. optional integer depth
  2287. # Whether or not iframes and shadow roots should be traversed when returning the subtree
  2288. # (default is false). Reports listeners for all contexts if pierce is enabled.
  2289. optional boolean pierce
  2290. returns
  2291. # Array of relevant listeners.
  2292. array of EventListener listeners
  2293. # Removes DOM breakpoint that was set using `setDOMBreakpoint`.
  2294. command removeDOMBreakpoint
  2295. parameters
  2296. # Identifier of the node to remove breakpoint from.
  2297. DOM.NodeId nodeId
  2298. # Type of the breakpoint to remove.
  2299. DOMBreakpointType type
  2300. # Removes breakpoint on particular DOM event.
  2301. command removeEventListenerBreakpoint
  2302. parameters
  2303. # Event name.
  2304. string eventName
  2305. # EventTarget interface name.
  2306. experimental optional string targetName
  2307. # Removes breakpoint on particular native event.
  2308. experimental command removeInstrumentationBreakpoint
  2309. parameters
  2310. # Instrumentation name to stop on.
  2311. string eventName
  2312. # Removes breakpoint from XMLHttpRequest.
  2313. command removeXHRBreakpoint
  2314. parameters
  2315. # Resource URL substring.
  2316. string url
  2317. # Sets breakpoint on particular operation with DOM.
  2318. command setDOMBreakpoint
  2319. parameters
  2320. # Identifier of the node to set breakpoint on.
  2321. DOM.NodeId nodeId
  2322. # Type of the operation to stop upon.
  2323. DOMBreakpointType type
  2324. # Sets breakpoint on particular DOM event.
  2325. command setEventListenerBreakpoint
  2326. parameters
  2327. # DOM Event name to stop on (any DOM event will do).
  2328. string eventName
  2329. # EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
  2330. # EventTarget.
  2331. experimental optional string targetName
  2332. # Sets breakpoint on particular native event.
  2333. experimental command setInstrumentationBreakpoint
  2334. parameters
  2335. # Instrumentation name to stop on.
  2336. string eventName
  2337. # Sets breakpoint on XMLHttpRequest.
  2338. command setXHRBreakpoint
  2339. parameters
  2340. # Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
  2341. string url
  2342. # This domain facilitates obtaining document snapshots with DOM, layout, and style information.
  2343. experimental domain DOMSnapshot
  2344. depends on CSS
  2345. depends on DOM
  2346. depends on DOMDebugger
  2347. depends on Page
  2348. # A Node in the DOM tree.
  2349. type DOMNode extends object
  2350. properties
  2351. # `Node`'s nodeType.
  2352. integer nodeType
  2353. # `Node`'s nodeName.
  2354. string nodeName
  2355. # `Node`'s nodeValue.
  2356. string nodeValue
  2357. # Only set for textarea elements, contains the text value.
  2358. optional string textValue
  2359. # Only set for input elements, contains the input's associated text value.
  2360. optional string inputValue
  2361. # Only set for radio and checkbox input elements, indicates if the element has been checked
  2362. optional boolean inputChecked
  2363. # Only set for option elements, indicates if the element has been selected
  2364. optional boolean optionSelected
  2365. # `Node`'s id, corresponds to DOM.Node.backendNodeId.
  2366. DOM.BackendNodeId backendNodeId
  2367. # The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
  2368. # any.
  2369. optional array of integer childNodeIndexes
  2370. # Attributes of an `Element` node.
  2371. optional array of NameValue attributes
  2372. # Indexes of pseudo elements associated with this node in the `domNodes` array returned by
  2373. # `getSnapshot`, if any.
  2374. optional array of integer pseudoElementIndexes
  2375. # The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
  2376. # `getSnapshot`, if any.
  2377. optional integer layoutNodeIndex
  2378. # Document URL that `Document` or `FrameOwner` node points to.
  2379. optional string documentURL
  2380. # Base URL that `Document` or `FrameOwner` node uses for URL completion.
  2381. optional string baseURL
  2382. # Only set for documents, contains the document's content language.
  2383. optional string contentLanguage
  2384. # Only set for documents, contains the document's character set encoding.
  2385. optional string documentEncoding
  2386. # `DocumentType` node's publicId.
  2387. optional string publicId
  2388. # `DocumentType` node's systemId.
  2389. optional string systemId
  2390. # Frame ID for frame owner elements and also for the document node.
  2391. optional Page.FrameId frameId
  2392. # The index of a frame owner element's content document in the `domNodes` array returned by
  2393. # `getSnapshot`, if any.
  2394. optional integer contentDocumentIndex
  2395. # Type of a pseudo element node.
  2396. optional DOM.PseudoType pseudoType
  2397. # Shadow root type.
  2398. optional DOM.ShadowRootType shadowRootType
  2399. # Whether this DOM node responds to mouse clicks. This includes nodes that have had click
  2400. # event listeners attached via JavaScript as well as anchor tags that naturally navigate when
  2401. # clicked.
  2402. optional boolean isClickable
  2403. # Details of the node's event listeners, if any.
  2404. optional array of DOMDebugger.EventListener eventListeners
  2405. # The selected url for nodes with a srcset attribute.
  2406. optional string currentSourceURL
  2407. # The url of the script (if any) that generates this node.
  2408. optional string originURL
  2409. # Scroll offsets, set when this node is a Document.
  2410. optional number scrollOffsetX
  2411. optional number scrollOffsetY
  2412. # Details of post layout rendered text positions. The exact layout should not be regarded as
  2413. # stable and may change between versions.
  2414. type InlineTextBox extends object
  2415. properties
  2416. # The bounding box in document coordinates. Note that scroll offset of the document is ignored.
  2417. DOM.Rect boundingBox
  2418. # The starting index in characters, for this post layout textbox substring. Characters that
  2419. # would be represented as a surrogate pair in UTF-16 have length 2.
  2420. integer startCharacterIndex
  2421. # The number of characters in this post layout textbox substring. Characters that would be
  2422. # represented as a surrogate pair in UTF-16 have length 2.
  2423. integer numCharacters
  2424. # Details of an element in the DOM tree with a LayoutObject.
  2425. type LayoutTreeNode extends object
  2426. properties
  2427. # The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
  2428. integer domNodeIndex
  2429. # The bounding box in document coordinates. Note that scroll offset of the document is ignored.
  2430. DOM.Rect boundingBox
  2431. # Contents of the LayoutText, if any.
  2432. optional string layoutText
  2433. # The post-layout inline text nodes, if any.
  2434. optional array of InlineTextBox inlineTextNodes
  2435. # Index into the `computedStyles` array returned by `getSnapshot`.
  2436. optional integer styleIndex
  2437. # Global paint order index, which is determined by the stacking order of the nodes. Nodes
  2438. # that are painted together will have the same index. Only provided if includePaintOrder in
  2439. # getSnapshot was true.
  2440. optional integer paintOrder
  2441. # Set to true to indicate the element begins a new stacking context.
  2442. optional boolean isStackingContext
  2443. # A subset of the full ComputedStyle as defined by the request whitelist.
  2444. type ComputedStyle extends object
  2445. properties
  2446. # Name/value pairs of computed style properties.
  2447. array of NameValue properties
  2448. # A name/value pair.
  2449. type NameValue extends object
  2450. properties
  2451. # Attribute/property name.
  2452. string name
  2453. # Attribute/property value.
  2454. string value
  2455. # Index of the string in the strings table.
  2456. type StringIndex extends integer
  2457. # Index of the string in the strings table.
  2458. type ArrayOfStrings extends array of StringIndex
  2459. # Data that is only present on rare nodes.
  2460. type RareStringData extends object
  2461. properties
  2462. array of integer index
  2463. array of StringIndex value
  2464. type RareBooleanData extends object
  2465. properties
  2466. array of integer index
  2467. type RareIntegerData extends object
  2468. properties
  2469. array of integer index
  2470. array of integer value
  2471. type Rectangle extends array of number
  2472. # Document snapshot.
  2473. type DocumentSnapshot extends object
  2474. properties
  2475. # Document URL that `Document` or `FrameOwner` node points to.
  2476. StringIndex documentURL
  2477. # Document title.
  2478. StringIndex title
  2479. # Base URL that `Document` or `FrameOwner` node uses for URL completion.
  2480. StringIndex baseURL
  2481. # Contains the document's content language.
  2482. StringIndex contentLanguage
  2483. # Contains the document's character set encoding.
  2484. StringIndex encodingName
  2485. # `DocumentType` node's publicId.
  2486. StringIndex publicId
  2487. # `DocumentType` node's systemId.
  2488. StringIndex systemId
  2489. # Frame ID for frame owner elements and also for the document node.
  2490. StringIndex frameId
  2491. # A table with dom nodes.
  2492. NodeTreeSnapshot nodes
  2493. # The nodes in the layout tree.
  2494. LayoutTreeSnapshot layout
  2495. # The post-layout inline text nodes.
  2496. TextBoxSnapshot textBoxes
  2497. # Horizontal scroll offset.
  2498. optional number scrollOffsetX
  2499. # Vertical scroll offset.
  2500. optional number scrollOffsetY
  2501. # Document content width.
  2502. optional number contentWidth
  2503. # Document content height.
  2504. optional number contentHeight
  2505. # Table containing nodes.
  2506. type NodeTreeSnapshot extends object
  2507. properties
  2508. # Parent node index.
  2509. optional array of integer parentIndex
  2510. # `Node`'s nodeType.
  2511. optional array of integer nodeType
  2512. # `Node`'s nodeName.
  2513. optional array of StringIndex nodeName
  2514. # `Node`'s nodeValue.
  2515. optional array of StringIndex nodeValue
  2516. # `Node`'s id, corresponds to DOM.Node.backendNodeId.
  2517. optional array of DOM.BackendNodeId backendNodeId
  2518. # Attributes of an `Element` node. Flatten name, value pairs.
  2519. optional array of ArrayOfStrings attributes
  2520. # Only set for textarea elements, contains the text value.
  2521. optional RareStringData textValue
  2522. # Only set for input elements, contains the input's associated text value.
  2523. optional RareStringData inputValue
  2524. # Only set for radio and checkbox input elements, indicates if the element has been checked
  2525. optional RareBooleanData inputChecked
  2526. # Only set for option elements, indicates if the element has been selected
  2527. optional RareBooleanData optionSelected
  2528. # The index of the document in the list of the snapshot documents.
  2529. optional RareIntegerData contentDocumentIndex
  2530. # Type of a pseudo element node.
  2531. optional RareStringData pseudoType
  2532. # Whether this DOM node responds to mouse clicks. This includes nodes that have had click
  2533. # event listeners attached via JavaScript as well as anchor tags that naturally navigate when
  2534. # clicked.
  2535. optional RareBooleanData isClickable
  2536. # The selected url for nodes with a srcset attribute.
  2537. optional RareStringData currentSourceURL
  2538. # The url of the script (if any) that generates this node.
  2539. optional RareStringData originURL
  2540. # Table of details of an element in the DOM tree with a LayoutObject.
  2541. type LayoutTreeSnapshot extends object
  2542. properties
  2543. # Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
  2544. array of integer nodeIndex
  2545. # Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
  2546. array of ArrayOfStrings styles
  2547. # The absolute position bounding box.
  2548. array of Rectangle bounds
  2549. # Contents of the LayoutText, if any.
  2550. array of StringIndex text
  2551. # Stacking context information.
  2552. RareBooleanData stackingContexts
  2553. # Global paint order index, which is determined by the stacking order of the nodes. Nodes
  2554. # that are painted together will have the same index. Only provided if includePaintOrder in
  2555. # captureSnapshot was true.
  2556. optional array of integer paintOrders
  2557. # The offset rect of nodes. Only available when includeDOMRects is set to true
  2558. optional array of Rectangle offsetRects
  2559. # The scroll rect of nodes. Only available when includeDOMRects is set to true
  2560. optional array of Rectangle scrollRects
  2561. # The client rect of nodes. Only available when includeDOMRects is set to true
  2562. optional array of Rectangle clientRects
  2563. # Table of details of the post layout rendered text positions. The exact layout should not be regarded as
  2564. # stable and may change between versions.
  2565. type TextBoxSnapshot extends object
  2566. properties
  2567. # Index of the layout tree node that owns this box collection.
  2568. array of integer layoutIndex
  2569. # The absolute position bounding box.
  2570. array of Rectangle bounds
  2571. # The starting index in characters, for this post layout textbox substring. Characters that
  2572. # would be represented as a surrogate pair in UTF-16 have length 2.
  2573. array of integer start
  2574. # The number of characters in this post layout textbox substring. Characters that would be
  2575. # represented as a surrogate pair in UTF-16 have length 2.
  2576. array of integer length
  2577. # Disables DOM snapshot agent for the given page.
  2578. command disable
  2579. # Enables DOM snapshot agent for the given page.
  2580. command enable
  2581. # Returns a document snapshot, including the full DOM tree of the root node (including iframes,
  2582. # template contents, and imported documents) in a flattened array, as well as layout and
  2583. # white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
  2584. # flattened.
  2585. deprecated command getSnapshot
  2586. parameters
  2587. # Whitelist of computed styles to return.
  2588. array of string computedStyleWhitelist
  2589. # Whether or not to retrieve details of DOM listeners (default false).
  2590. optional boolean includeEventListeners
  2591. # Whether to determine and include the paint order index of LayoutTreeNodes (default false).
  2592. optional boolean includePaintOrder
  2593. # Whether to include UA shadow tree in the snapshot (default false).
  2594. optional boolean includeUserAgentShadowTree
  2595. returns
  2596. # The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
  2597. array of DOMNode domNodes
  2598. # The nodes in the layout tree.
  2599. array of LayoutTreeNode layoutTreeNodes
  2600. # Whitelisted ComputedStyle properties for each node in the layout tree.
  2601. array of ComputedStyle computedStyles
  2602. # Returns a document snapshot, including the full DOM tree of the root node (including iframes,
  2603. # template contents, and imported documents) in a flattened array, as well as layout and
  2604. # white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
  2605. # flattened.
  2606. command captureSnapshot
  2607. parameters
  2608. # Whitelist of computed styles to return.
  2609. array of string computedStyles
  2610. # Whether to include layout object paint orders into the snapshot.
  2611. optional boolean includePaintOrder
  2612. # Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
  2613. optional boolean includeDOMRects
  2614. returns
  2615. # The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
  2616. array of DocumentSnapshot documents
  2617. # Shared string table that all string properties refer to with indexes.
  2618. array of string strings
  2619. # Query and modify DOM storage.
  2620. experimental domain DOMStorage
  2621. # DOM Storage identifier.
  2622. type StorageId extends object
  2623. properties
  2624. # Security origin for the storage.
  2625. string securityOrigin
  2626. # Whether the storage is local storage (not session storage).
  2627. boolean isLocalStorage
  2628. # DOM Storage item.
  2629. type Item extends array of string
  2630. command clear
  2631. parameters
  2632. StorageId storageId
  2633. # Disables storage tracking, prevents storage events from being sent to the client.
  2634. command disable
  2635. # Enables storage tracking, storage events will now be delivered to the client.
  2636. command enable
  2637. command getDOMStorageItems
  2638. parameters
  2639. StorageId storageId
  2640. returns
  2641. array of Item entries
  2642. command removeDOMStorageItem
  2643. parameters
  2644. StorageId storageId
  2645. string key
  2646. command setDOMStorageItem
  2647. parameters
  2648. StorageId storageId
  2649. string key
  2650. string value
  2651. event domStorageItemAdded
  2652. parameters
  2653. StorageId storageId
  2654. string key
  2655. string newValue
  2656. event domStorageItemRemoved
  2657. parameters
  2658. StorageId storageId
  2659. string key
  2660. event domStorageItemUpdated
  2661. parameters
  2662. StorageId storageId
  2663. string key
  2664. string oldValue
  2665. string newValue
  2666. event domStorageItemsCleared
  2667. parameters
  2668. StorageId storageId
  2669. experimental domain Database
  2670. # Unique identifier of Database object.
  2671. type DatabaseId extends string
  2672. # Database object.
  2673. type Database extends object
  2674. properties
  2675. # Database ID.
  2676. DatabaseId id
  2677. # Database domain.
  2678. string domain
  2679. # Database name.
  2680. string name
  2681. # Database version.
  2682. string version
  2683. # Database error.
  2684. type Error extends object
  2685. properties
  2686. # Error message.
  2687. string message
  2688. # Error code.
  2689. integer code
  2690. # Disables database tracking, prevents database events from being sent to the client.
  2691. command disable
  2692. # Enables database tracking, database events will now be delivered to the client.
  2693. command enable
  2694. command executeSQL
  2695. parameters
  2696. DatabaseId databaseId
  2697. string query
  2698. returns
  2699. optional array of string columnNames
  2700. optional array of any values
  2701. optional Error sqlError
  2702. command getDatabaseTableNames
  2703. parameters
  2704. DatabaseId databaseId
  2705. returns
  2706. array of string tableNames
  2707. event addDatabase
  2708. parameters
  2709. Database database
  2710. experimental domain DeviceOrientation
  2711. # Clears the overridden Device Orientation.
  2712. command clearDeviceOrientationOverride
  2713. # Overrides the Device Orientation.
  2714. command setDeviceOrientationOverride
  2715. parameters
  2716. # Mock alpha
  2717. number alpha
  2718. # Mock beta
  2719. number beta
  2720. # Mock gamma
  2721. number gamma
  2722. # This domain emulates different environments for the page.
  2723. domain Emulation
  2724. depends on DOM
  2725. depends on Page
  2726. depends on Runtime
  2727. # Screen orientation.
  2728. type ScreenOrientation extends object
  2729. properties
  2730. # Orientation type.
  2731. enum type
  2732. portraitPrimary
  2733. portraitSecondary
  2734. landscapePrimary
  2735. landscapeSecondary
  2736. # Orientation angle.
  2737. integer angle
  2738. type DisplayFeature extends object
  2739. properties
  2740. # Orientation of a display feature in relation to screen
  2741. enum orientation
  2742. vertical
  2743. horizontal
  2744. # The offset from the screen origin in either the x (for vertical
  2745. # orientation) or y (for horizontal orientation) direction.
  2746. integer offset
  2747. # A display feature may mask content such that it is not physically
  2748. # displayed - this length along with the offset describes this area.
  2749. # A display feature that only splits content will have a 0 mask_length.
  2750. integer maskLength
  2751. type MediaFeature extends object
  2752. properties
  2753. string name
  2754. string value
  2755. # advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to
  2756. # allow the next delayed task (if any) to run; pause: The virtual time base may not advance;
  2757. # pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending
  2758. # resource fetches.
  2759. experimental type VirtualTimePolicy extends string
  2760. enum
  2761. advance
  2762. pause
  2763. pauseIfNetworkFetchesPending
  2764. # Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
  2765. experimental type UserAgentBrandVersion extends object
  2766. properties
  2767. string brand
  2768. string version
  2769. # Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
  2770. experimental type UserAgentMetadata extends object
  2771. properties
  2772. array of UserAgentBrandVersion brands
  2773. string fullVersion
  2774. string platform
  2775. string platformVersion
  2776. string architecture
  2777. string model
  2778. boolean mobile
  2779. # Tells whether emulation is supported.
  2780. command canEmulate
  2781. returns
  2782. # True if emulation is supported.
  2783. boolean result
  2784. # Clears the overriden device metrics.
  2785. command clearDeviceMetricsOverride
  2786. # Clears the overriden Geolocation Position and Error.
  2787. command clearGeolocationOverride
  2788. # Requests that page scale factor is reset to initial values.
  2789. experimental command resetPageScaleFactor
  2790. # Enables or disables simulating a focused and active page.
  2791. experimental command setFocusEmulationEnabled
  2792. parameters
  2793. # Whether to enable to disable focus emulation.
  2794. boolean enabled
  2795. # Enables CPU throttling to emulate slow CPUs.
  2796. experimental command setCPUThrottlingRate
  2797. parameters
  2798. # Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).
  2799. number rate
  2800. # Sets or clears an override of the default background color of the frame. This override is used
  2801. # if the content does not specify one.
  2802. command setDefaultBackgroundColorOverride
  2803. parameters
  2804. # RGBA of the default background color. If not specified, any existing override will be
  2805. # cleared.
  2806. optional DOM.RGBA color
  2807. # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
  2808. # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
  2809. # query results).
  2810. command setDeviceMetricsOverride
  2811. parameters
  2812. # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  2813. integer width
  2814. # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  2815. integer height
  2816. # Overriding device scale factor value. 0 disables the override.
  2817. number deviceScaleFactor
  2818. # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
  2819. # autosizing and more.
  2820. boolean mobile
  2821. # Scale to apply to resulting view image.
  2822. experimental optional number scale
  2823. # Overriding screen width value in pixels (minimum 0, maximum 10000000).
  2824. experimental optional integer screenWidth
  2825. # Overriding screen height value in pixels (minimum 0, maximum 10000000).
  2826. experimental optional integer screenHeight
  2827. # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
  2828. experimental optional integer positionX
  2829. # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
  2830. experimental optional integer positionY
  2831. # Do not set visible view size, rely upon explicit setVisibleSize call.
  2832. experimental optional boolean dontSetVisibleSize
  2833. # Screen orientation override.
  2834. optional ScreenOrientation screenOrientation
  2835. # If set, the visible area of the page will be overridden to this viewport. This viewport
  2836. # change is not observed by the page, e.g. viewport-relative elements do not change positions.
  2837. experimental optional Page.Viewport viewport
  2838. # If set, the display feature of a multi-segment screen. If not set, multi-segment support
  2839. # is turned-off.
  2840. experimental optional DisplayFeature displayFeature
  2841. experimental command setScrollbarsHidden
  2842. parameters
  2843. # Whether scrollbars should be always hidden.
  2844. boolean hidden
  2845. experimental command setDocumentCookieDisabled
  2846. parameters
  2847. # Whether document.coookie API should be disabled.
  2848. boolean disabled
  2849. experimental command setEmitTouchEventsForMouse
  2850. parameters
  2851. # Whether touch emulation based on mouse input should be enabled.
  2852. boolean enabled
  2853. # Touch/gesture events configuration. Default: current platform.
  2854. optional enum configuration
  2855. mobile
  2856. desktop
  2857. # Emulates the given media type or media feature for CSS media queries.
  2858. command setEmulatedMedia
  2859. parameters
  2860. # Media type to emulate. Empty string disables the override.
  2861. optional string media
  2862. # Media features to emulate.
  2863. optional array of MediaFeature features
  2864. # Emulates the given vision deficiency.
  2865. experimental command setEmulatedVisionDeficiency
  2866. parameters
  2867. # Vision deficiency to emulate.
  2868. enum type
  2869. none
  2870. achromatopsia
  2871. blurredVision
  2872. deuteranopia
  2873. protanopia
  2874. tritanopia
  2875. # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
  2876. # unavailable.
  2877. command setGeolocationOverride
  2878. parameters
  2879. # Mock latitude
  2880. optional number latitude
  2881. # Mock longitude
  2882. optional number longitude
  2883. # Mock accuracy
  2884. optional number accuracy
  2885. # Overrides the Idle state.
  2886. experimental command setIdleOverride
  2887. parameters
  2888. # Mock isUserActive
  2889. boolean isUserActive
  2890. # Mock isScreenUnlocked
  2891. boolean isScreenUnlocked
  2892. # Clears Idle state overrides.
  2893. experimental command clearIdleOverride
  2894. # Overrides value returned by the javascript navigator object.
  2895. experimental deprecated command setNavigatorOverrides
  2896. parameters
  2897. # The platform navigator.platform should return.
  2898. string platform
  2899. # Sets a specified page scale factor.
  2900. experimental command setPageScaleFactor
  2901. parameters
  2902. # Page scale factor.
  2903. number pageScaleFactor
  2904. # Switches script execution in the page.
  2905. command setScriptExecutionDisabled
  2906. parameters
  2907. # Whether script execution should be disabled in the page.
  2908. boolean value
  2909. # Enables touch on platforms which do not support them.
  2910. command setTouchEmulationEnabled
  2911. parameters
  2912. # Whether the touch event emulation should be enabled.
  2913. boolean enabled
  2914. # Maximum touch points supported. Defaults to one.
  2915. optional integer maxTouchPoints
  2916. # Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets
  2917. # the current virtual time policy. Note this supersedes any previous time budget.
  2918. experimental command setVirtualTimePolicy
  2919. parameters
  2920. VirtualTimePolicy policy
  2921. # If set, after this many virtual milliseconds have elapsed virtual time will be paused and a
  2922. # virtualTimeBudgetExpired event is sent.
  2923. optional number budget
  2924. # If set this specifies the maximum number of tasks that can be run before virtual is forced
  2925. # forwards to prevent deadlock.
  2926. optional integer maxVirtualTimeTaskStarvationCount
  2927. # If set the virtual time policy change should be deferred until any frame starts navigating.
  2928. # Note any previous deferred policy change is superseded.
  2929. optional boolean waitForNavigation
  2930. # If set, base::Time::Now will be overriden to initially return this value.
  2931. optional Network.TimeSinceEpoch initialVirtualTime
  2932. returns
  2933. # Absolute timestamp at which virtual time was first enabled (up time in milliseconds).
  2934. number virtualTimeTicksBase
  2935. # Overrides default host system locale with the specified one.
  2936. experimental command setLocaleOverride
  2937. parameters
  2938. # ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and
  2939. # restores default host system locale.
  2940. optional string locale
  2941. # Overrides default host system timezone with the specified one.
  2942. experimental command setTimezoneOverride
  2943. parameters
  2944. # The timezone identifier. If empty, disables the override and
  2945. # restores default host system timezone.
  2946. string timezoneId
  2947. # Resizes the frame/viewport of the page. Note that this does not affect the frame's container
  2948. # (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported
  2949. # on Android.
  2950. experimental deprecated command setVisibleSize
  2951. parameters
  2952. # Frame width (DIP).
  2953. integer width
  2954. # Frame height (DIP).
  2955. integer height
  2956. # Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
  2957. experimental event virtualTimeBudgetExpired
  2958. # Allows overriding user agent with the given string.
  2959. command setUserAgentOverride
  2960. parameters
  2961. # User agent to use.
  2962. string userAgent
  2963. # Browser langugage to emulate.
  2964. optional string acceptLanguage
  2965. # The platform navigator.platform should return.
  2966. optional string platform
  2967. # To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
  2968. experimental optional UserAgentMetadata userAgentMetadata
  2969. # This domain provides experimental commands only supported in headless mode.
  2970. experimental domain HeadlessExperimental
  2971. depends on Page
  2972. depends on Runtime
  2973. # Encoding options for a screenshot.
  2974. type ScreenshotParams extends object
  2975. properties
  2976. # Image compression format (defaults to png).
  2977. optional enum format
  2978. jpeg
  2979. png
  2980. # Compression quality from range [0..100] (jpeg only).
  2981. optional integer quality
  2982. # Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
  2983. # screenshot from the resulting frame. Requires that the target was created with enabled
  2984. # BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
  2985. # https://goo.gl/3zHXhB for more background.
  2986. command beginFrame
  2987. parameters
  2988. # Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
  2989. # the current time will be used.
  2990. optional number frameTimeTicks
  2991. # The interval between BeginFrames that is reported to the compositor, in milliseconds.
  2992. # Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
  2993. optional number interval
  2994. # Whether updates should not be committed and drawn onto the display. False by default. If
  2995. # true, only side effects of the BeginFrame will be run, such as layout and animations, but
  2996. # any visual updates may not be visible on the display or in screenshots.
  2997. optional boolean noDisplayUpdates
  2998. # If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
  2999. # no screenshot will be captured. Note that capturing a screenshot can fail, for example,
  3000. # during renderer initialization. In such a case, no screenshot data will be returned.
  3001. optional ScreenshotParams screenshot
  3002. returns
  3003. # Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
  3004. # display. Reported for diagnostic uses, may be removed in the future.
  3005. boolean hasDamage
  3006. # Base64-encoded image data of the screenshot, if one was requested and successfully taken.
  3007. optional binary screenshotData
  3008. # Disables headless events for the target.
  3009. command disable
  3010. # Enables headless events for the target.
  3011. command enable
  3012. # Issued when the target starts or stops needing BeginFrames.
  3013. # Deprecated. Issue beginFrame unconditionally instead and use result from
  3014. # beginFrame to detect whether the frames were suppressed.
  3015. deprecated event needsBeginFramesChanged
  3016. parameters
  3017. # True if BeginFrames are needed, false otherwise.
  3018. boolean needsBeginFrames
  3019. # Input/Output operations for streams produced by DevTools.
  3020. domain IO
  3021. # This is either obtained from another method or specifed as `blob:&lt;uuid&gt;` where
  3022. # `&lt;uuid&gt` is an UUID of a Blob.
  3023. type StreamHandle extends string
  3024. # Close the stream, discard any temporary backing storage.
  3025. command close
  3026. parameters
  3027. # Handle of the stream to close.
  3028. StreamHandle handle
  3029. # Read a chunk of the stream
  3030. command read
  3031. parameters
  3032. # Handle of the stream to read.
  3033. StreamHandle handle
  3034. # Seek to the specified offset before reading (if not specificed, proceed with offset
  3035. # following the last read). Some types of streams may only support sequential reads.
  3036. optional integer offset
  3037. # Maximum number of bytes to read (left upon the agent discretion if not specified).
  3038. optional integer size
  3039. returns
  3040. # Set if the data is base64-encoded
  3041. optional boolean base64Encoded
  3042. # Data that were read.
  3043. string data
  3044. # Set if the end-of-file condition occured while reading.
  3045. boolean eof
  3046. # Return UUID of Blob object specified by a remote object id.
  3047. command resolveBlob
  3048. parameters
  3049. # Object id of a Blob object wrapper.
  3050. Runtime.RemoteObjectId objectId
  3051. returns
  3052. # UUID of the specified Blob.
  3053. string uuid
  3054. experimental domain IndexedDB
  3055. depends on Runtime
  3056. # Database with an array of object stores.
  3057. type DatabaseWithObjectStores extends object
  3058. properties
  3059. # Database name.
  3060. string name
  3061. # Database version (type is not 'integer', as the standard
  3062. # requires the version number to be 'unsigned long long')
  3063. number version
  3064. # Object stores in this database.
  3065. array of ObjectStore objectStores
  3066. # Object store.
  3067. type ObjectStore extends object
  3068. properties
  3069. # Object store name.
  3070. string name
  3071. # Object store key path.
  3072. KeyPath keyPath
  3073. # If true, object store has auto increment flag set.
  3074. boolean autoIncrement
  3075. # Indexes in this object store.
  3076. array of ObjectStoreIndex indexes
  3077. # Object store index.
  3078. type ObjectStoreIndex extends object
  3079. properties
  3080. # Index name.
  3081. string name
  3082. # Index key path.
  3083. KeyPath keyPath
  3084. # If true, index is unique.
  3085. boolean unique
  3086. # If true, index allows multiple entries for a key.
  3087. boolean multiEntry
  3088. # Key.
  3089. type Key extends object
  3090. properties
  3091. # Key type.
  3092. enum type
  3093. number
  3094. string
  3095. date
  3096. array
  3097. # Number value.
  3098. optional number number
  3099. # String value.
  3100. optional string string
  3101. # Date value.
  3102. optional number date
  3103. # Array value.
  3104. optional array of Key array
  3105. # Key range.
  3106. type KeyRange extends object
  3107. properties
  3108. # Lower bound.
  3109. optional Key lower
  3110. # Upper bound.
  3111. optional Key upper
  3112. # If true lower bound is open.
  3113. boolean lowerOpen
  3114. # If true upper bound is open.
  3115. boolean upperOpen
  3116. # Data entry.
  3117. type DataEntry extends object
  3118. properties
  3119. # Key object.
  3120. Runtime.RemoteObject key
  3121. # Primary key object.
  3122. Runtime.RemoteObject primaryKey
  3123. # Value object.
  3124. Runtime.RemoteObject value
  3125. # Key path.
  3126. type KeyPath extends object
  3127. properties
  3128. # Key path type.
  3129. enum type
  3130. null
  3131. string
  3132. array
  3133. # String value.
  3134. optional string string
  3135. # Array value.
  3136. optional array of string array
  3137. # Clears all entries from an object store.
  3138. command clearObjectStore
  3139. parameters
  3140. # Security origin.
  3141. string securityOrigin
  3142. # Database name.
  3143. string databaseName
  3144. # Object store name.
  3145. string objectStoreName
  3146. # Deletes a database.
  3147. command deleteDatabase
  3148. parameters
  3149. # Security origin.
  3150. string securityOrigin
  3151. # Database name.
  3152. string databaseName
  3153. # Delete a range of entries from an object store
  3154. command deleteObjectStoreEntries
  3155. parameters
  3156. string securityOrigin
  3157. string databaseName
  3158. string objectStoreName
  3159. # Range of entry keys to delete
  3160. KeyRange keyRange
  3161. # Disables events from backend.
  3162. command disable
  3163. # Enables events from backend.
  3164. command enable
  3165. # Requests data from object store or index.
  3166. command requestData
  3167. parameters
  3168. # Security origin.
  3169. string securityOrigin
  3170. # Database name.
  3171. string databaseName
  3172. # Object store name.
  3173. string objectStoreName
  3174. # Index name, empty string for object store data requests.
  3175. string indexName
  3176. # Number of records to skip.
  3177. integer skipCount
  3178. # Number of records to fetch.
  3179. integer pageSize
  3180. # Key range.
  3181. optional KeyRange keyRange
  3182. returns
  3183. # Array of object store data entries.
  3184. array of DataEntry objectStoreDataEntries
  3185. # If true, there are more entries to fetch in the given range.
  3186. boolean hasMore
  3187. # Gets metadata of an object store
  3188. command getMetadata
  3189. parameters
  3190. # Security origin.
  3191. string securityOrigin
  3192. # Database name.
  3193. string databaseName
  3194. # Object store name.
  3195. string objectStoreName
  3196. returns
  3197. # the entries count
  3198. number entriesCount
  3199. # the current value of key generator, to become the next inserted
  3200. # key into the object store. Valid if objectStore.autoIncrement
  3201. # is true.
  3202. number keyGeneratorValue
  3203. # Requests database with given name in given frame.
  3204. command requestDatabase
  3205. parameters
  3206. # Security origin.
  3207. string securityOrigin
  3208. # Database name.
  3209. string databaseName
  3210. returns
  3211. # Database with an array of object stores.
  3212. DatabaseWithObjectStores databaseWithObjectStores
  3213. # Requests database names for given security origin.
  3214. command requestDatabaseNames
  3215. parameters
  3216. # Security origin.
  3217. string securityOrigin
  3218. returns
  3219. # Database names for origin.
  3220. array of string databaseNames
  3221. domain Input
  3222. type TouchPoint extends object
  3223. properties
  3224. # X coordinate of the event relative to the main frame's viewport in CSS pixels.
  3225. number x
  3226. # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
  3227. # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
  3228. number y
  3229. # X radius of the touch area (default: 1.0).
  3230. optional number radiusX
  3231. # Y radius of the touch area (default: 1.0).
  3232. optional number radiusY
  3233. # Rotation angle (default: 0.0).
  3234. optional number rotationAngle
  3235. # Force (default: 1.0).
  3236. optional number force
  3237. # Identifier used to track touch sources between events, must be unique within an event.
  3238. optional number id
  3239. experimental type GestureSourceType extends string
  3240. enum
  3241. default
  3242. touch
  3243. mouse
  3244. type MouseButton extends string
  3245. enum
  3246. none
  3247. left
  3248. middle
  3249. right
  3250. back
  3251. forward
  3252. # UTC time in seconds, counted from January 1, 1970.
  3253. type TimeSinceEpoch extends number
  3254. # Dispatches a key event to the page.
  3255. command dispatchKeyEvent
  3256. parameters
  3257. # Type of the key event.
  3258. enum type
  3259. keyDown
  3260. keyUp
  3261. rawKeyDown
  3262. char
  3263. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  3264. # (default: 0).
  3265. optional integer modifiers
  3266. # Time at which the event occurred.
  3267. optional TimeSinceEpoch timestamp
  3268. # Text as generated by processing a virtual key code with a keyboard layout. Not needed for
  3269. # for `keyUp` and `rawKeyDown` events (default: "")
  3270. optional string text
  3271. # Text that would have been generated by the keyboard if no modifiers were pressed (except for
  3272. # shift). Useful for shortcut (accelerator) key handling (default: "").
  3273. optional string unmodifiedText
  3274. # Unique key identifier (e.g., 'U+0041') (default: "").
  3275. optional string keyIdentifier
  3276. # Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
  3277. optional string code
  3278. # Unique DOM defined string value describing the meaning of the key in the context of active
  3279. # modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
  3280. optional string key
  3281. # Windows virtual key code (default: 0).
  3282. optional integer windowsVirtualKeyCode
  3283. # Native virtual key code (default: 0).
  3284. optional integer nativeVirtualKeyCode
  3285. # Whether the event was generated from auto repeat (default: false).
  3286. optional boolean autoRepeat
  3287. # Whether the event was generated from the keypad (default: false).
  3288. optional boolean isKeypad
  3289. # Whether the event was a system key event (default: false).
  3290. optional boolean isSystemKey
  3291. # Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
  3292. # 0).
  3293. optional integer location
  3294. # Editing commands to send with the key event (e.g., 'selectAll') (default: []).
  3295. # These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
  3296. # See https://source.chromium.org/chromium/chromium/src/+/master:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
  3297. experimental optional array of string commands
  3298. # This method emulates inserting text that doesn't come from a key press,
  3299. # for example an emoji keyboard or an IME.
  3300. experimental command insertText
  3301. parameters
  3302. # The text to insert.
  3303. string text
  3304. # Dispatches a mouse event to the page.
  3305. command dispatchMouseEvent
  3306. parameters
  3307. # Type of the mouse event.
  3308. enum type
  3309. mousePressed
  3310. mouseReleased
  3311. mouseMoved
  3312. mouseWheel
  3313. # X coordinate of the event relative to the main frame's viewport in CSS pixels.
  3314. number x
  3315. # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
  3316. # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
  3317. number y
  3318. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  3319. # (default: 0).
  3320. optional integer modifiers
  3321. # Time at which the event occurred.
  3322. optional TimeSinceEpoch timestamp
  3323. # Mouse button (default: "none").
  3324. optional MouseButton button
  3325. # A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
  3326. # Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
  3327. optional integer buttons
  3328. # Number of times the mouse button was clicked (default: 0).
  3329. optional integer clickCount
  3330. # X delta in CSS pixels for mouse wheel event (default: 0).
  3331. optional number deltaX
  3332. # Y delta in CSS pixels for mouse wheel event (default: 0).
  3333. optional number deltaY
  3334. # Pointer type (default: "mouse").
  3335. optional enum pointerType
  3336. mouse
  3337. pen
  3338. # Dispatches a touch event to the page.
  3339. command dispatchTouchEvent
  3340. parameters
  3341. # Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
  3342. # TouchStart and TouchMove must contains at least one.
  3343. enum type
  3344. touchStart
  3345. touchEnd
  3346. touchMove
  3347. touchCancel
  3348. # Active touch points on the touch device. One event per any changed point (compared to
  3349. # previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
  3350. # one by one.
  3351. array of TouchPoint touchPoints
  3352. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  3353. # (default: 0).
  3354. optional integer modifiers
  3355. # Time at which the event occurred.
  3356. optional TimeSinceEpoch timestamp
  3357. # Emulates touch event from the mouse event parameters.
  3358. experimental command emulateTouchFromMouseEvent
  3359. parameters
  3360. # Type of the mouse event.
  3361. enum type
  3362. mousePressed
  3363. mouseReleased
  3364. mouseMoved
  3365. mouseWheel
  3366. # X coordinate of the mouse pointer in DIP.
  3367. integer x
  3368. # Y coordinate of the mouse pointer in DIP.
  3369. integer y
  3370. # Mouse button. Only "none", "left", "right" are supported.
  3371. MouseButton button
  3372. # Time at which the event occurred (default: current time).
  3373. optional TimeSinceEpoch timestamp
  3374. # X delta in DIP for mouse wheel event (default: 0).
  3375. optional number deltaX
  3376. # Y delta in DIP for mouse wheel event (default: 0).
  3377. optional number deltaY
  3378. # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
  3379. # (default: 0).
  3380. optional integer modifiers
  3381. # Number of times the mouse button was clicked (default: 0).
  3382. optional integer clickCount
  3383. # Ignores input events (useful while auditing page).
  3384. command setIgnoreInputEvents
  3385. parameters
  3386. # Ignores input events processing when set to true.
  3387. boolean ignore
  3388. # Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
  3389. experimental command synthesizePinchGesture
  3390. parameters
  3391. # X coordinate of the start of the gesture in CSS pixels.
  3392. number x
  3393. # Y coordinate of the start of the gesture in CSS pixels.
  3394. number y
  3395. # Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
  3396. number scaleFactor
  3397. # Relative pointer speed in pixels per second (default: 800).
  3398. optional integer relativeSpeed
  3399. # Which type of input events to be generated (default: 'default', which queries the platform
  3400. # for the preferred input type).
  3401. optional GestureSourceType gestureSourceType
  3402. # Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
  3403. experimental command synthesizeScrollGesture
  3404. parameters
  3405. # X coordinate of the start of the gesture in CSS pixels.
  3406. number x
  3407. # Y coordinate of the start of the gesture in CSS pixels.
  3408. number y
  3409. # The distance to scroll along the X axis (positive to scroll left).
  3410. optional number xDistance
  3411. # The distance to scroll along the Y axis (positive to scroll up).
  3412. optional number yDistance
  3413. # The number of additional pixels to scroll back along the X axis, in addition to the given
  3414. # distance.
  3415. optional number xOverscroll
  3416. # The number of additional pixels to scroll back along the Y axis, in addition to the given
  3417. # distance.
  3418. optional number yOverscroll
  3419. # Prevent fling (default: true).
  3420. optional boolean preventFling
  3421. # Swipe speed in pixels per second (default: 800).
  3422. optional integer speed
  3423. # Which type of input events to be generated (default: 'default', which queries the platform
  3424. # for the preferred input type).
  3425. optional GestureSourceType gestureSourceType
  3426. # The number of times to repeat the gesture (default: 0).
  3427. optional integer repeatCount
  3428. # The number of milliseconds delay between each repeat. (default: 250).
  3429. optional integer repeatDelayMs
  3430. # The name of the interaction markers to generate, if not empty (default: "").
  3431. optional string interactionMarkerName
  3432. # Synthesizes a tap gesture over a time period by issuing appropriate touch events.
  3433. experimental command synthesizeTapGesture
  3434. parameters
  3435. # X coordinate of the start of the gesture in CSS pixels.
  3436. number x
  3437. # Y coordinate of the start of the gesture in CSS pixels.
  3438. number y
  3439. # Duration between touchdown and touchup events in ms (default: 50).
  3440. optional integer duration
  3441. # Number of times to perform the tap (e.g. 2 for double tap, default: 1).
  3442. optional integer tapCount
  3443. # Which type of input events to be generated (default: 'default', which queries the platform
  3444. # for the preferred input type).
  3445. optional GestureSourceType gestureSourceType
  3446. experimental domain Inspector
  3447. # Disables inspector domain notifications.
  3448. command disable
  3449. # Enables inspector domain notifications.
  3450. command enable
  3451. # Fired when remote debugging connection is about to be terminated. Contains detach reason.
  3452. event detached
  3453. parameters
  3454. # The reason why connection has been terminated.
  3455. string reason
  3456. # Fired when debugging target has crashed
  3457. event targetCrashed
  3458. # Fired when debugging target has reloaded after crash
  3459. event targetReloadedAfterCrash
  3460. experimental domain LayerTree
  3461. depends on DOM
  3462. # Unique Layer identifier.
  3463. type LayerId extends string
  3464. # Unique snapshot identifier.
  3465. type SnapshotId extends string
  3466. # Rectangle where scrolling happens on the main thread.
  3467. type ScrollRect extends object
  3468. properties
  3469. # Rectangle itself.
  3470. DOM.Rect rect
  3471. # Reason for rectangle to force scrolling on the main thread
  3472. enum type
  3473. RepaintsOnScroll
  3474. TouchEventHandler
  3475. WheelEventHandler
  3476. # Sticky position constraints.
  3477. type StickyPositionConstraint extends object
  3478. properties
  3479. # Layout rectangle of the sticky element before being shifted
  3480. DOM.Rect stickyBoxRect
  3481. # Layout rectangle of the containing block of the sticky element
  3482. DOM.Rect containingBlockRect
  3483. # The nearest sticky layer that shifts the sticky box
  3484. optional LayerId nearestLayerShiftingStickyBox
  3485. # The nearest sticky layer that shifts the containing block
  3486. optional LayerId nearestLayerShiftingContainingBlock
  3487. # Serialized fragment of layer picture along with its offset within the layer.
  3488. type PictureTile extends object
  3489. properties
  3490. # Offset from owning layer left boundary
  3491. number x
  3492. # Offset from owning layer top boundary
  3493. number y
  3494. # Base64-encoded snapshot data.
  3495. binary picture
  3496. # Information about a compositing layer.
  3497. type Layer extends object
  3498. properties
  3499. # The unique id for this layer.
  3500. LayerId layerId
  3501. # The id of parent (not present for root).
  3502. optional LayerId parentLayerId
  3503. # The backend id for the node associated with this layer.
  3504. optional DOM.BackendNodeId backendNodeId
  3505. # Offset from parent layer, X coordinate.
  3506. number offsetX
  3507. # Offset from parent layer, Y coordinate.
  3508. number offsetY
  3509. # Layer width.
  3510. number width
  3511. # Layer height.
  3512. number height
  3513. # Transformation matrix for layer, default is identity matrix
  3514. optional array of number transform
  3515. # Transform anchor point X, absent if no transform specified
  3516. optional number anchorX
  3517. # Transform anchor point Y, absent if no transform specified
  3518. optional number anchorY
  3519. # Transform anchor point Z, absent if no transform specified
  3520. optional number anchorZ
  3521. # Indicates how many time this layer has painted.
  3522. integer paintCount
  3523. # Indicates whether this layer hosts any content, rather than being used for
  3524. # transform/scrolling purposes only.
  3525. boolean drawsContent
  3526. # Set if layer is not visible.
  3527. optional boolean invisible
  3528. # Rectangles scrolling on main thread only.
  3529. optional array of ScrollRect scrollRects
  3530. # Sticky position constraint information
  3531. optional StickyPositionConstraint stickyPositionConstraint
  3532. # Array of timings, one per paint step.
  3533. type PaintProfile extends array of number
  3534. # Provides the reasons why the given layer was composited.
  3535. command compositingReasons
  3536. parameters
  3537. # The id of the layer for which we want to get the reasons it was composited.
  3538. LayerId layerId
  3539. returns
  3540. # A list of strings specifying reasons for the given layer to become composited.
  3541. deprecated array of string compositingReasons
  3542. # A list of strings specifying reason IDs for the given layer to become composited.
  3543. array of string compositingReasonIds
  3544. # Disables compositing tree inspection.
  3545. command disable
  3546. # Enables compositing tree inspection.
  3547. command enable
  3548. # Returns the snapshot identifier.
  3549. command loadSnapshot
  3550. parameters
  3551. # An array of tiles composing the snapshot.
  3552. array of PictureTile tiles
  3553. returns
  3554. # The id of the snapshot.
  3555. SnapshotId snapshotId
  3556. # Returns the layer snapshot identifier.
  3557. command makeSnapshot
  3558. parameters
  3559. # The id of the layer.
  3560. LayerId layerId
  3561. returns
  3562. # The id of the layer snapshot.
  3563. SnapshotId snapshotId
  3564. command profileSnapshot
  3565. parameters
  3566. # The id of the layer snapshot.
  3567. SnapshotId snapshotId
  3568. # The maximum number of times to replay the snapshot (1, if not specified).
  3569. optional integer minRepeatCount
  3570. # The minimum duration (in seconds) to replay the snapshot.
  3571. optional number minDuration
  3572. # The clip rectangle to apply when replaying the snapshot.
  3573. optional DOM.Rect clipRect
  3574. returns
  3575. # The array of paint profiles, one per run.
  3576. array of PaintProfile timings
  3577. # Releases layer snapshot captured by the back-end.
  3578. command releaseSnapshot
  3579. parameters
  3580. # The id of the layer snapshot.
  3581. SnapshotId snapshotId
  3582. # Replays the layer snapshot and returns the resulting bitmap.
  3583. command replaySnapshot
  3584. parameters
  3585. # The id of the layer snapshot.
  3586. SnapshotId snapshotId
  3587. # The first step to replay from (replay from the very start if not specified).
  3588. optional integer fromStep
  3589. # The last step to replay to (replay till the end if not specified).
  3590. optional integer toStep
  3591. # The scale to apply while replaying (defaults to 1).
  3592. optional number scale
  3593. returns
  3594. # A data: URL for resulting image.
  3595. string dataURL
  3596. # Replays the layer snapshot and returns canvas log.
  3597. command snapshotCommandLog
  3598. parameters
  3599. # The id of the layer snapshot.
  3600. SnapshotId snapshotId
  3601. returns
  3602. # The array of canvas function calls.
  3603. array of object commandLog
  3604. event layerPainted
  3605. parameters
  3606. # The id of the painted layer.
  3607. LayerId layerId
  3608. # Clip rectangle.
  3609. DOM.Rect clip
  3610. event layerTreeDidChange
  3611. parameters
  3612. # Layer tree, absent if not in the comspositing mode.
  3613. optional array of Layer layers
  3614. # Provides access to log entries.
  3615. domain Log
  3616. depends on Runtime
  3617. depends on Network
  3618. # Log entry.
  3619. type LogEntry extends object
  3620. properties
  3621. # Log entry source.
  3622. enum source
  3623. xml
  3624. javascript
  3625. network
  3626. storage
  3627. appcache
  3628. rendering
  3629. security
  3630. deprecation
  3631. worker
  3632. violation
  3633. intervention
  3634. recommendation
  3635. other
  3636. # Log entry severity.
  3637. enum level
  3638. verbose
  3639. info
  3640. warning
  3641. error
  3642. # Logged text.
  3643. string text
  3644. # Timestamp when this entry was added.
  3645. Runtime.Timestamp timestamp
  3646. # URL of the resource if known.
  3647. optional string url
  3648. # Line number in the resource.
  3649. optional integer lineNumber
  3650. # JavaScript stack trace.
  3651. optional Runtime.StackTrace stackTrace
  3652. # Identifier of the network request associated with this entry.
  3653. optional Network.RequestId networkRequestId
  3654. # Identifier of the worker associated with this entry.
  3655. optional string workerId
  3656. # Call arguments.
  3657. optional array of Runtime.RemoteObject args
  3658. # Violation configuration setting.
  3659. type ViolationSetting extends object
  3660. properties
  3661. # Violation type.
  3662. enum name
  3663. longTask
  3664. longLayout
  3665. blockedEvent
  3666. blockedParser
  3667. discouragedAPIUse
  3668. handler
  3669. recurringHandler
  3670. # Time threshold to trigger upon.
  3671. number threshold
  3672. # Clears the log.
  3673. command clear
  3674. # Disables log domain, prevents further log entries from being reported to the client.
  3675. command disable
  3676. # Enables log domain, sends the entries collected so far to the client by means of the
  3677. # `entryAdded` notification.
  3678. command enable
  3679. # start violation reporting.
  3680. command startViolationsReport
  3681. parameters
  3682. # Configuration for violations.
  3683. array of ViolationSetting config
  3684. # Stop violation reporting.
  3685. command stopViolationsReport
  3686. # Issued when new message was logged.
  3687. event entryAdded
  3688. parameters
  3689. # The entry.
  3690. LogEntry entry
  3691. experimental domain Memory
  3692. # Memory pressure level.
  3693. type PressureLevel extends string
  3694. enum
  3695. moderate
  3696. critical
  3697. command getDOMCounters
  3698. returns
  3699. integer documents
  3700. integer nodes
  3701. integer jsEventListeners
  3702. command prepareForLeakDetection
  3703. # Simulate OomIntervention by purging V8 memory.
  3704. command forciblyPurgeJavaScriptMemory
  3705. # Enable/disable suppressing memory pressure notifications in all processes.
  3706. command setPressureNotificationsSuppressed
  3707. parameters
  3708. # If true, memory pressure notifications will be suppressed.
  3709. boolean suppressed
  3710. # Simulate a memory pressure notification in all processes.
  3711. command simulatePressureNotification
  3712. parameters
  3713. # Memory pressure level of the notification.
  3714. PressureLevel level
  3715. # Start collecting native memory profile.
  3716. command startSampling
  3717. parameters
  3718. # Average number of bytes between samples.
  3719. optional integer samplingInterval
  3720. # Do not randomize intervals between samples.
  3721. optional boolean suppressRandomness
  3722. # Stop collecting native memory profile.
  3723. command stopSampling
  3724. # Retrieve native memory allocations profile
  3725. # collected since renderer process startup.
  3726. command getAllTimeSamplingProfile
  3727. returns
  3728. SamplingProfile profile
  3729. # Retrieve native memory allocations profile
  3730. # collected since browser process startup.
  3731. command getBrowserSamplingProfile
  3732. returns
  3733. SamplingProfile profile
  3734. # Retrieve native memory allocations profile collected since last
  3735. # `startSampling` call.
  3736. command getSamplingProfile
  3737. returns
  3738. SamplingProfile profile
  3739. # Heap profile sample.
  3740. type SamplingProfileNode extends object
  3741. properties
  3742. # Size of the sampled allocation.
  3743. number size
  3744. # Total bytes attributed to this sample.
  3745. number total
  3746. # Execution stack at the point of allocation.
  3747. array of string stack
  3748. # Array of heap profile samples.
  3749. type SamplingProfile extends object
  3750. properties
  3751. array of SamplingProfileNode samples
  3752. array of Module modules
  3753. # Executable module information
  3754. type Module extends object
  3755. properties
  3756. # Name of the module.
  3757. string name
  3758. # UUID of the module.
  3759. string uuid
  3760. # Base address where the module is loaded into memory. Encoded as a decimal
  3761. # or hexadecimal (0x prefixed) string.
  3762. string baseAddress
  3763. # Size of the module in bytes.
  3764. number size
  3765. # Network domain allows tracking network activities of the page. It exposes information about http,
  3766. # file, data and other requests and responses, their headers, bodies, timing, etc.
  3767. domain Network
  3768. depends on Debugger
  3769. depends on Runtime
  3770. depends on Security
  3771. # Resource type as it was perceived by the rendering engine.
  3772. type ResourceType extends string
  3773. enum
  3774. Document
  3775. Stylesheet
  3776. Image
  3777. Media
  3778. Font
  3779. Script
  3780. TextTrack
  3781. XHR
  3782. Fetch
  3783. EventSource
  3784. WebSocket
  3785. Manifest
  3786. SignedExchange
  3787. Ping
  3788. CSPViolationReport
  3789. Other
  3790. # Unique loader identifier.
  3791. type LoaderId extends string
  3792. # Unique request identifier.
  3793. type RequestId extends string
  3794. # Unique intercepted request identifier.
  3795. type InterceptionId extends string
  3796. # Network level fetch failure reason.
  3797. type ErrorReason extends string
  3798. enum
  3799. Failed
  3800. Aborted
  3801. TimedOut
  3802. AccessDenied
  3803. ConnectionClosed
  3804. ConnectionReset
  3805. ConnectionRefused
  3806. ConnectionAborted
  3807. ConnectionFailed
  3808. NameNotResolved
  3809. InternetDisconnected
  3810. AddressUnreachable
  3811. BlockedByClient
  3812. BlockedByResponse
  3813. # UTC time in seconds, counted from January 1, 1970.
  3814. type TimeSinceEpoch extends number
  3815. # Monotonically increasing time in seconds since an arbitrary point in the past.
  3816. type MonotonicTime extends number
  3817. # Request / response headers as keys / values of JSON object.
  3818. type Headers extends object
  3819. # The underlying connection technology that the browser is supposedly using.
  3820. type ConnectionType extends string
  3821. enum
  3822. none
  3823. cellular2g
  3824. cellular3g
  3825. cellular4g
  3826. bluetooth
  3827. ethernet
  3828. wifi
  3829. wimax
  3830. other
  3831. # Represents the cookie's 'SameSite' status:
  3832. # https://tools.ietf.org/html/draft-west-first-party-cookies
  3833. type CookieSameSite extends string
  3834. enum
  3835. Strict
  3836. Lax
  3837. None
  3838. # Represents the cookie's 'Priority' status:
  3839. # https://tools.ietf.org/html/draft-west-cookie-priority-00
  3840. experimental type CookiePriority extends string
  3841. enum
  3842. Low
  3843. Medium
  3844. High
  3845. # Timing information for the request.
  3846. type ResourceTiming extends object
  3847. properties
  3848. # Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
  3849. # milliseconds relatively to this requestTime.
  3850. number requestTime
  3851. # Started resolving proxy.
  3852. number proxyStart
  3853. # Finished resolving proxy.
  3854. number proxyEnd
  3855. # Started DNS address resolve.
  3856. number dnsStart
  3857. # Finished DNS address resolve.
  3858. number dnsEnd
  3859. # Started connecting to the remote host.
  3860. number connectStart
  3861. # Connected to the remote host.
  3862. number connectEnd
  3863. # Started SSL handshake.
  3864. number sslStart
  3865. # Finished SSL handshake.
  3866. number sslEnd
  3867. # Started running ServiceWorker.
  3868. experimental number workerStart
  3869. # Finished Starting ServiceWorker.
  3870. experimental number workerReady
  3871. # Started fetch event.
  3872. experimental number workerFetchStart
  3873. # Settled fetch event respondWith promise.
  3874. experimental number workerRespondWithSettled
  3875. # Started sending request.
  3876. number sendStart
  3877. # Finished sending request.
  3878. number sendEnd
  3879. # Time the server started pushing request.
  3880. experimental number pushStart
  3881. # Time the server finished pushing request.
  3882. experimental number pushEnd
  3883. # Finished receiving response headers.
  3884. number receiveHeadersEnd
  3885. # Loading priority of a resource request.
  3886. type ResourcePriority extends string
  3887. enum
  3888. VeryLow
  3889. Low
  3890. Medium
  3891. High
  3892. VeryHigh
  3893. # Post data entry for HTTP request
  3894. type PostDataEntry extends object
  3895. properties
  3896. optional binary bytes
  3897. # HTTP request data.
  3898. type Request extends object
  3899. properties
  3900. # Request URL (without fragment).
  3901. string url
  3902. # Fragment of the requested URL starting with hash, if present.
  3903. optional string urlFragment
  3904. # HTTP request method.
  3905. string method
  3906. # HTTP request headers.
  3907. Headers headers
  3908. # HTTP POST request data.
  3909. optional string postData
  3910. # 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.
  3911. optional boolean hasPostData
  3912. # Request body elements. This will be converted from base64 to binary
  3913. experimental optional array of PostDataEntry postDataEntries
  3914. # The mixed content type of the request.
  3915. optional Security.MixedContentType mixedContentType
  3916. # Priority of the resource request at the time request is sent.
  3917. ResourcePriority initialPriority
  3918. # The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
  3919. enum referrerPolicy
  3920. unsafe-url
  3921. no-referrer-when-downgrade
  3922. no-referrer
  3923. origin
  3924. origin-when-cross-origin
  3925. same-origin
  3926. strict-origin
  3927. strict-origin-when-cross-origin
  3928. # Whether is loaded via link preload.
  3929. optional boolean isLinkPreload
  3930. # Set for requests when the TrustToken API is used. Contains the parameters
  3931. # passed by the developer (e.g. via "fetch") as understood by the backend.
  3932. experimental optional TrustTokenParams trustTokenParams
  3933. # Details of a signed certificate timestamp (SCT).
  3934. type SignedCertificateTimestamp extends object
  3935. properties
  3936. # Validation status.
  3937. string status
  3938. # Origin.
  3939. string origin
  3940. # Log name / description.
  3941. string logDescription
  3942. # Log ID.
  3943. string logId
  3944. # Issuance date.
  3945. TimeSinceEpoch timestamp
  3946. # Hash algorithm.
  3947. string hashAlgorithm
  3948. # Signature algorithm.
  3949. string signatureAlgorithm
  3950. # Signature data.
  3951. string signatureData
  3952. # Security details about a request.
  3953. type SecurityDetails extends object
  3954. properties
  3955. # Protocol name (e.g. "TLS 1.2" or "QUIC").
  3956. string protocol
  3957. # Key Exchange used by the connection, or the empty string if not applicable.
  3958. string keyExchange
  3959. # (EC)DH group used by the connection, if applicable.
  3960. optional string keyExchangeGroup
  3961. # Cipher name.
  3962. string cipher
  3963. # TLS MAC. Note that AEAD ciphers do not have separate MACs.
  3964. optional string mac
  3965. # Certificate ID value.
  3966. Security.CertificateId certificateId
  3967. # Certificate subject name.
  3968. string subjectName
  3969. # Subject Alternative Name (SAN) DNS names and IP addresses.
  3970. array of string sanList
  3971. # Name of the issuing CA.
  3972. string issuer
  3973. # Certificate valid from date.
  3974. TimeSinceEpoch validFrom
  3975. # Certificate valid to (expiration) date
  3976. TimeSinceEpoch validTo
  3977. # List of signed certificate timestamps (SCTs).
  3978. array of SignedCertificateTimestamp signedCertificateTimestampList
  3979. # Whether the request complied with Certificate Transparency policy
  3980. CertificateTransparencyCompliance certificateTransparencyCompliance
  3981. # Whether the request complied with Certificate Transparency policy.
  3982. type CertificateTransparencyCompliance extends string
  3983. enum
  3984. unknown
  3985. not-compliant
  3986. compliant
  3987. # The reason why request was blocked.
  3988. type BlockedReason extends string
  3989. enum
  3990. other
  3991. csp
  3992. mixed-content
  3993. origin
  3994. inspector
  3995. subresource-filter
  3996. content-type
  3997. collapsed-by-client
  3998. coep-frame-resource-needs-coep-header
  3999. coop-sandboxed-iframe-cannot-navigate-to-coop-page
  4000. corp-not-same-origin
  4001. corp-not-same-origin-after-defaulted-to-same-origin-by-coep
  4002. corp-not-same-site
  4003. # Source of serviceworker response.
  4004. type ServiceWorkerResponseSource extends string
  4005. enum
  4006. cache-storage
  4007. http-cache
  4008. fallback-code
  4009. network
  4010. # Determines what type of Trust Token operation is executed and
  4011. # depending on the type, some additional parameters.
  4012. experimental type TrustTokenParams extends object
  4013. properties
  4014. TrustTokenOperationType type
  4015. # Only set for "srr-token-redemption" type and determine whether
  4016. # to request a fresh SRR or use a still valid cached SRR.
  4017. enum refreshPolicy
  4018. UseCached
  4019. Refresh
  4020. # Origins of issuers from whom to request tokens or redemption
  4021. # records.
  4022. optional array of string issuers
  4023. experimental type TrustTokenOperationType extends string
  4024. enum
  4025. # Type "token-request" in the Trust Token API.
  4026. Issuance
  4027. # Type "srr-token-redemption" in the Trust Token API.
  4028. Redemption
  4029. # Type "send-srr" in the Trust Token API.
  4030. Signing
  4031. # HTTP response data.
  4032. type Response extends object
  4033. properties
  4034. # Response URL. This URL can be different from CachedResource.url in case of redirect.
  4035. string url
  4036. # HTTP response status code.
  4037. integer status
  4038. # HTTP response status text.
  4039. string statusText
  4040. # HTTP response headers.
  4041. Headers headers
  4042. # HTTP response headers text.
  4043. optional string headersText
  4044. # Resource mimeType as determined by the browser.
  4045. string mimeType
  4046. # Refined HTTP request headers that were actually transmitted over the network.
  4047. optional Headers requestHeaders
  4048. # HTTP request headers text.
  4049. optional string requestHeadersText
  4050. # Specifies whether physical connection was actually reused for this request.
  4051. boolean connectionReused
  4052. # Physical connection id that was actually used for this request.
  4053. number connectionId
  4054. # Remote IP address.
  4055. optional string remoteIPAddress
  4056. # Remote port.
  4057. optional integer remotePort
  4058. # Specifies that the request was served from the disk cache.
  4059. optional boolean fromDiskCache
  4060. # Specifies that the request was served from the ServiceWorker.
  4061. optional boolean fromServiceWorker
  4062. # Specifies that the request was served from the prefetch cache.
  4063. optional boolean fromPrefetchCache
  4064. # Total number of bytes received for this request so far.
  4065. number encodedDataLength
  4066. # Timing information for the given request.
  4067. optional ResourceTiming timing
  4068. # Response source of response from ServiceWorker.
  4069. optional ServiceWorkerResponseSource serviceWorkerResponseSource
  4070. # The time at which the returned response was generated.
  4071. optional TimeSinceEpoch responseTime
  4072. # Cache Storage Cache Name.
  4073. optional string cacheStorageCacheName
  4074. # Protocol used to fetch this request.
  4075. optional string protocol
  4076. # Security state of the request resource.
  4077. Security.SecurityState securityState
  4078. # Security details for the request.
  4079. optional SecurityDetails securityDetails
  4080. # WebSocket request data.
  4081. type WebSocketRequest extends object
  4082. properties
  4083. # HTTP request headers.
  4084. Headers headers
  4085. # WebSocket response data.
  4086. type WebSocketResponse extends object
  4087. properties
  4088. # HTTP response status code.
  4089. integer status
  4090. # HTTP response status text.
  4091. string statusText
  4092. # HTTP response headers.
  4093. Headers headers
  4094. # HTTP response headers text.
  4095. optional string headersText
  4096. # HTTP request headers.
  4097. optional Headers requestHeaders
  4098. # HTTP request headers text.
  4099. optional string requestHeadersText
  4100. # WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
  4101. type WebSocketFrame extends object
  4102. properties
  4103. # WebSocket message opcode.
  4104. number opcode
  4105. # WebSocket message mask.
  4106. boolean mask
  4107. # WebSocket message payload data.
  4108. # If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
  4109. # If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
  4110. string payloadData
  4111. # Information about the cached resource.
  4112. type CachedResource extends object
  4113. properties
  4114. # Resource URL. This is the url of the original network request.
  4115. string url
  4116. # Type of this resource.
  4117. ResourceType type
  4118. # Cached response data.
  4119. optional Response response
  4120. # Cached response body size.
  4121. number bodySize
  4122. # Information about the request initiator.
  4123. type Initiator extends object
  4124. properties
  4125. # Type of this initiator.
  4126. enum type
  4127. parser
  4128. script
  4129. preload
  4130. SignedExchange
  4131. other
  4132. # Initiator JavaScript stack trace, set for Script only.
  4133. optional Runtime.StackTrace stack
  4134. # Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
  4135. optional string url
  4136. # Initiator line number, set for Parser type or for Script type (when script is importing
  4137. # module) (0-based).
  4138. optional number lineNumber
  4139. # Initiator column number, set for Parser type or for Script type (when script is importing
  4140. # module) (0-based).
  4141. optional number columnNumber
  4142. # Cookie object
  4143. type Cookie extends object
  4144. properties
  4145. # Cookie name.
  4146. string name
  4147. # Cookie value.
  4148. string value
  4149. # Cookie domain.
  4150. string domain
  4151. # Cookie path.
  4152. string path
  4153. # Cookie expiration date as the number of seconds since the UNIX epoch.
  4154. number expires
  4155. # Cookie size.
  4156. integer size
  4157. # True if cookie is http-only.
  4158. boolean httpOnly
  4159. # True if cookie is secure.
  4160. boolean secure
  4161. # True in case of session cookie.
  4162. boolean session
  4163. # Cookie SameSite type.
  4164. optional CookieSameSite sameSite
  4165. # Cookie Priority
  4166. experimental CookiePriority priority
  4167. # Types of reasons why a cookie may not be stored from a response.
  4168. experimental type SetCookieBlockedReason extends string
  4169. enum
  4170. # The cookie had the "Secure" attribute but was not received over a secure connection.
  4171. SecureOnly
  4172. # The cookie had the "SameSite=Strict" attribute but came from a cross-origin response.
  4173. # This includes navigation requests intitiated by other origins.
  4174. SameSiteStrict
  4175. # The cookie had the "SameSite=Lax" attribute but came from a cross-origin response.
  4176. SameSiteLax
  4177. # The cookie didn't specify a "SameSite" attribute and was defaulted to "SameSite=Lax" and
  4178. # broke the same rules specified in the SameSiteLax value.
  4179. SameSiteUnspecifiedTreatedAsLax
  4180. # The cookie had the "SameSite=None" attribute but did not specify the "Secure" attribute,
  4181. # which is required in order to use "SameSite=None".
  4182. SameSiteNoneInsecure
  4183. # The cookie was not stored due to user preferences.
  4184. UserPreferences
  4185. # The syntax of the Set-Cookie header of the response was invalid.
  4186. SyntaxError
  4187. # The scheme of the connection is not allowed to store cookies.
  4188. SchemeNotSupported
  4189. # The cookie was not sent over a secure connection and would have overwritten a cookie with
  4190. # the Secure attribute.
  4191. OverwriteSecure
  4192. # The cookie's domain attribute was invalid with regards to the current host url.
  4193. InvalidDomain
  4194. # The cookie used the "__Secure-" or "__Host-" prefix in its name and broke the additional
  4195. # rules applied to cookies with these prefixes as defined in
  4196. # https://tools.ietf.org/html/draft-west-cookie-prefixes-05
  4197. InvalidPrefix
  4198. # An unknown error was encountered when trying to store this cookie.
  4199. UnknownError
  4200. # The cookie had the "SameSite=Strict" attribute but came from a response
  4201. # with the same registrable domain but a different scheme.
  4202. # This includes navigation requests intitiated by other origins.
  4203. # This is the "Schemeful Same-Site" version of the blocked reason.
  4204. SchemefulSameSiteStrict
  4205. # The cookie had the "SameSite=Lax" attribute but came from a response
  4206. # with the same registrable domain but a different scheme.
  4207. # This is the "Schemeful Same-Site" version of the blocked reason.
  4208. SchemefulSameSiteLax
  4209. # The cookie didn't specify a "SameSite" attribute and was defaulted to
  4210. # "SameSite=Lax" and broke the same rules specified in the SchemefulSameSiteLax
  4211. # value.
  4212. # This is the "Schemeful Same-Site" version of the blocked reason.
  4213. SchemefulSameSiteUnspecifiedTreatedAsLax
  4214. # Types of reasons why a cookie may not be sent with a request.
  4215. experimental type CookieBlockedReason extends string
  4216. enum
  4217. # The cookie had the "Secure" attribute and the connection was not secure.
  4218. SecureOnly
  4219. # The cookie's path was not within the request url's path.
  4220. NotOnPath
  4221. # The cookie's domain is not configured to match the request url's domain, even though they
  4222. # share a common TLD+1 (TLD+1 of foo.bar.example.com is example.com).
  4223. DomainMismatch
  4224. # The cookie had the "SameSite=Strict" attribute and the request was made on on a different
  4225. # site. This includes navigation requests initiated by other sites.
  4226. SameSiteStrict
  4227. # The cookie had the "SameSite=Lax" attribute and the request was made on a different site.
  4228. # This does not include navigation requests initiated by other sites.
  4229. SameSiteLax
  4230. # The cookie didn't specify a SameSite attribute when it was stored and was defaulted to
  4231. # "SameSite=Lax" and broke the same rules specified in the SameSiteLax value. The cookie had
  4232. # to have been set with "SameSite=None" to enable third-party usage.
  4233. SameSiteUnspecifiedTreatedAsLax
  4234. # The cookie had the "SameSite=None" attribute and the connection was not secure. Cookies
  4235. # without SameSite restrictions must be sent over a secure connection.
  4236. SameSiteNoneInsecure
  4237. # The cookie was not sent due to user preferences.
  4238. UserPreferences
  4239. # An unknown error was encountered when trying to send this cookie.
  4240. UnknownError
  4241. # The cookie had the "SameSite=Strict" attribute but came from a response
  4242. # with the same registrable domain but a different scheme.
  4243. # This includes navigation requests intitiated by other origins.
  4244. # This is the "Schemeful Same-Site" version of the blocked reason.
  4245. SchemefulSameSiteStrict
  4246. # The cookie had the "SameSite=Lax" attribute but came from a response
  4247. # with the same registrable domain but a different scheme.
  4248. # This is the "Schemeful Same-Site" version of the blocked reason.
  4249. SchemefulSameSiteLax
  4250. # The cookie didn't specify a "SameSite" attribute and was defaulted to
  4251. # "SameSite=Lax" and broke the same rules specified in the SchemefulSameSiteLax
  4252. # value.
  4253. # This is the "Schemeful Same-Site" version of the blocked reason.
  4254. SchemefulSameSiteUnspecifiedTreatedAsLax
  4255. # A cookie which was not stored from a response with the corresponding reason.
  4256. experimental type BlockedSetCookieWithReason extends object
  4257. properties
  4258. # The reason(s) this cookie was blocked.
  4259. array of SetCookieBlockedReason blockedReasons
  4260. # The string representing this individual cookie as it would appear in the header.
  4261. # This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
  4262. string cookieLine
  4263. # The cookie object which represents the cookie which was not stored. It is optional because
  4264. # sometimes complete cookie information is not available, such as in the case of parsing
  4265. # errors.
  4266. optional Cookie cookie
  4267. # A cookie with was not sent with a request with the corresponding reason.
  4268. experimental type BlockedCookieWithReason extends object
  4269. properties
  4270. # The reason(s) the cookie was blocked.
  4271. array of CookieBlockedReason blockedReasons
  4272. # The cookie object representing the cookie which was not sent.
  4273. Cookie cookie
  4274. # Cookie parameter object
  4275. type CookieParam extends object
  4276. properties
  4277. # Cookie name.
  4278. string name
  4279. # Cookie value.
  4280. string value
  4281. # The request-URI to associate with the setting of the cookie. This value can affect the
  4282. # default domain and path values of the created cookie.
  4283. optional string url
  4284. # Cookie domain.
  4285. optional string domain
  4286. # Cookie path.
  4287. optional string path
  4288. # True if cookie is secure.
  4289. optional boolean secure
  4290. # True if cookie is http-only.
  4291. optional boolean httpOnly
  4292. # Cookie SameSite type.
  4293. optional CookieSameSite sameSite
  4294. # Cookie expiration date, session cookie if not set
  4295. optional TimeSinceEpoch expires
  4296. # Cookie Priority.
  4297. experimental optional CookiePriority priority
  4298. # Authorization challenge for HTTP status code 401 or 407.
  4299. experimental type AuthChallenge extends object
  4300. properties
  4301. # Source of the authentication challenge.
  4302. optional enum source
  4303. Server
  4304. Proxy
  4305. # Origin of the challenger.
  4306. string origin
  4307. # The authentication scheme used, such as basic or digest
  4308. string scheme
  4309. # The realm of the challenge. May be empty.
  4310. string realm
  4311. # Response to an AuthChallenge.
  4312. experimental type AuthChallengeResponse extends object
  4313. properties
  4314. # The decision on what to do in response to the authorization challenge. Default means
  4315. # deferring to the default behavior of the net stack, which will likely either the Cancel
  4316. # authentication or display a popup dialog box.
  4317. enum response
  4318. Default
  4319. CancelAuth
  4320. ProvideCredentials
  4321. # The username to provide, possibly empty. Should only be set if response is
  4322. # ProvideCredentials.
  4323. optional string username
  4324. # The password to provide, possibly empty. Should only be set if response is
  4325. # ProvideCredentials.
  4326. optional string password
  4327. # Stages of the interception to begin intercepting. Request will intercept before the request is
  4328. # sent. Response will intercept after the response is received.
  4329. experimental type InterceptionStage extends string
  4330. enum
  4331. Request
  4332. HeadersReceived
  4333. # Request pattern for interception.
  4334. experimental type RequestPattern extends object
  4335. properties
  4336. # Wildcards ('*' -> zero or more, '?' -> exactly one) are allowed. Escape character is
  4337. # backslash. Omitting is equivalent to "*".
  4338. optional string urlPattern
  4339. # If set, only requests for matching resource types will be intercepted.
  4340. optional ResourceType resourceType
  4341. # Stage at wich to begin intercepting requests. Default is Request.
  4342. optional InterceptionStage interceptionStage
  4343. # Information about a signed exchange signature.
  4344. # https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
  4345. experimental type SignedExchangeSignature extends object
  4346. properties
  4347. # Signed exchange signature label.
  4348. string label
  4349. # The hex string of signed exchange signature.
  4350. string signature
  4351. # Signed exchange signature integrity.
  4352. string integrity
  4353. # Signed exchange signature cert Url.
  4354. optional string certUrl
  4355. # The hex string of signed exchange signature cert sha256.
  4356. optional string certSha256
  4357. # Signed exchange signature validity Url.
  4358. string validityUrl
  4359. # Signed exchange signature date.
  4360. integer date
  4361. # Signed exchange signature expires.
  4362. integer expires
  4363. # The encoded certificates.
  4364. optional array of string certificates
  4365. # Information about a signed exchange header.
  4366. # https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
  4367. experimental type SignedExchangeHeader extends object
  4368. properties
  4369. # Signed exchange request URL.
  4370. string requestUrl
  4371. # Signed exchange response code.
  4372. integer responseCode
  4373. # Signed exchange response headers.
  4374. Headers responseHeaders
  4375. # Signed exchange response signature.
  4376. array of SignedExchangeSignature signatures
  4377. # Signed exchange header integrity hash in the form of "sha256-<base64-hash-value>".
  4378. string headerIntegrity
  4379. # Field type for a signed exchange related error.
  4380. experimental type SignedExchangeErrorField extends string
  4381. enum
  4382. signatureSig
  4383. signatureIntegrity
  4384. signatureCertUrl
  4385. signatureCertSha256
  4386. signatureValidityUrl
  4387. signatureTimestamps
  4388. # Information about a signed exchange response.
  4389. experimental type SignedExchangeError extends object
  4390. properties
  4391. # Error message.
  4392. string message
  4393. # The index of the signature which caused the error.
  4394. optional integer signatureIndex
  4395. # The field which caused the error.
  4396. optional SignedExchangeErrorField errorField
  4397. # Information about a signed exchange response.
  4398. experimental type SignedExchangeInfo extends object
  4399. properties
  4400. # The outer response of signed HTTP exchange which was received from network.
  4401. Response outerResponse
  4402. # Information about the signed exchange header.
  4403. optional SignedExchangeHeader header
  4404. # Security details for the signed exchange header.
  4405. optional SecurityDetails securityDetails
  4406. # Errors occurred while handling the signed exchagne.
  4407. optional array of SignedExchangeError errors
  4408. # Tells whether clearing browser cache is supported.
  4409. deprecated command canClearBrowserCache
  4410. returns
  4411. # True if browser cache can be cleared.
  4412. boolean result
  4413. # Tells whether clearing browser cookies is supported.
  4414. deprecated command canClearBrowserCookies
  4415. returns
  4416. # True if browser cookies can be cleared.
  4417. boolean result
  4418. # Tells whether emulation of network conditions is supported.
  4419. deprecated command canEmulateNetworkConditions
  4420. returns
  4421. # True if emulation of network conditions is supported.
  4422. boolean result
  4423. # Clears browser cache.
  4424. command clearBrowserCache
  4425. # Clears browser cookies.
  4426. command clearBrowserCookies
  4427. # Response to Network.requestIntercepted which either modifies the request to continue with any
  4428. # modifications, or blocks it, or completes it with the provided response bytes. If a network
  4429. # fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted
  4430. # event will be sent with the same InterceptionId.
  4431. # Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead.
  4432. experimental deprecated command continueInterceptedRequest
  4433. parameters
  4434. InterceptionId interceptionId
  4435. # If set this causes the request to fail with the given reason. Passing `Aborted` for requests
  4436. # marked with `isNavigationRequest` also cancels the navigation. Must not be set in response
  4437. # to an authChallenge.
  4438. optional ErrorReason errorReason
  4439. # If set the requests completes using with the provided base64 encoded raw response, including
  4440. # HTTP status line and headers etc... Must not be set in response to an authChallenge.
  4441. optional binary rawResponse
  4442. # If set the request url will be modified in a way that's not observable by page. Must not be
  4443. # set in response to an authChallenge.
  4444. optional string url
  4445. # If set this allows the request method to be overridden. Must not be set in response to an
  4446. # authChallenge.
  4447. optional string method
  4448. # If set this allows postData to be set. Must not be set in response to an authChallenge.
  4449. optional string postData
  4450. # If set this allows the request headers to be changed. Must not be set in response to an
  4451. # authChallenge.
  4452. optional Headers headers
  4453. # Response to a requestIntercepted with an authChallenge. Must not be set otherwise.
  4454. optional AuthChallengeResponse authChallengeResponse
  4455. # Deletes browser cookies with matching name and url or domain/path pair.
  4456. command deleteCookies
  4457. parameters
  4458. # Name of the cookies to remove.
  4459. string name
  4460. # If specified, deletes all the cookies with the given name where domain and path match
  4461. # provided URL.
  4462. optional string url
  4463. # If specified, deletes only cookies with the exact domain.
  4464. optional string domain
  4465. # If specified, deletes only cookies with the exact path.
  4466. optional string path
  4467. # Disables network tracking, prevents network events from being sent to the client.
  4468. command disable
  4469. # Activates emulation of network conditions.
  4470. command emulateNetworkConditions
  4471. parameters
  4472. # True to emulate internet disconnection.
  4473. boolean offline
  4474. # Minimum latency from request sent to response headers received (ms).
  4475. number latency
  4476. # Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
  4477. number downloadThroughput
  4478. # Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
  4479. number uploadThroughput
  4480. # Connection type if known.
  4481. optional ConnectionType connectionType
  4482. # Enables network tracking, network events will now be delivered to the client.
  4483. command enable
  4484. parameters
  4485. # Buffer size in bytes to use when preserving network payloads (XHRs, etc).
  4486. experimental optional integer maxTotalBufferSize
  4487. # Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).
  4488. experimental optional integer maxResourceBufferSize
  4489. # Longest post body size (in bytes) that would be included in requestWillBeSent notification
  4490. optional integer maxPostDataSize
  4491. # Returns all browser cookies. Depending on the backend support, will return detailed cookie
  4492. # information in the `cookies` field.
  4493. command getAllCookies
  4494. returns
  4495. # Array of cookie objects.
  4496. array of Cookie cookies
  4497. # Returns the DER-encoded certificate.
  4498. experimental command getCertificate
  4499. parameters
  4500. # Origin to get certificate for.
  4501. string origin
  4502. returns
  4503. array of string tableNames
  4504. # Returns all browser cookies for the current URL. Depending on the backend support, will return
  4505. # detailed cookie information in the `cookies` field.
  4506. command getCookies
  4507. parameters
  4508. # The list of URLs for which applicable cookies will be fetched.
  4509. # If not specified, it's assumed to be set to the list containing
  4510. # the URLs of the page and all of its subframes.
  4511. optional array of string urls
  4512. returns
  4513. # Array of cookie objects.
  4514. array of Cookie cookies
  4515. # Returns content served for the given request.
  4516. command getResponseBody
  4517. parameters
  4518. # Identifier of the network request to get content for.
  4519. RequestId requestId
  4520. returns
  4521. # Response body.
  4522. string body
  4523. # True, if content was sent as base64.
  4524. boolean base64Encoded
  4525. # Returns post data sent with the request. Returns an error when no data was sent with the request.
  4526. command getRequestPostData
  4527. parameters
  4528. # Identifier of the network request to get content for.
  4529. RequestId requestId
  4530. returns
  4531. # Request body string, omitting files from multipart requests
  4532. string postData
  4533. # Returns content served for the given currently intercepted request.
  4534. experimental command getResponseBodyForInterception
  4535. parameters
  4536. # Identifier for the intercepted request to get body for.
  4537. InterceptionId interceptionId
  4538. returns
  4539. # Response body.
  4540. string body
  4541. # True, if content was sent as base64.
  4542. boolean base64Encoded
  4543. # Returns a handle to the stream representing the response body. Note that after this command,
  4544. # the intercepted request can't be continued as is -- you either need to cancel it or to provide
  4545. # the response body. The stream only supports sequential read, IO.read will fail if the position
  4546. # is specified.
  4547. experimental command takeResponseBodyForInterceptionAsStream
  4548. parameters
  4549. InterceptionId interceptionId
  4550. returns
  4551. IO.StreamHandle stream
  4552. # This method sends a new XMLHttpRequest which is identical to the original one. The following
  4553. # parameters should be identical: method, url, async, request body, extra headers, withCredentials
  4554. # attribute, user, password.
  4555. experimental command replayXHR
  4556. parameters
  4557. # Identifier of XHR to replay.
  4558. RequestId requestId
  4559. # Searches for given string in response content.
  4560. experimental command searchInResponseBody
  4561. parameters
  4562. # Identifier of the network response to search.
  4563. RequestId requestId
  4564. # String to search for.
  4565. string query
  4566. # If true, search is case sensitive.
  4567. optional boolean caseSensitive
  4568. # If true, treats string parameter as regex.
  4569. optional boolean isRegex
  4570. returns
  4571. # List of search matches.
  4572. array of Debugger.SearchMatch result
  4573. # Blocks URLs from loading.
  4574. experimental command setBlockedURLs
  4575. parameters
  4576. # URL patterns to block. Wildcards ('*') are allowed.
  4577. array of string urls
  4578. # Toggles ignoring of service worker for each request.
  4579. experimental command setBypassServiceWorker
  4580. parameters
  4581. # Bypass service worker and load from network.
  4582. boolean bypass
  4583. # Toggles ignoring cache for each request. If `true`, cache will not be used.
  4584. command setCacheDisabled
  4585. parameters
  4586. # Cache disabled state.
  4587. boolean cacheDisabled
  4588. # Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
  4589. command setCookie
  4590. parameters
  4591. # Cookie name.
  4592. string name
  4593. # Cookie value.
  4594. string value
  4595. # The request-URI to associate with the setting of the cookie. This value can affect the
  4596. # default domain and path values of the created cookie.
  4597. optional string url
  4598. # Cookie domain.
  4599. optional string domain
  4600. # Cookie path.
  4601. optional string path
  4602. # True if cookie is secure.
  4603. optional boolean secure
  4604. # True if cookie is http-only.
  4605. optional boolean httpOnly
  4606. # Cookie SameSite type.
  4607. optional CookieSameSite sameSite
  4608. # Cookie expiration date, session cookie if not set
  4609. optional TimeSinceEpoch expires
  4610. # Cookie Priority type.
  4611. experimental optional CookiePriority priority
  4612. returns
  4613. # Always set to true. If an error occurs, the response indicates protocol error.
  4614. deprecated boolean success
  4615. # Sets given cookies.
  4616. command setCookies
  4617. parameters
  4618. # Cookies to be set.
  4619. array of CookieParam cookies
  4620. # For testing.
  4621. experimental command setDataSizeLimitsForTest
  4622. parameters
  4623. # Maximum total buffer size.
  4624. integer maxTotalSize
  4625. # Maximum per-resource size.
  4626. integer maxResourceSize
  4627. # Specifies whether to always send extra HTTP headers with the requests from this page.
  4628. command setExtraHTTPHeaders
  4629. parameters
  4630. # Map with extra HTTP headers.
  4631. Headers headers
  4632. # Specifies whether to sned a debug header to all outgoing requests.
  4633. experimental command setAttachDebugHeader
  4634. parameters
  4635. # Whether to send a debug header.
  4636. boolean enabled
  4637. # Sets the requests to intercept that match the provided patterns and optionally resource types.
  4638. # Deprecated, please use Fetch.enable instead.
  4639. experimental deprecated command setRequestInterception
  4640. parameters
  4641. # Requests matching any of these patterns will be forwarded and wait for the corresponding
  4642. # continueInterceptedRequest call.
  4643. array of RequestPattern patterns
  4644. # Allows overriding user agent with the given string.
  4645. command setUserAgentOverride
  4646. redirect Emulation
  4647. parameters
  4648. # User agent to use.
  4649. string userAgent
  4650. # Browser langugage to emulate.
  4651. optional string acceptLanguage
  4652. # The platform navigator.platform should return.
  4653. optional string platform
  4654. # To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
  4655. experimental optional Emulation.UserAgentMetadata userAgentMetadata
  4656. # Fired when data chunk was received over the network.
  4657. event dataReceived
  4658. parameters
  4659. # Request identifier.
  4660. RequestId requestId
  4661. # Timestamp.
  4662. MonotonicTime timestamp
  4663. # Data chunk length.
  4664. integer dataLength
  4665. # Actual bytes received (might be less than dataLength for compressed encodings).
  4666. integer encodedDataLength
  4667. # Fired when EventSource message is received.
  4668. event eventSourceMessageReceived
  4669. parameters
  4670. # Request identifier.
  4671. RequestId requestId
  4672. # Timestamp.
  4673. MonotonicTime timestamp
  4674. # Message type.
  4675. string eventName
  4676. # Message identifier.
  4677. string eventId
  4678. # Message content.
  4679. string data
  4680. # Fired when HTTP request has failed to load.
  4681. event loadingFailed
  4682. parameters
  4683. # Request identifier.
  4684. RequestId requestId
  4685. # Timestamp.
  4686. MonotonicTime timestamp
  4687. # Resource type.
  4688. ResourceType type
  4689. # User friendly error message.
  4690. string errorText
  4691. # True if loading was canceled.
  4692. optional boolean canceled
  4693. # The reason why loading was blocked, if any.
  4694. optional BlockedReason blockedReason
  4695. # Fired when HTTP request has finished loading.
  4696. event loadingFinished
  4697. parameters
  4698. # Request identifier.
  4699. RequestId requestId
  4700. # Timestamp.
  4701. MonotonicTime timestamp
  4702. # Total number of bytes received for this request.
  4703. number encodedDataLength
  4704. # Set when 1) response was blocked by Cross-Origin Read Blocking and also
  4705. # 2) this needs to be reported to the DevTools console.
  4706. optional boolean shouldReportCorbBlocking
  4707. # Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
  4708. # mocked.
  4709. # Deprecated, use Fetch.requestPaused instead.
  4710. experimental deprecated event requestIntercepted
  4711. parameters
  4712. # Each request the page makes will have a unique id, however if any redirects are encountered
  4713. # while processing that fetch, they will be reported with the same id as the original fetch.
  4714. # Likewise if HTTP authentication is needed then the same fetch id will be used.
  4715. InterceptionId interceptionId
  4716. Request request
  4717. # The id of the frame that initiated the request.
  4718. Page.FrameId frameId
  4719. # How the requested resource will be used.
  4720. ResourceType resourceType
  4721. # Whether this is a navigation request, which can abort the navigation completely.
  4722. boolean isNavigationRequest
  4723. # Set if the request is a navigation that will result in a download.
  4724. # Only present after response is received from the server (i.e. HeadersReceived stage).
  4725. optional boolean isDownload
  4726. # Redirect location, only sent if a redirect was intercepted.
  4727. optional string redirectUrl
  4728. # Details of the Authorization Challenge encountered. If this is set then
  4729. # continueInterceptedRequest must contain an authChallengeResponse.
  4730. optional AuthChallenge authChallenge
  4731. # Response error if intercepted at response stage or if redirect occurred while intercepting
  4732. # request.
  4733. optional ErrorReason responseErrorReason
  4734. # Response code if intercepted at response stage or if redirect occurred while intercepting
  4735. # request or auth retry occurred.
  4736. optional integer responseStatusCode
  4737. # Response headers if intercepted at the response stage or if redirect occurred while
  4738. # intercepting request or auth retry occurred.
  4739. optional Headers responseHeaders
  4740. # If the intercepted request had a corresponding requestWillBeSent event fired for it, then
  4741. # this requestId will be the same as the requestId present in the requestWillBeSent event.
  4742. optional RequestId requestId
  4743. # Fired if request ended up loading from cache.
  4744. event requestServedFromCache
  4745. parameters
  4746. # Request identifier.
  4747. RequestId requestId
  4748. # Fired when page is about to send HTTP request.
  4749. event requestWillBeSent
  4750. parameters
  4751. # Request identifier.
  4752. RequestId requestId
  4753. # Loader identifier. Empty string if the request is fetched from worker.
  4754. LoaderId loaderId
  4755. # URL of the document this request is loaded for.
  4756. string documentURL
  4757. # Request data.
  4758. Request request
  4759. # Timestamp.
  4760. MonotonicTime timestamp
  4761. # Timestamp.
  4762. TimeSinceEpoch wallTime
  4763. # Request initiator.
  4764. Initiator initiator
  4765. # Redirect response data.
  4766. optional Response redirectResponse
  4767. # Type of this resource.
  4768. optional ResourceType type
  4769. # Frame identifier.
  4770. optional Page.FrameId frameId
  4771. # Whether the request is initiated by a user gesture. Defaults to false.
  4772. optional boolean hasUserGesture
  4773. # Fired when resource loading priority is changed
  4774. experimental event resourceChangedPriority
  4775. parameters
  4776. # Request identifier.
  4777. RequestId requestId
  4778. # New priority
  4779. ResourcePriority newPriority
  4780. # Timestamp.
  4781. MonotonicTime timestamp
  4782. # Fired when a signed exchange was received over the network
  4783. experimental event signedExchangeReceived
  4784. parameters
  4785. # Request identifier.
  4786. RequestId requestId
  4787. # Information about the signed exchange response.
  4788. SignedExchangeInfo info
  4789. # Fired when HTTP response is available.
  4790. event responseReceived
  4791. parameters
  4792. # Request identifier.
  4793. RequestId requestId
  4794. # Loader identifier. Empty string if the request is fetched from worker.
  4795. LoaderId loaderId
  4796. # Timestamp.
  4797. MonotonicTime timestamp
  4798. # Resource type.
  4799. ResourceType type
  4800. # Response data.
  4801. Response response
  4802. # Frame identifier.
  4803. optional Page.FrameId frameId
  4804. # Fired when WebSocket is closed.
  4805. event webSocketClosed
  4806. parameters
  4807. # Request identifier.
  4808. RequestId requestId
  4809. # Timestamp.
  4810. MonotonicTime timestamp
  4811. # Fired upon WebSocket creation.
  4812. event webSocketCreated
  4813. parameters
  4814. # Request identifier.
  4815. RequestId requestId
  4816. # WebSocket request URL.
  4817. string url
  4818. # Request initiator.
  4819. optional Initiator initiator
  4820. # Fired when WebSocket message error occurs.
  4821. event webSocketFrameError
  4822. parameters
  4823. # Request identifier.
  4824. RequestId requestId
  4825. # Timestamp.
  4826. MonotonicTime timestamp
  4827. # WebSocket error message.
  4828. string errorMessage
  4829. # Fired when WebSocket message is received.
  4830. event webSocketFrameReceived
  4831. parameters
  4832. # Request identifier.
  4833. RequestId requestId
  4834. # Timestamp.
  4835. MonotonicTime timestamp
  4836. # WebSocket response data.
  4837. WebSocketFrame response
  4838. # Fired when WebSocket message is sent.
  4839. event webSocketFrameSent
  4840. parameters
  4841. # Request identifier.
  4842. RequestId requestId
  4843. # Timestamp.
  4844. MonotonicTime timestamp
  4845. # WebSocket response data.
  4846. WebSocketFrame response
  4847. # Fired when WebSocket handshake response becomes available.
  4848. event webSocketHandshakeResponseReceived
  4849. parameters
  4850. # Request identifier.
  4851. RequestId requestId
  4852. # Timestamp.
  4853. MonotonicTime timestamp
  4854. # WebSocket response data.
  4855. WebSocketResponse response
  4856. # Fired when WebSocket is about to initiate handshake.
  4857. event webSocketWillSendHandshakeRequest
  4858. parameters
  4859. # Request identifier.
  4860. RequestId requestId
  4861. # Timestamp.
  4862. MonotonicTime timestamp
  4863. # UTC Timestamp.
  4864. TimeSinceEpoch wallTime
  4865. # WebSocket request data.
  4866. WebSocketRequest request
  4867. # Fired when additional information about a requestWillBeSent event is available from the
  4868. # network stack. Not every requestWillBeSent event will have an additional
  4869. # requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent
  4870. # or requestWillBeSentExtraInfo will be fired first for the same request.
  4871. experimental event requestWillBeSentExtraInfo
  4872. parameters
  4873. # Request identifier. Used to match this information to an existing requestWillBeSent event.
  4874. RequestId requestId
  4875. # A list of cookies potentially associated to the requested URL. This includes both cookies sent with
  4876. # the request and the ones not sent; the latter are distinguished by having blockedReason field set.
  4877. array of BlockedCookieWithReason associatedCookies
  4878. # Raw request headers as they will be sent over the wire.
  4879. Headers headers
  4880. # Fired when additional information about a responseReceived event is available from the network
  4881. # stack. Not every responseReceived event will have an additional responseReceivedExtraInfo for
  4882. # it, and responseReceivedExtraInfo may be fired before or after responseReceived.
  4883. experimental event responseReceivedExtraInfo
  4884. parameters
  4885. # Request identifier. Used to match this information to another responseReceived event.
  4886. RequestId requestId
  4887. # A list of cookies which were not stored from the response along with the corresponding
  4888. # reasons for blocking. The cookies here may not be valid due to syntax errors, which
  4889. # are represented by the invalid cookie line string instead of a proper cookie.
  4890. array of BlockedSetCookieWithReason blockedCookies
  4891. # Raw response headers as they were received over the wire.
  4892. Headers headers
  4893. # Raw response header text as it was received over the wire. The raw text may not always be
  4894. # available, such as in the case of HTTP/2 or QUIC.
  4895. optional string headersText
  4896. experimental type CrossOriginOpenerPolicyValue extends string
  4897. enum
  4898. SameOrigin
  4899. SameOriginAllowPopups
  4900. UnsafeNone
  4901. SameOriginPlusCoep
  4902. experimental type CrossOriginOpenerPolicyStatus extends object
  4903. properties
  4904. CrossOriginOpenerPolicyValue value
  4905. CrossOriginOpenerPolicyValue reportOnlyValue
  4906. optional string reportingEndpoint
  4907. optional string reportOnlyReportingEndpoint
  4908. experimental type CrossOriginEmbedderPolicyValue extends string
  4909. enum
  4910. None
  4911. RequireCorp
  4912. experimental type CrossOriginEmbedderPolicyStatus extends object
  4913. properties
  4914. CrossOriginEmbedderPolicyValue value
  4915. CrossOriginEmbedderPolicyValue reportOnlyValue
  4916. optional string reportingEndpoint
  4917. optional string reportOnlyReportingEndpoint
  4918. experimental type SecurityIsolationStatus extends object
  4919. properties
  4920. CrossOriginOpenerPolicyStatus coop
  4921. CrossOriginEmbedderPolicyStatus coep
  4922. # Returns information about the COEP/COOP isolation status.
  4923. experimental command getSecurityIsolationStatus
  4924. parameters
  4925. # If no frameId is provided, the status of the target is provided.
  4926. optional Page.FrameId frameId
  4927. returns
  4928. SecurityIsolationStatus status
  4929. # An object providing the result of a network resource load.
  4930. experimental type LoadNetworkResourcePageResult extends object
  4931. properties
  4932. boolean success
  4933. # Optional values used for error reporting.
  4934. optional number netError
  4935. optional string netErrorName
  4936. optional number httpStatusCode
  4937. # If successful, one of the following two fields holds the result.
  4938. optional IO.StreamHandle stream
  4939. # Response headers.
  4940. optional Network.Headers headers
  4941. # An options object that may be extended later to better support CORS,
  4942. # CORB and streaming.
  4943. experimental type LoadNetworkResourceOptions extends object
  4944. properties
  4945. boolean disableCache
  4946. boolean includeCredentials
  4947. # Fetches the resource and returns the content.
  4948. experimental command loadNetworkResource
  4949. parameters
  4950. # Frame id to get the resource for.
  4951. Page.FrameId frameId
  4952. # URL of the resource to get content for.
  4953. string url
  4954. # Options for the request.
  4955. LoadNetworkResourceOptions options
  4956. returns
  4957. LoadNetworkResourcePageResult resource
  4958. # This domain provides various functionality related to drawing atop the inspected page.
  4959. experimental domain Overlay
  4960. depends on DOM
  4961. depends on Page
  4962. depends on Runtime
  4963. # Configuration data for drawing the source order of an elements children.
  4964. type SourceOrderConfig extends object
  4965. properties
  4966. # the color to outline the givent element in.
  4967. DOM.RGBA parentOutlineColor
  4968. # the color to outline the child elements in.
  4969. DOM.RGBA childOutlineColor
  4970. # Configuration data for the highlighting of Grid elements.
  4971. type GridHighlightConfig extends object
  4972. properties
  4973. # Whether the extension lines from grid cells to the rulers should be shown (default: false).
  4974. optional boolean showGridExtensionLines
  4975. # Show Positive line number labels (default: false).
  4976. optional boolean showPositiveLineNumbers
  4977. # Show Negative line number labels (default: false).
  4978. optional boolean showNegativeLineNumbers
  4979. # Show area name labels (default: false).
  4980. optional boolean showAreaNames
  4981. # Show line name labels (default: false).
  4982. optional boolean showLineNames
  4983. # Show track size labels (default: false).
  4984. optional boolean showTrackSizes
  4985. # The grid container border highlight color (default: transparent).
  4986. optional DOM.RGBA gridBorderColor
  4987. # The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.
  4988. deprecated optional DOM.RGBA cellBorderColor
  4989. # The row line color (default: transparent).
  4990. optional DOM.RGBA rowLineColor
  4991. # The column line color (default: transparent).
  4992. optional DOM.RGBA columnLineColor
  4993. # Whether the grid border is dashed (default: false).
  4994. optional boolean gridBorderDash
  4995. # Whether the cell border is dashed (default: false). Deprecated, please us rowLineDash and columnLineDash instead.
  4996. deprecated optional boolean cellBorderDash
  4997. # Whether row lines are dashed (default: false).
  4998. optional boolean rowLineDash
  4999. # Whether column lines are dashed (default: false).
  5000. optional boolean columnLineDash
  5001. # The row gap highlight fill color (default: transparent).
  5002. optional DOM.RGBA rowGapColor
  5003. # The row gap hatching fill color (default: transparent).
  5004. optional DOM.RGBA rowHatchColor
  5005. # The column gap highlight fill color (default: transparent).
  5006. optional DOM.RGBA columnGapColor
  5007. # The column gap hatching fill color (default: transparent).
  5008. optional DOM.RGBA columnHatchColor
  5009. # The named grid areas border color (Default: transparent).
  5010. optional DOM.RGBA areaBorderColor
  5011. # The grid container background color (Default: transparent).
  5012. optional DOM.RGBA gridBackgroundColor
  5013. # Configuration data for the highlighting of page elements.
  5014. type HighlightConfig extends object
  5015. properties
  5016. # Whether the node info tooltip should be shown (default: false).
  5017. optional boolean showInfo
  5018. # Whether the node styles in the tooltip (default: false).
  5019. optional boolean showStyles
  5020. # Whether the rulers should be shown (default: false).
  5021. optional boolean showRulers
  5022. # Whether the a11y info should be shown (default: true).
  5023. optional boolean showAccessibilityInfo
  5024. # Whether the extension lines from node to the rulers should be shown (default: false).
  5025. optional boolean showExtensionLines
  5026. # The content box highlight fill color (default: transparent).
  5027. optional DOM.RGBA contentColor
  5028. # The padding highlight fill color (default: transparent).
  5029. optional DOM.RGBA paddingColor
  5030. # The border highlight fill color (default: transparent).
  5031. optional DOM.RGBA borderColor
  5032. # The margin highlight fill color (default: transparent).
  5033. optional DOM.RGBA marginColor
  5034. # The event target element highlight fill color (default: transparent).
  5035. optional DOM.RGBA eventTargetColor
  5036. # The shape outside fill color (default: transparent).
  5037. optional DOM.RGBA shapeColor
  5038. # The shape margin fill color (default: transparent).
  5039. optional DOM.RGBA shapeMarginColor
  5040. # The grid layout color (default: transparent).
  5041. optional DOM.RGBA cssGridColor
  5042. # The color format used to format color styles (default: hex).
  5043. optional ColorFormat colorFormat
  5044. # The grid layout highlight configuration (default: all transparent).
  5045. optional GridHighlightConfig gridHighlightConfig
  5046. type ColorFormat extends string
  5047. enum
  5048. rgb
  5049. hsl
  5050. hex
  5051. # Configurations for Persistent Grid Highlight
  5052. type GridNodeHighlightConfig extends object
  5053. properties
  5054. # A descriptor for the highlight appearance.
  5055. GridHighlightConfig gridHighlightConfig
  5056. # Identifier of the node to highlight.
  5057. DOM.NodeId nodeId
  5058. # Configuration for dual screen hinge
  5059. type HingeConfig extends object
  5060. properties
  5061. # A rectangle represent hinge
  5062. DOM.Rect rect
  5063. # The content box highlight fill color (default: a dark color).
  5064. optional DOM.RGBA contentColor
  5065. # The content box highlight outline color (default: transparent).
  5066. optional DOM.RGBA outlineColor
  5067. type InspectMode extends string
  5068. enum
  5069. searchForNode
  5070. searchForUAShadowDOM
  5071. captureAreaScreenshot
  5072. showDistances
  5073. none
  5074. # Disables domain notifications.
  5075. command disable
  5076. # Enables domain notifications.
  5077. command enable
  5078. # For testing.
  5079. command getHighlightObjectForTest
  5080. parameters
  5081. # Id of the node to get highlight object for.
  5082. DOM.NodeId nodeId
  5083. # Whether to include distance info.
  5084. optional boolean includeDistance
  5085. # Whether to include style info.
  5086. optional boolean includeStyle
  5087. # The color format to get config with (default: hex).
  5088. optional ColorFormat colorFormat
  5089. # Whether to show accessibility info (default: true).
  5090. optional boolean showAccessibilityInfo
  5091. returns
  5092. # Highlight data for the node.
  5093. object highlight
  5094. # For Persistent Grid testing.
  5095. command getGridHighlightObjectsForTest
  5096. parameters
  5097. # Ids of the node to get highlight object for.
  5098. array of DOM.NodeId nodeIds
  5099. returns
  5100. # Grid Highlight data for the node ids provided.
  5101. object highlights
  5102. # For Source Order Viewer testing.
  5103. command getSourceOrderHighlightObjectForTest
  5104. parameters
  5105. # Id of the node to highlight.
  5106. DOM.NodeId nodeId
  5107. returns
  5108. # Source order highlight data for the node id provided.
  5109. object highlight
  5110. # Hides any highlight.
  5111. command hideHighlight
  5112. # Highlights owner element of the frame with given id.
  5113. command highlightFrame
  5114. parameters
  5115. # Identifier of the frame to highlight.
  5116. Page.FrameId frameId
  5117. # The content box highlight fill color (default: transparent).
  5118. optional DOM.RGBA contentColor
  5119. # The content box highlight outline color (default: transparent).
  5120. optional DOM.RGBA contentOutlineColor
  5121. # Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or
  5122. # objectId must be specified.
  5123. command highlightNode
  5124. parameters
  5125. # A descriptor for the highlight appearance.
  5126. HighlightConfig highlightConfig
  5127. # Identifier of the node to highlight.
  5128. optional DOM.NodeId nodeId
  5129. # Identifier of the backend node to highlight.
  5130. optional DOM.BackendNodeId backendNodeId
  5131. # JavaScript object id of the node to be highlighted.
  5132. optional Runtime.RemoteObjectId objectId
  5133. # Selectors to highlight relevant nodes.
  5134. optional string selector
  5135. # Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
  5136. command highlightQuad
  5137. parameters
  5138. # Quad to highlight
  5139. DOM.Quad quad
  5140. # The highlight fill color (default: transparent).
  5141. optional DOM.RGBA color
  5142. # The highlight outline color (default: transparent).
  5143. optional DOM.RGBA outlineColor
  5144. # Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
  5145. command highlightRect
  5146. parameters
  5147. # X coordinate
  5148. integer x
  5149. # Y coordinate
  5150. integer y
  5151. # Rectangle width
  5152. integer width
  5153. # Rectangle height
  5154. integer height
  5155. # The highlight fill color (default: transparent).
  5156. optional DOM.RGBA color
  5157. # The highlight outline color (default: transparent).
  5158. optional DOM.RGBA outlineColor
  5159. # Highlights the source order of the children of the DOM node with given id or with the given
  5160. # JavaScript object wrapper. Either nodeId or objectId must be specified.
  5161. command highlightSourceOrder
  5162. parameters
  5163. # A descriptor for the appearance of the overlay drawing.
  5164. SourceOrderConfig sourceOrderConfig
  5165. # Identifier of the node to highlight.
  5166. optional DOM.NodeId nodeId
  5167. # Identifier of the backend node to highlight.
  5168. optional DOM.BackendNodeId backendNodeId
  5169. # JavaScript object id of the node to be highlighted.
  5170. optional Runtime.RemoteObjectId objectId
  5171. # Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted.
  5172. # Backend then generates 'inspectNodeRequested' event upon element selection.
  5173. command setInspectMode
  5174. parameters
  5175. # Set an inspection mode.
  5176. InspectMode mode
  5177. # A descriptor for the highlight appearance of hovered-over nodes. May be omitted if `enabled
  5178. # == false`.
  5179. optional HighlightConfig highlightConfig
  5180. # Highlights owner element of all frames detected to be ads.
  5181. command setShowAdHighlights
  5182. parameters
  5183. # True for showing ad highlights
  5184. boolean show
  5185. command setPausedInDebuggerMessage
  5186. parameters
  5187. # The message to display, also triggers resume and step over controls.
  5188. optional string message
  5189. # Requests that backend shows debug borders on layers
  5190. command setShowDebugBorders
  5191. parameters
  5192. # True for showing debug borders
  5193. boolean show
  5194. # Requests that backend shows the FPS counter
  5195. command setShowFPSCounter
  5196. parameters
  5197. # True for showing the FPS counter
  5198. boolean show
  5199. # Highlight multiple elements with the CSS Grid overlay.
  5200. command setShowGridOverlays
  5201. parameters
  5202. # An array of node identifiers and descriptors for the highlight appearance.
  5203. array of GridNodeHighlightConfig gridNodeHighlightConfigs
  5204. # Requests that backend shows paint rectangles
  5205. command setShowPaintRects
  5206. parameters
  5207. # True for showing paint rectangles
  5208. boolean result
  5209. # Requests that backend shows layout shift regions
  5210. command setShowLayoutShiftRegions
  5211. parameters
  5212. # True for showing layout shift regions
  5213. boolean result
  5214. # Requests that backend shows scroll bottleneck rects
  5215. command setShowScrollBottleneckRects
  5216. parameters
  5217. # True for showing scroll bottleneck rects
  5218. boolean show
  5219. # Requests that backend shows hit-test borders on layers
  5220. command setShowHitTestBorders
  5221. parameters
  5222. # True for showing hit-test borders
  5223. boolean show
  5224. # Paints viewport size upon main frame resize.
  5225. command setShowViewportSizeOnResize
  5226. parameters
  5227. # Whether to paint size or not.
  5228. boolean show
  5229. # Add a dual screen device hinge
  5230. command setShowHinge
  5231. parameters
  5232. # hinge data, null means hideHinge
  5233. optional HingeConfig hingeConfig
  5234. # Fired when the node should be inspected. This happens after call to `setInspectMode` or when
  5235. # user manually inspects an element.
  5236. event inspectNodeRequested
  5237. parameters
  5238. # Id of the node to inspect.
  5239. DOM.BackendNodeId backendNodeId
  5240. # Fired when the node should be highlighted. This happens after call to `setInspectMode`.
  5241. event nodeHighlightRequested
  5242. parameters
  5243. DOM.NodeId nodeId
  5244. # Fired when user asks to capture screenshot of some area on the page.
  5245. event screenshotRequested
  5246. parameters
  5247. # Viewport to capture, in device independent pixels (dip).
  5248. Page.Viewport viewport
  5249. # Fired when user cancels the inspect mode.
  5250. event inspectModeCanceled
  5251. # Actions and events related to the inspected page belong to the page domain.
  5252. domain Page
  5253. depends on Debugger
  5254. depends on DOM
  5255. depends on IO
  5256. depends on Network
  5257. depends on Runtime
  5258. # Unique frame identifier.
  5259. type FrameId extends string
  5260. # Indicates whether a frame has been identified as an ad.
  5261. experimental type AdFrameType extends string
  5262. enum
  5263. none
  5264. # This frame is a subframe of an ad frame.
  5265. child
  5266. # This frame is the root of an ad frame.
  5267. root
  5268. # Indicates whether the frame is a secure context and why it is the case.
  5269. experimental type SecureContextType extends string
  5270. enum
  5271. # The origin is a secure context.
  5272. Secure
  5273. # The host is localhost and hence is considered secure.
  5274. SecureLocalhost
  5275. # The origin has an insecure scheme and is not localhost.
  5276. InsecureScheme
  5277. # One of the ancestor frames is not a secure context.
  5278. InsecureAncestor
  5279. # Indicates whether the frame is cross-origin isolated and why it is the case.
  5280. experimental type CrossOriginIsolatedContextType extends string
  5281. enum
  5282. # The origin is cross-origin isolated.
  5283. Isolated
  5284. # The origin is not cross-origin isolated.
  5285. NotIsolated
  5286. # The cross-origin isolation feature is disabled.
  5287. NotIsolatedFeatureDisabled
  5288. # Information about the Frame on the page.
  5289. type Frame extends object
  5290. properties
  5291. # Frame unique identifier.
  5292. FrameId id
  5293. # Parent frame identifier.
  5294. optional string parentId
  5295. # Identifier of the loader associated with this frame.
  5296. Network.LoaderId loaderId
  5297. # Frame's name as specified in the tag.
  5298. optional string name
  5299. # Frame document's URL without fragment.
  5300. string url
  5301. # Frame document's URL fragment including the '#'.
  5302. experimental optional string urlFragment
  5303. # Frame document's registered domain, taking the public suffixes list into account.
  5304. # Extracted from the Frame's url.
  5305. # Example URLs: http://www.google.com/file.html -> "google.com"
  5306. # http://a.b.co.uk/file.html -> "b.co.uk"
  5307. experimental string domainAndRegistry
  5308. # Frame document's security origin.
  5309. string securityOrigin
  5310. # Frame document's mimeType as determined by the browser.
  5311. string mimeType
  5312. # 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.
  5313. experimental optional string unreachableUrl
  5314. # Indicates whether this frame was tagged as an ad.
  5315. experimental optional AdFrameType adFrameType
  5316. # Indicates whether the main document is a secure context and explains why that is the case.
  5317. experimental SecureContextType secureContextType
  5318. # Indicates whether this is a cross origin isolated context.
  5319. experimental CrossOriginIsolatedContextType crossOriginIsolatedContextType
  5320. # Information about the Resource on the page.
  5321. experimental type FrameResource extends object
  5322. properties
  5323. # Resource URL.
  5324. string url
  5325. # Type of this resource.
  5326. Network.ResourceType type
  5327. # Resource mimeType as determined by the browser.
  5328. string mimeType
  5329. # last-modified timestamp as reported by server.
  5330. optional Network.TimeSinceEpoch lastModified
  5331. # Resource content size.
  5332. optional number contentSize
  5333. # True if the resource failed to load.
  5334. optional boolean failed
  5335. # True if the resource was canceled during loading.
  5336. optional boolean canceled
  5337. # Information about the Frame hierarchy along with their cached resources.
  5338. experimental type FrameResourceTree extends object
  5339. properties
  5340. # Frame information for this tree item.
  5341. Frame frame
  5342. # Child frames.
  5343. optional array of FrameResourceTree childFrames
  5344. # Information about frame resources.
  5345. array of FrameResource resources
  5346. # Information about the Frame hierarchy.
  5347. type FrameTree extends object
  5348. properties
  5349. # Frame information for this tree item.
  5350. Frame frame
  5351. # Child frames.
  5352. optional array of FrameTree childFrames
  5353. # Unique script identifier.
  5354. type ScriptIdentifier extends string
  5355. # Transition type.
  5356. type TransitionType extends string
  5357. enum
  5358. link
  5359. typed
  5360. address_bar
  5361. auto_bookmark
  5362. auto_subframe
  5363. manual_subframe
  5364. generated
  5365. auto_toplevel
  5366. form_submit
  5367. reload
  5368. keyword
  5369. keyword_generated
  5370. other
  5371. # Navigation history entry.
  5372. type NavigationEntry extends object
  5373. properties
  5374. # Unique id of the navigation history entry.
  5375. integer id
  5376. # URL of the navigation history entry.
  5377. string url
  5378. # URL that the user typed in the url bar.
  5379. string userTypedURL
  5380. # Title of the navigation history entry.
  5381. string title
  5382. # Transition type.
  5383. TransitionType transitionType
  5384. # Screencast frame metadata.
  5385. experimental type ScreencastFrameMetadata extends object
  5386. properties
  5387. # Top offset in DIP.
  5388. number offsetTop
  5389. # Page scale factor.
  5390. number pageScaleFactor
  5391. # Device screen width in DIP.
  5392. number deviceWidth
  5393. # Device screen height in DIP.
  5394. number deviceHeight
  5395. # Position of horizontal scroll in CSS pixels.
  5396. number scrollOffsetX
  5397. # Position of vertical scroll in CSS pixels.
  5398. number scrollOffsetY
  5399. # Frame swap timestamp.
  5400. optional Network.TimeSinceEpoch timestamp
  5401. # Javascript dialog type.
  5402. type DialogType extends string
  5403. enum
  5404. alert
  5405. confirm
  5406. prompt
  5407. beforeunload
  5408. # Error while paring app manifest.
  5409. type AppManifestError extends object
  5410. properties
  5411. # Error message.
  5412. string message
  5413. # If criticial, this is a non-recoverable parse error.
  5414. integer critical
  5415. # Error line.
  5416. integer line
  5417. # Error column.
  5418. integer column
  5419. # Parsed app manifest properties.
  5420. experimental type AppManifestParsedProperties extends object
  5421. properties
  5422. # Computed scope value
  5423. string scope
  5424. # Layout viewport position and dimensions.
  5425. type LayoutViewport extends object
  5426. properties
  5427. # Horizontal offset relative to the document (CSS pixels).
  5428. integer pageX
  5429. # Vertical offset relative to the document (CSS pixels).
  5430. integer pageY
  5431. # Width (CSS pixels), excludes scrollbar if present.
  5432. integer clientWidth
  5433. # Height (CSS pixels), excludes scrollbar if present.
  5434. integer clientHeight
  5435. # Visual viewport position, dimensions, and scale.
  5436. type VisualViewport extends object
  5437. properties
  5438. # Horizontal offset relative to the layout viewport (CSS pixels).
  5439. number offsetX
  5440. # Vertical offset relative to the layout viewport (CSS pixels).
  5441. number offsetY
  5442. # Horizontal offset relative to the document (CSS pixels).
  5443. number pageX
  5444. # Vertical offset relative to the document (CSS pixels).
  5445. number pageY
  5446. # Width (CSS pixels), excludes scrollbar if present.
  5447. number clientWidth
  5448. # Height (CSS pixels), excludes scrollbar if present.
  5449. number clientHeight
  5450. # Scale relative to the ideal viewport (size at width=device-width).
  5451. number scale
  5452. # Page zoom factor (CSS to device independent pixels ratio).
  5453. optional number zoom
  5454. # Viewport for capturing screenshot.
  5455. type Viewport extends object
  5456. properties
  5457. # X offset in device independent pixels (dip).
  5458. number x
  5459. # Y offset in device independent pixels (dip).
  5460. number y
  5461. # Rectangle width in device independent pixels (dip).
  5462. number width
  5463. # Rectangle height in device independent pixels (dip).
  5464. number height
  5465. # Page scale factor.
  5466. number scale
  5467. # Generic font families collection.
  5468. experimental type FontFamilies extends object
  5469. properties
  5470. # The standard font-family.
  5471. optional string standard
  5472. # The fixed font-family.
  5473. optional string fixed
  5474. # The serif font-family.
  5475. optional string serif
  5476. # The sansSerif font-family.
  5477. optional string sansSerif
  5478. # The cursive font-family.
  5479. optional string cursive
  5480. # The fantasy font-family.
  5481. optional string fantasy
  5482. # The pictograph font-family.
  5483. optional string pictograph
  5484. # Default font sizes.
  5485. experimental type FontSizes extends object
  5486. properties
  5487. # Default standard font size.
  5488. optional integer standard
  5489. # Default fixed font size.
  5490. optional integer fixed
  5491. experimental type ClientNavigationReason extends string
  5492. enum
  5493. formSubmissionGet
  5494. formSubmissionPost
  5495. httpHeaderRefresh
  5496. scriptInitiated
  5497. metaTagRefresh
  5498. pageBlockInterstitial
  5499. reload
  5500. anchorClick
  5501. experimental type ClientNavigationDisposition extends string
  5502. enum
  5503. currentTab
  5504. newTab
  5505. newWindow
  5506. download
  5507. experimental type InstallabilityErrorArgument extends object
  5508. properties
  5509. # Argument name (e.g. name:'minimum-icon-size-in-pixels').
  5510. string name
  5511. # Argument value (e.g. value:'64').
  5512. string value
  5513. # The installability error
  5514. experimental type InstallabilityError extends object
  5515. properties
  5516. # The error id (e.g. 'manifest-missing-suitable-icon').
  5517. string errorId
  5518. # The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).
  5519. array of InstallabilityErrorArgument errorArguments
  5520. # The referring-policy used for the navigation.
  5521. experimental type ReferrerPolicy extends string
  5522. enum
  5523. noReferrer
  5524. noReferrerWhenDowngrade
  5525. origin
  5526. originWhenCrossOrigin
  5527. sameOrigin
  5528. strictOrigin
  5529. strictOriginWhenCrossOrigin
  5530. unsafeUrl
  5531. # Deprecated, please use addScriptToEvaluateOnNewDocument instead.
  5532. experimental deprecated command addScriptToEvaluateOnLoad
  5533. parameters
  5534. string scriptSource
  5535. returns
  5536. # Identifier of the added script.
  5537. ScriptIdentifier identifier
  5538. # Evaluates given script in every frame upon creation (before loading frame's scripts).
  5539. command addScriptToEvaluateOnNewDocument
  5540. parameters
  5541. string source
  5542. # If specified, creates an isolated world with the given name and evaluates given script in it.
  5543. # This world name will be used as the ExecutionContextDescription::name when the corresponding
  5544. # event is emitted.
  5545. experimental optional string worldName
  5546. returns
  5547. # Identifier of the added script.
  5548. ScriptIdentifier identifier
  5549. # Brings page to front (activates tab).
  5550. command bringToFront
  5551. # Capture page screenshot.
  5552. command captureScreenshot
  5553. parameters
  5554. # Image compression format (defaults to png).
  5555. optional enum format
  5556. jpeg
  5557. png
  5558. # Compression quality from range [0..100] (jpeg only).
  5559. optional integer quality
  5560. # Capture the screenshot of a given region only.
  5561. optional Viewport clip
  5562. # Capture the screenshot from the surface, rather than the view. Defaults to true.
  5563. experimental optional boolean fromSurface
  5564. returns
  5565. # Base64-encoded image data.
  5566. binary data
  5567. # Returns a snapshot of the page as a string. For MHTML format, the serialization includes
  5568. # iframes, shadow DOM, external resources, and element-inline styles.
  5569. experimental command captureSnapshot
  5570. parameters
  5571. # Format (defaults to mhtml).
  5572. optional enum format
  5573. mhtml
  5574. returns
  5575. # Serialized page data.
  5576. string data
  5577. # Clears the overriden device metrics.
  5578. experimental deprecated command clearDeviceMetricsOverride
  5579. # Use 'Emulation.clearDeviceMetricsOverride' instead
  5580. redirect Emulation
  5581. # Clears the overridden Device Orientation.
  5582. experimental deprecated command clearDeviceOrientationOverride
  5583. # Use 'DeviceOrientation.clearDeviceOrientationOverride' instead
  5584. redirect DeviceOrientation
  5585. # Clears the overriden Geolocation Position and Error.
  5586. deprecated command clearGeolocationOverride
  5587. # Use 'Emulation.clearGeolocationOverride' instead
  5588. redirect Emulation
  5589. # Creates an isolated world for the given frame.
  5590. command createIsolatedWorld
  5591. parameters
  5592. # Id of the frame in which the isolated world should be created.
  5593. FrameId frameId
  5594. # An optional name which is reported in the Execution Context.
  5595. optional string worldName
  5596. # Whether or not universal access should be granted to the isolated world. This is a powerful
  5597. # option, use with caution.
  5598. optional boolean grantUniveralAccess
  5599. returns
  5600. # Execution context of the isolated world.
  5601. Runtime.ExecutionContextId executionContextId
  5602. # Deletes browser cookie with given name, domain and path.
  5603. experimental deprecated command deleteCookie
  5604. # Use 'Network.deleteCookie' instead
  5605. redirect Network
  5606. parameters
  5607. # Name of the cookie to remove.
  5608. string cookieName
  5609. # URL to match cooke domain and path.
  5610. string url
  5611. # Disables page domain notifications.
  5612. command disable
  5613. # Enables page domain notifications.
  5614. command enable
  5615. command getAppManifest
  5616. returns
  5617. # Manifest location.
  5618. string url
  5619. array of AppManifestError errors
  5620. # Manifest content.
  5621. optional string data
  5622. # Parsed manifest properties
  5623. experimental optional AppManifestParsedProperties parsed
  5624. experimental command getInstallabilityErrors
  5625. returns
  5626. array of InstallabilityError installabilityErrors
  5627. experimental command getManifestIcons
  5628. returns
  5629. optional binary primaryIcon
  5630. # Returns all browser cookies. Depending on the backend support, will return detailed cookie
  5631. # information in the `cookies` field.
  5632. experimental deprecated command getCookies
  5633. # Use 'Network.getCookies' instead
  5634. redirect Network
  5635. returns
  5636. # Array of cookie objects.
  5637. array of Network.Cookie cookies
  5638. # Returns present frame tree structure.
  5639. command getFrameTree
  5640. returns
  5641. # Present frame tree structure.
  5642. FrameTree frameTree
  5643. # Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
  5644. command getLayoutMetrics
  5645. returns
  5646. # Metrics relating to the layout viewport.
  5647. LayoutViewport layoutViewport
  5648. # Metrics relating to the visual viewport.
  5649. VisualViewport visualViewport
  5650. # Size of scrollable area.
  5651. DOM.Rect contentSize
  5652. # Returns navigation history for the current page.
  5653. command getNavigationHistory
  5654. returns
  5655. # Index of the current navigation history entry.
  5656. integer currentIndex
  5657. # Array of navigation history entries.
  5658. array of NavigationEntry entries
  5659. # Resets navigation history for the current page.
  5660. command resetNavigationHistory
  5661. # Returns content of the given resource.
  5662. experimental command getResourceContent
  5663. parameters
  5664. # Frame id to get resource for.
  5665. FrameId frameId
  5666. # URL of the resource to get content for.
  5667. string url
  5668. returns
  5669. # Resource content.
  5670. string content
  5671. # True, if content was served as base64.
  5672. boolean base64Encoded
  5673. # Returns present frame / resource tree structure.
  5674. experimental command getResourceTree
  5675. returns
  5676. # Present frame / resource tree structure.
  5677. FrameResourceTree frameTree
  5678. # Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
  5679. command handleJavaScriptDialog
  5680. parameters
  5681. # Whether to accept or dismiss the dialog.
  5682. boolean accept
  5683. # The text to enter into the dialog prompt before accepting. Used only if this is a prompt
  5684. # dialog.
  5685. optional string promptText
  5686. # Navigates current page to the given URL.
  5687. command navigate
  5688. parameters
  5689. # URL to navigate the page to.
  5690. string url
  5691. # Referrer URL.
  5692. optional string referrer
  5693. # Intended transition type.
  5694. optional TransitionType transitionType
  5695. # Frame id to navigate, if not specified navigates the top frame.
  5696. optional FrameId frameId
  5697. # Referrer-policy used for the navigation.
  5698. experimental optional ReferrerPolicy referrerPolicy
  5699. returns
  5700. # Frame id that has navigated (or failed to navigate)
  5701. FrameId frameId
  5702. # Loader identifier.
  5703. optional Network.LoaderId loaderId
  5704. # User friendly error message, present if and only if navigation has failed.
  5705. optional string errorText
  5706. # Navigates current page to the given history entry.
  5707. command navigateToHistoryEntry
  5708. parameters
  5709. # Unique id of the entry to navigate to.
  5710. integer entryId
  5711. # Print page as PDF.
  5712. command printToPDF
  5713. parameters
  5714. # Paper orientation. Defaults to false.
  5715. optional boolean landscape
  5716. # Display header and footer. Defaults to false.
  5717. optional boolean displayHeaderFooter
  5718. # Print background graphics. Defaults to false.
  5719. optional boolean printBackground
  5720. # Scale of the webpage rendering. Defaults to 1.
  5721. optional number scale
  5722. # Paper width in inches. Defaults to 8.5 inches.
  5723. optional number paperWidth
  5724. # Paper height in inches. Defaults to 11 inches.
  5725. optional number paperHeight
  5726. # Top margin in inches. Defaults to 1cm (~0.4 inches).
  5727. optional number marginTop
  5728. # Bottom margin in inches. Defaults to 1cm (~0.4 inches).
  5729. optional number marginBottom
  5730. # Left margin in inches. Defaults to 1cm (~0.4 inches).
  5731. optional number marginLeft
  5732. # Right margin in inches. Defaults to 1cm (~0.4 inches).
  5733. optional number marginRight
  5734. # Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means
  5735. # print all pages.
  5736. optional string pageRanges
  5737. # Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'.
  5738. # Defaults to false.
  5739. optional boolean ignoreInvalidPageRanges
  5740. # HTML template for the print header. Should be valid HTML markup with following
  5741. # classes used to inject printing values into them:
  5742. # - `date`: formatted print date
  5743. # - `title`: document title
  5744. # - `url`: document location
  5745. # - `pageNumber`: current page number
  5746. # - `totalPages`: total pages in the document
  5747. #
  5748. # For example, `<span class=title></span>` would generate span containing the title.
  5749. optional string headerTemplate
  5750. # HTML template for the print footer. Should use the same format as the `headerTemplate`.
  5751. optional string footerTemplate
  5752. # Whether or not to prefer page size as defined by css. Defaults to false,
  5753. # in which case the content will be scaled to fit the paper size.
  5754. optional boolean preferCSSPageSize
  5755. # return as stream
  5756. experimental optional enum transferMode
  5757. ReturnAsBase64
  5758. ReturnAsStream
  5759. returns
  5760. # Base64-encoded pdf data. Empty if |returnAsStream| is specified.
  5761. binary data
  5762. # A handle of the stream that holds resulting PDF data.
  5763. experimental optional IO.StreamHandle stream
  5764. # Reloads given page optionally ignoring the cache.
  5765. command reload
  5766. parameters
  5767. # If true, browser cache is ignored (as if the user pressed Shift+refresh).
  5768. optional boolean ignoreCache
  5769. # If set, the script will be injected into all frames of the inspected page after reload.
  5770. # Argument will be ignored if reloading dataURL origin.
  5771. optional string scriptToEvaluateOnLoad
  5772. # Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
  5773. experimental deprecated command removeScriptToEvaluateOnLoad
  5774. parameters
  5775. ScriptIdentifier identifier
  5776. # Removes given script from the list.
  5777. command removeScriptToEvaluateOnNewDocument
  5778. parameters
  5779. ScriptIdentifier identifier
  5780. # Acknowledges that a screencast frame has been received by the frontend.
  5781. experimental command screencastFrameAck
  5782. parameters
  5783. # Frame number.
  5784. integer sessionId
  5785. # Searches for given string in resource content.
  5786. experimental command searchInResource
  5787. parameters
  5788. # Frame id for resource to search in.
  5789. FrameId frameId
  5790. # URL of the resource to search in.
  5791. string url
  5792. # String to search for.
  5793. string query
  5794. # If true, search is case sensitive.
  5795. optional boolean caseSensitive
  5796. # If true, treats string parameter as regex.
  5797. optional boolean isRegex
  5798. returns
  5799. # List of search matches.
  5800. array of Debugger.SearchMatch result
  5801. # Enable Chrome's experimental ad filter on all sites.
  5802. experimental command setAdBlockingEnabled
  5803. parameters
  5804. # Whether to block ads.
  5805. boolean enabled
  5806. # Enable page Content Security Policy by-passing.
  5807. experimental command setBypassCSP
  5808. parameters
  5809. # Whether to bypass page CSP.
  5810. boolean enabled
  5811. # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
  5812. # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
  5813. # query results).
  5814. experimental deprecated command setDeviceMetricsOverride
  5815. # Use 'Emulation.setDeviceMetricsOverride' instead
  5816. redirect Emulation
  5817. parameters
  5818. # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  5819. integer width
  5820. # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
  5821. integer height
  5822. # Overriding device scale factor value. 0 disables the override.
  5823. number deviceScaleFactor
  5824. # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
  5825. # autosizing and more.
  5826. boolean mobile
  5827. # Scale to apply to resulting view image.
  5828. optional number scale
  5829. # Overriding screen width value in pixels (minimum 0, maximum 10000000).
  5830. optional integer screenWidth
  5831. # Overriding screen height value in pixels (minimum 0, maximum 10000000).
  5832. optional integer screenHeight
  5833. # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
  5834. optional integer positionX
  5835. # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
  5836. optional integer positionY
  5837. # Do not set visible view size, rely upon explicit setVisibleSize call.
  5838. optional boolean dontSetVisibleSize
  5839. # Screen orientation override.
  5840. optional Emulation.ScreenOrientation screenOrientation
  5841. # The viewport dimensions and scale. If not set, the override is cleared.
  5842. optional Viewport viewport
  5843. # Overrides the Device Orientation.
  5844. experimental deprecated command setDeviceOrientationOverride
  5845. # Use 'DeviceOrientation.setDeviceOrientationOverride' instead
  5846. redirect DeviceOrientation
  5847. parameters
  5848. # Mock alpha
  5849. number alpha
  5850. # Mock beta
  5851. number beta
  5852. # Mock gamma
  5853. number gamma
  5854. # Set generic font families.
  5855. experimental command setFontFamilies
  5856. parameters
  5857. # Specifies font families to set. If a font family is not specified, it won't be changed.
  5858. FontFamilies fontFamilies
  5859. # Set default font sizes.
  5860. experimental command setFontSizes
  5861. parameters
  5862. # Specifies font sizes to set. If a font size is not specified, it won't be changed.
  5863. FontSizes fontSizes
  5864. # Sets given markup as the document's HTML.
  5865. command setDocumentContent
  5866. parameters
  5867. # Frame id to set HTML for.
  5868. FrameId frameId
  5869. # HTML content to set.
  5870. string html
  5871. # Set the behavior when downloading a file.
  5872. experimental deprecated command setDownloadBehavior
  5873. parameters
  5874. # Whether to allow all or deny all download requests, or use default Chrome behavior if
  5875. # available (otherwise deny).
  5876. enum behavior
  5877. deny
  5878. allow
  5879. default
  5880. # The default path to save downloaded files to. This is requred if behavior is set to 'allow'
  5881. optional string downloadPath
  5882. # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
  5883. # unavailable.
  5884. deprecated command setGeolocationOverride
  5885. # Use 'Emulation.setGeolocationOverride' instead
  5886. redirect Emulation
  5887. parameters
  5888. # Mock latitude
  5889. optional number latitude
  5890. # Mock longitude
  5891. optional number longitude
  5892. # Mock accuracy
  5893. optional number accuracy
  5894. # Controls whether page will emit lifecycle events.
  5895. experimental command setLifecycleEventsEnabled
  5896. parameters
  5897. # If true, starts emitting lifecycle events.
  5898. boolean enabled
  5899. # Toggles mouse event-based touch event emulation.
  5900. experimental deprecated command setTouchEmulationEnabled
  5901. # Use 'Emulation.setTouchEmulationEnabled' instead
  5902. redirect Emulation
  5903. parameters
  5904. # Whether the touch event emulation should be enabled.
  5905. boolean enabled
  5906. # Touch/gesture events configuration. Default: current platform.
  5907. optional enum configuration
  5908. mobile
  5909. desktop
  5910. # Starts sending each frame using the `screencastFrame` event.
  5911. experimental command startScreencast
  5912. parameters
  5913. # Image compression format.
  5914. optional enum format
  5915. jpeg
  5916. png
  5917. # Compression quality from range [0..100].
  5918. optional integer quality
  5919. # Maximum screenshot width.
  5920. optional integer maxWidth
  5921. # Maximum screenshot height.
  5922. optional integer maxHeight
  5923. # Send every n-th frame.
  5924. optional integer everyNthFrame
  5925. # Force the page stop all navigations and pending resource fetches.
  5926. command stopLoading
  5927. # Crashes renderer on the IO thread, generates minidumps.
  5928. experimental command crash
  5929. # Tries to close page, running its beforeunload hooks, if any.
  5930. experimental command close
  5931. # Tries to update the web lifecycle state of the page.
  5932. # It will transition the page to the given state according to:
  5933. # https://github.com/WICG/web-lifecycle/
  5934. experimental command setWebLifecycleState
  5935. parameters
  5936. # Target lifecycle state
  5937. enum state
  5938. frozen
  5939. active
  5940. # Stops sending each frame in the `screencastFrame`.
  5941. experimental command stopScreencast
  5942. # Forces compilation cache to be generated for every subresource script.
  5943. experimental command setProduceCompilationCache
  5944. parameters
  5945. boolean enabled
  5946. # Seeds compilation cache for given url. Compilation cache does not survive
  5947. # cross-process navigation.
  5948. experimental command addCompilationCache
  5949. parameters
  5950. string url
  5951. # Base64-encoded data
  5952. binary data
  5953. # Clears seeded compilation cache.
  5954. experimental command clearCompilationCache
  5955. # Generates a report for testing.
  5956. experimental command generateTestReport
  5957. parameters
  5958. # Message to be displayed in the report.
  5959. string message
  5960. # Specifies the endpoint group to deliver the report to.
  5961. optional string group
  5962. # Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
  5963. experimental command waitForDebugger
  5964. # Intercept file chooser requests and transfer control to protocol clients.
  5965. # When file chooser interception is enabled, native file chooser dialog is not shown.
  5966. # Instead, a protocol event `Page.fileChooserOpened` is emitted.
  5967. experimental command setInterceptFileChooserDialog
  5968. parameters
  5969. boolean enabled
  5970. event domContentEventFired
  5971. parameters
  5972. Network.MonotonicTime timestamp
  5973. # Emitted only when `page.interceptFileChooser` is enabled.
  5974. event fileChooserOpened
  5975. parameters
  5976. # Id of the frame containing input node.
  5977. experimental FrameId frameId
  5978. # Input node id.
  5979. experimental DOM.BackendNodeId backendNodeId
  5980. # Input mode.
  5981. enum mode
  5982. selectSingle
  5983. selectMultiple
  5984. # Fired when frame has been attached to its parent.
  5985. event frameAttached
  5986. parameters
  5987. # Id of the frame that has been attached.
  5988. FrameId frameId
  5989. # Parent frame identifier.
  5990. FrameId parentFrameId
  5991. # JavaScript stack trace of when frame was attached, only set if frame initiated from script.
  5992. optional Runtime.StackTrace stack
  5993. # Fired when frame no longer has a scheduled navigation.
  5994. deprecated event frameClearedScheduledNavigation
  5995. parameters
  5996. # Id of the frame that has cleared its scheduled navigation.
  5997. FrameId frameId
  5998. # Fired when frame has been detached from its parent.
  5999. event frameDetached
  6000. parameters
  6001. # Id of the frame that has been detached.
  6002. FrameId frameId
  6003. # Fired once navigation of the frame has completed. Frame is now associated with the new loader.
  6004. event frameNavigated
  6005. parameters
  6006. # Frame object.
  6007. Frame frame
  6008. experimental event frameResized
  6009. # Fired when a renderer-initiated navigation is requested.
  6010. # Navigation may still be cancelled after the event is issued.
  6011. experimental event frameRequestedNavigation
  6012. parameters
  6013. # Id of the frame that is being navigated.
  6014. FrameId frameId
  6015. # The reason for the navigation.
  6016. ClientNavigationReason reason
  6017. # The destination URL for the requested navigation.
  6018. string url
  6019. # The disposition for the navigation.
  6020. ClientNavigationDisposition disposition
  6021. # Fired when frame schedules a potential navigation.
  6022. deprecated event frameScheduledNavigation
  6023. parameters
  6024. # Id of the frame that has scheduled a navigation.
  6025. FrameId frameId
  6026. # Delay (in seconds) until the navigation is scheduled to begin. The navigation is not
  6027. # guaranteed to start.
  6028. number delay
  6029. # The reason for the navigation.
  6030. ClientNavigationReason reason
  6031. # The destination URL for the scheduled navigation.
  6032. string url
  6033. # Fired when frame has started loading.
  6034. experimental event frameStartedLoading
  6035. parameters
  6036. # Id of the frame that has started loading.
  6037. FrameId frameId
  6038. # Fired when frame has stopped loading.
  6039. experimental event frameStoppedLoading
  6040. parameters
  6041. # Id of the frame that has stopped loading.
  6042. FrameId frameId
  6043. # Fired when page is about to start a download.
  6044. experimental event downloadWillBegin
  6045. parameters
  6046. # Id of the frame that caused download to begin.
  6047. FrameId frameId
  6048. # Global unique identifier of the download.
  6049. string guid
  6050. # URL of the resource being downloaded.
  6051. string url
  6052. # Suggested file name of the resource (the actual name of the file saved on disk may differ).
  6053. string suggestedFilename
  6054. # Fired when download makes progress. Last call has |done| == true.
  6055. experimental event downloadProgress
  6056. parameters
  6057. # Global unique identifier of the download.
  6058. string guid
  6059. # Total expected bytes to download.
  6060. number totalBytes
  6061. # Total bytes received.
  6062. number receivedBytes
  6063. # Download status.
  6064. enum state
  6065. inProgress
  6066. completed
  6067. canceled
  6068. # Fired when interstitial page was hidden
  6069. event interstitialHidden
  6070. # Fired when interstitial page was shown
  6071. event interstitialShown
  6072. # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
  6073. # closed.
  6074. event javascriptDialogClosed
  6075. parameters
  6076. # Whether dialog was confirmed.
  6077. boolean result
  6078. # User input in case of prompt.
  6079. string userInput
  6080. # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
  6081. # open.
  6082. event javascriptDialogOpening
  6083. parameters
  6084. # Frame url.
  6085. string url
  6086. # Message that will be displayed by the dialog.
  6087. string message
  6088. # Dialog type.
  6089. DialogType type
  6090. # True iff browser is capable showing or acting on the given dialog. When browser has no
  6091. # dialog handler for given target, calling alert while Page domain is engaged will stall
  6092. # the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
  6093. boolean hasBrowserHandler
  6094. # Default dialog prompt.
  6095. optional string defaultPrompt
  6096. # Fired for top level page lifecycle events such as navigation, load, paint, etc.
  6097. event lifecycleEvent
  6098. parameters
  6099. # Id of the frame.
  6100. FrameId frameId
  6101. # Loader identifier. Empty string if the request is fetched from worker.
  6102. Network.LoaderId loaderId
  6103. string name
  6104. Network.MonotonicTime timestamp
  6105. event loadEventFired
  6106. parameters
  6107. Network.MonotonicTime timestamp
  6108. # Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
  6109. experimental event navigatedWithinDocument
  6110. parameters
  6111. # Id of the frame.
  6112. FrameId frameId
  6113. # Frame's new url.
  6114. string url
  6115. # Compressed image data requested by the `startScreencast`.
  6116. experimental event screencastFrame
  6117. parameters
  6118. # Base64-encoded compressed image.
  6119. binary data
  6120. # Screencast frame metadata.
  6121. ScreencastFrameMetadata metadata
  6122. # Frame number.
  6123. integer sessionId
  6124. # Fired when the page with currently enabled screencast was shown or hidden `.
  6125. experimental event screencastVisibilityChanged
  6126. parameters
  6127. # True if the page is visible.
  6128. boolean visible
  6129. # Fired when a new window is going to be opened, via window.open(), link click, form submission,
  6130. # etc.
  6131. event windowOpen
  6132. parameters
  6133. # The URL for the new window.
  6134. string url
  6135. # Window name.
  6136. string windowName
  6137. # An array of enabled window features.
  6138. array of string windowFeatures
  6139. # Whether or not it was triggered by user gesture.
  6140. boolean userGesture
  6141. # Issued for every compilation cache generated. Is only available
  6142. # if Page.setGenerateCompilationCache is enabled.
  6143. experimental event compilationCacheProduced
  6144. parameters
  6145. string url
  6146. # Base64-encoded data
  6147. binary data
  6148. domain Performance
  6149. # Run-time execution metric.
  6150. type Metric extends object
  6151. properties
  6152. # Metric name.
  6153. string name
  6154. # Metric value.
  6155. number value
  6156. # Disable collecting and reporting metrics.
  6157. command disable
  6158. # Enable collecting and reporting metrics.
  6159. command enable
  6160. parameters
  6161. # Time domain to use for collecting and reporting duration metrics.
  6162. optional enum timeDomain
  6163. # Use monotonically increasing abstract time (default).
  6164. timeTicks
  6165. # Use thread running time.
  6166. threadTicks
  6167. # Sets time domain to use for collecting and reporting duration metrics.
  6168. # Note that this must be called before enabling metrics collection. Calling
  6169. # this method while metrics collection is enabled returns an error.
  6170. experimental deprecated command setTimeDomain
  6171. parameters
  6172. # Time domain
  6173. enum timeDomain
  6174. # Use monotonically increasing abstract time (default).
  6175. timeTicks
  6176. # Use thread running time.
  6177. threadTicks
  6178. # Retrieve current values of run-time metrics.
  6179. command getMetrics
  6180. returns
  6181. # Current values for run-time metrics.
  6182. array of Metric metrics
  6183. # Current values of the metrics.
  6184. event metrics
  6185. parameters
  6186. # Current values of the metrics.
  6187. array of Metric metrics
  6188. # Timestamp title.
  6189. string title
  6190. # Security
  6191. domain Security
  6192. # An internal certificate ID value.
  6193. type CertificateId extends integer
  6194. # A description of mixed content (HTTP resources on HTTPS pages), as defined by
  6195. # https://www.w3.org/TR/mixed-content/#categories
  6196. type MixedContentType extends string
  6197. enum
  6198. blockable
  6199. optionally-blockable
  6200. none
  6201. # The security level of a page or resource.
  6202. type SecurityState extends string
  6203. enum
  6204. unknown
  6205. neutral
  6206. insecure
  6207. secure
  6208. info
  6209. insecure-broken
  6210. # Details about the security state of the page certificate.
  6211. experimental type CertificateSecurityState extends object
  6212. properties
  6213. # Protocol name (e.g. "TLS 1.2" or "QUIC").
  6214. string protocol
  6215. # Key Exchange used by the connection, or the empty string if not applicable.
  6216. string keyExchange
  6217. # (EC)DH group used by the connection, if applicable.
  6218. optional string keyExchangeGroup
  6219. # Cipher name.
  6220. string cipher
  6221. # TLS MAC. Note that AEAD ciphers do not have separate MACs.
  6222. optional string mac
  6223. # Page certificate.
  6224. array of string certificate
  6225. # Certificate subject name.
  6226. string subjectName
  6227. # Name of the issuing CA.
  6228. string issuer
  6229. # Certificate valid from date.
  6230. Network.TimeSinceEpoch validFrom
  6231. # Certificate valid to (expiration) date
  6232. Network.TimeSinceEpoch validTo
  6233. # The highest priority network error code, if the certificate has an error.
  6234. optional string certificateNetworkError
  6235. # True if the certificate uses a weak signature aglorithm.
  6236. boolean certificateHasWeakSignature
  6237. # True if the certificate has a SHA1 signature in the chain.
  6238. boolean certificateHasSha1Signature
  6239. # True if modern SSL
  6240. boolean modernSSL
  6241. # True if the connection is using an obsolete SSL protocol.
  6242. boolean obsoleteSslProtocol
  6243. # True if the connection is using an obsolete SSL key exchange.
  6244. boolean obsoleteSslKeyExchange
  6245. # True if the connection is using an obsolete SSL cipher.
  6246. boolean obsoleteSslCipher
  6247. # True if the connection is using an obsolete SSL signature.
  6248. boolean obsoleteSslSignature
  6249. experimental type SafetyTipStatus extends string
  6250. enum
  6251. badReputation
  6252. lookalike
  6253. experimental type SafetyTipInfo extends object
  6254. properties
  6255. # Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
  6256. SafetyTipStatus safetyTipStatus
  6257. # The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
  6258. optional string safeUrl
  6259. # Security state information about the page.
  6260. experimental type VisibleSecurityState extends object
  6261. properties
  6262. # The security level of the page.
  6263. SecurityState securityState
  6264. # Security state details about the page certificate.
  6265. optional CertificateSecurityState certificateSecurityState
  6266. # 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.
  6267. optional SafetyTipInfo safetyTipInfo
  6268. # Array of security state issues ids.
  6269. array of string securityStateIssueIds
  6270. # An explanation of an factor contributing to the security state.
  6271. type SecurityStateExplanation extends object
  6272. properties
  6273. # Security state representing the severity of the factor being explained.
  6274. SecurityState securityState
  6275. # Title describing the type of factor.
  6276. string title
  6277. # Short phrase describing the type of factor.
  6278. string summary
  6279. # Full text explanation of the factor.
  6280. string description
  6281. # The type of mixed content described by the explanation.
  6282. MixedContentType mixedContentType
  6283. # Page certificate.
  6284. array of string certificate
  6285. # Recommendations to fix any issues.
  6286. optional array of string recommendations
  6287. # Information about insecure content on the page.
  6288. deprecated type InsecureContentStatus extends object
  6289. properties
  6290. # Always false.
  6291. boolean ranMixedContent
  6292. # Always false.
  6293. boolean displayedMixedContent
  6294. # Always false.
  6295. boolean containedMixedForm
  6296. # Always false.
  6297. boolean ranContentWithCertErrors
  6298. # Always false.
  6299. boolean displayedContentWithCertErrors
  6300. # Always set to unknown.
  6301. SecurityState ranInsecureContentStyle
  6302. # Always set to unknown.
  6303. SecurityState displayedInsecureContentStyle
  6304. # The action to take when a certificate error occurs. continue will continue processing the
  6305. # request and cancel will cancel the request.
  6306. type CertificateErrorAction extends string
  6307. enum
  6308. continue
  6309. cancel
  6310. # Disables tracking security state changes.
  6311. command disable
  6312. # Enables tracking security state changes.
  6313. command enable
  6314. # Enable/disable whether all certificate errors should be ignored.
  6315. experimental command setIgnoreCertificateErrors
  6316. parameters
  6317. # If true, all certificate errors will be ignored.
  6318. boolean ignore
  6319. # Handles a certificate error that fired a certificateError event.
  6320. deprecated command handleCertificateError
  6321. parameters
  6322. # The ID of the event.
  6323. integer eventId
  6324. # The action to take on the certificate error.
  6325. CertificateErrorAction action
  6326. # Enable/disable overriding certificate errors. If enabled, all certificate error events need to
  6327. # be handled by the DevTools client and should be answered with `handleCertificateError` commands.
  6328. deprecated command setOverrideCertificateErrors
  6329. parameters
  6330. # If true, certificate errors will be overridden.
  6331. boolean override
  6332. # There is a certificate error. If overriding certificate errors is enabled, then it should be
  6333. # handled with the `handleCertificateError` command. Note: this event does not fire if the
  6334. # certificate error has been allowed internally. Only one client per target should override
  6335. # certificate errors at the same time.
  6336. deprecated event certificateError
  6337. parameters
  6338. # The ID of the event.
  6339. integer eventId
  6340. # The type of the error.
  6341. string errorType
  6342. # The url that was requested.
  6343. string requestURL
  6344. # The security state of the page changed.
  6345. experimental event visibleSecurityStateChanged
  6346. parameters
  6347. # Security state information about the page.
  6348. VisibleSecurityState visibleSecurityState
  6349. # The security state of the page changed.
  6350. event securityStateChanged
  6351. parameters
  6352. # Security state.
  6353. SecurityState securityState
  6354. # True if the page was loaded over cryptographic transport such as HTTPS.
  6355. deprecated boolean schemeIsCryptographic
  6356. # List of explanations for the security state. If the overall security state is `insecure` or
  6357. # `warning`, at least one corresponding explanation should be included.
  6358. array of SecurityStateExplanation explanations
  6359. # Information about insecure content on the page.
  6360. deprecated InsecureContentStatus insecureContentStatus
  6361. # Overrides user-visible description of the state.
  6362. optional string summary
  6363. experimental domain ServiceWorker
  6364. depends on Target
  6365. type RegistrationID extends string
  6366. # ServiceWorker registration.
  6367. type ServiceWorkerRegistration extends object
  6368. properties
  6369. RegistrationID registrationId
  6370. string scopeURL
  6371. boolean isDeleted
  6372. type ServiceWorkerVersionRunningStatus extends string
  6373. enum
  6374. stopped
  6375. starting
  6376. running
  6377. stopping
  6378. type ServiceWorkerVersionStatus extends string
  6379. enum
  6380. new
  6381. installing
  6382. installed
  6383. activating
  6384. activated
  6385. redundant
  6386. # ServiceWorker version.
  6387. type ServiceWorkerVersion extends object
  6388. properties
  6389. string versionId
  6390. RegistrationID registrationId
  6391. string scriptURL
  6392. ServiceWorkerVersionRunningStatus runningStatus
  6393. ServiceWorkerVersionStatus status
  6394. # The Last-Modified header value of the main script.
  6395. optional number scriptLastModified
  6396. # The time at which the response headers of the main script were received from the server.
  6397. # For cached script it is the last time the cache entry was validated.
  6398. optional number scriptResponseTime
  6399. optional array of Target.TargetID controlledClients
  6400. optional Target.TargetID targetId
  6401. # ServiceWorker error message.
  6402. type ServiceWorkerErrorMessage extends object
  6403. properties
  6404. string errorMessage
  6405. RegistrationID registrationId
  6406. string versionId
  6407. string sourceURL
  6408. integer lineNumber
  6409. integer columnNumber
  6410. command deliverPushMessage
  6411. parameters
  6412. string origin
  6413. RegistrationID registrationId
  6414. string data
  6415. command disable
  6416. command dispatchSyncEvent
  6417. parameters
  6418. string origin
  6419. RegistrationID registrationId
  6420. string tag
  6421. boolean lastChance
  6422. command dispatchPeriodicSyncEvent
  6423. parameters
  6424. string origin
  6425. RegistrationID registrationId
  6426. string tag
  6427. command enable
  6428. command inspectWorker
  6429. parameters
  6430. string versionId
  6431. command setForceUpdateOnPageLoad
  6432. parameters
  6433. boolean forceUpdateOnPageLoad
  6434. command skipWaiting
  6435. parameters
  6436. string scopeURL
  6437. command startWorker
  6438. parameters
  6439. string scopeURL
  6440. command stopAllWorkers
  6441. command stopWorker
  6442. parameters
  6443. string versionId
  6444. command unregister
  6445. parameters
  6446. string scopeURL
  6447. command updateRegistration
  6448. parameters
  6449. string scopeURL
  6450. event workerErrorReported
  6451. parameters
  6452. ServiceWorkerErrorMessage errorMessage
  6453. event workerRegistrationUpdated
  6454. parameters
  6455. array of ServiceWorkerRegistration registrations
  6456. event workerVersionUpdated
  6457. parameters
  6458. array of ServiceWorkerVersion versions
  6459. experimental domain Storage
  6460. depends on Browser
  6461. depends on Network
  6462. # Enum of possible storage types.
  6463. type StorageType extends string
  6464. enum
  6465. appcache
  6466. cookies
  6467. file_systems
  6468. indexeddb
  6469. local_storage
  6470. shader_cache
  6471. websql
  6472. service_workers
  6473. cache_storage
  6474. all
  6475. other
  6476. # Usage for a storage type.
  6477. type UsageForType extends object
  6478. properties
  6479. # Name of storage type.
  6480. StorageType storageType
  6481. # Storage usage (bytes).
  6482. number usage
  6483. # Clears storage for origin.
  6484. command clearDataForOrigin
  6485. parameters
  6486. # Security origin.
  6487. string origin
  6488. # Comma separated list of StorageType to clear.
  6489. string storageTypes
  6490. # Returns all browser cookies.
  6491. command getCookies
  6492. parameters
  6493. # Browser context to use when called on the browser endpoint.
  6494. optional Browser.BrowserContextID browserContextId
  6495. returns
  6496. # Array of cookie objects.
  6497. array of Network.Cookie cookies
  6498. # Sets given cookies.
  6499. command setCookies
  6500. parameters
  6501. # Cookies to be set.
  6502. array of Network.CookieParam cookies
  6503. # Browser context to use when called on the browser endpoint.
  6504. optional Browser.BrowserContextID browserContextId
  6505. # Clears cookies.
  6506. command clearCookies
  6507. parameters
  6508. # Browser context to use when called on the browser endpoint.
  6509. optional Browser.BrowserContextID browserContextId
  6510. # Returns usage and quota in bytes.
  6511. command getUsageAndQuota
  6512. parameters
  6513. # Security origin.
  6514. string origin
  6515. returns
  6516. # Storage usage (bytes).
  6517. number usage
  6518. # Storage quota (bytes).
  6519. number quota
  6520. # Whether or not the origin has an active storage quota override
  6521. boolean overrideActive
  6522. # Storage usage per type (bytes).
  6523. array of UsageForType usageBreakdown
  6524. # Override quota for the specified origin
  6525. experimental command overrideQuotaForOrigin
  6526. parameters
  6527. # Security origin.
  6528. string origin
  6529. # The quota size (in bytes) to override the original quota with.
  6530. # If this is called multiple times, the overriden quota will be equal to
  6531. # the quotaSize provided in the final call. If this is called without
  6532. # specifying a quotaSize, the quota will be reset to the default value for
  6533. # the specified origin. If this is called multiple times with different
  6534. # origins, the override will be maintained for each origin until it is
  6535. # disabled (called without a quotaSize).
  6536. optional number quotaSize
  6537. # Registers origin to be notified when an update occurs to its cache storage list.
  6538. command trackCacheStorageForOrigin
  6539. parameters
  6540. # Security origin.
  6541. string origin
  6542. # Registers origin to be notified when an update occurs to its IndexedDB.
  6543. command trackIndexedDBForOrigin
  6544. parameters
  6545. # Security origin.
  6546. string origin
  6547. # Unregisters origin from receiving notifications for cache storage.
  6548. command untrackCacheStorageForOrigin
  6549. parameters
  6550. # Security origin.
  6551. string origin
  6552. # Unregisters origin from receiving notifications for IndexedDB.
  6553. command untrackIndexedDBForOrigin
  6554. parameters
  6555. # Security origin.
  6556. string origin
  6557. # A cache's contents have been modified.
  6558. event cacheStorageContentUpdated
  6559. parameters
  6560. # Origin to update.
  6561. string origin
  6562. # Name of cache in origin.
  6563. string cacheName
  6564. # A cache has been added/deleted.
  6565. event cacheStorageListUpdated
  6566. parameters
  6567. # Origin to update.
  6568. string origin
  6569. # The origin's IndexedDB object store has been modified.
  6570. event indexedDBContentUpdated
  6571. parameters
  6572. # Origin to update.
  6573. string origin
  6574. # Database to update.
  6575. string databaseName
  6576. # ObjectStore to update.
  6577. string objectStoreName
  6578. # The origin's IndexedDB database list has been modified.
  6579. event indexedDBListUpdated
  6580. parameters
  6581. # Origin to update.
  6582. string origin
  6583. # The SystemInfo domain defines methods and events for querying low-level system information.
  6584. experimental domain SystemInfo
  6585. # Describes a single graphics processor (GPU).
  6586. type GPUDevice extends object
  6587. properties
  6588. # PCI ID of the GPU vendor, if available; 0 otherwise.
  6589. number vendorId
  6590. # PCI ID of the GPU device, if available; 0 otherwise.
  6591. number deviceId
  6592. # Sub sys ID of the GPU, only available on Windows.
  6593. optional number subSysId
  6594. # Revision of the GPU, only available on Windows.
  6595. optional number revision
  6596. # String description of the GPU vendor, if the PCI ID is not available.
  6597. string vendorString
  6598. # String description of the GPU device, if the PCI ID is not available.
  6599. string deviceString
  6600. # String description of the GPU driver vendor.
  6601. string driverVendor
  6602. # String description of the GPU driver version.
  6603. string driverVersion
  6604. # Describes the width and height dimensions of an entity.
  6605. type Size extends object
  6606. properties
  6607. # Width in pixels.
  6608. integer width
  6609. # Height in pixels.
  6610. integer height
  6611. # Describes a supported video decoding profile with its associated minimum and
  6612. # maximum resolutions.
  6613. type VideoDecodeAcceleratorCapability extends object
  6614. properties
  6615. # Video codec profile that is supported, e.g. VP9 Profile 2.
  6616. string profile
  6617. # Maximum video dimensions in pixels supported for this |profile|.
  6618. Size maxResolution
  6619. # Minimum video dimensions in pixels supported for this |profile|.
  6620. Size minResolution
  6621. # Describes a supported video encoding profile with its associated maximum
  6622. # resolution and maximum framerate.
  6623. type VideoEncodeAcceleratorCapability extends object
  6624. properties
  6625. # Video codec profile that is supported, e.g H264 Main.
  6626. string profile
  6627. # Maximum video dimensions in pixels supported for this |profile|.
  6628. Size maxResolution
  6629. # Maximum encoding framerate in frames per second supported for this
  6630. # |profile|, as fraction's numerator and denominator, e.g. 24/1 fps,
  6631. # 24000/1001 fps, etc.
  6632. integer maxFramerateNumerator
  6633. integer maxFramerateDenominator
  6634. # YUV subsampling type of the pixels of a given image.
  6635. type SubsamplingFormat extends string
  6636. enum
  6637. yuv420
  6638. yuv422
  6639. yuv444
  6640. # Image format of a given image.
  6641. type ImageType extends string
  6642. enum
  6643. jpeg
  6644. webp
  6645. unknown
  6646. # Describes a supported image decoding profile with its associated minimum and
  6647. # maximum resolutions and subsampling.
  6648. type ImageDecodeAcceleratorCapability extends object
  6649. properties
  6650. # Image coded, e.g. Jpeg.
  6651. ImageType imageType
  6652. # Maximum supported dimensions of the image in pixels.
  6653. Size maxDimensions
  6654. # Minimum supported dimensions of the image in pixels.
  6655. Size minDimensions
  6656. # Optional array of supported subsampling formats, e.g. 4:2:0, if known.
  6657. array of SubsamplingFormat subsamplings
  6658. # Provides information about the GPU(s) on the system.
  6659. type GPUInfo extends object
  6660. properties
  6661. # The graphics devices on the system. Element 0 is the primary GPU.
  6662. array of GPUDevice devices
  6663. # An optional dictionary of additional GPU related attributes.
  6664. optional object auxAttributes
  6665. # An optional dictionary of graphics features and their status.
  6666. optional object featureStatus
  6667. # An optional array of GPU driver bug workarounds.
  6668. array of string driverBugWorkarounds
  6669. # Supported accelerated video decoding capabilities.
  6670. array of VideoDecodeAcceleratorCapability videoDecoding
  6671. # Supported accelerated video encoding capabilities.
  6672. array of VideoEncodeAcceleratorCapability videoEncoding
  6673. # Supported accelerated image decoding capabilities.
  6674. array of ImageDecodeAcceleratorCapability imageDecoding
  6675. # Represents process info.
  6676. type ProcessInfo extends object
  6677. properties
  6678. # Specifies process type.
  6679. string type
  6680. # Specifies process id.
  6681. integer id
  6682. # Specifies cumulative CPU usage in seconds across all threads of the
  6683. # process since the process start.
  6684. number cpuTime
  6685. # Returns information about the system.
  6686. command getInfo
  6687. returns
  6688. # Information about the GPUs on the system.
  6689. GPUInfo gpu
  6690. # A platform-dependent description of the model of the machine. On Mac OS, this is, for
  6691. # example, 'MacBookPro'. Will be the empty string if not supported.
  6692. string modelName
  6693. # A platform-dependent description of the version of the machine. On Mac OS, this is, for
  6694. # example, '10.1'. Will be the empty string if not supported.
  6695. string modelVersion
  6696. # The command line string used to launch the browser. Will be the empty string if not
  6697. # supported.
  6698. string commandLine
  6699. # Returns information about all running processes.
  6700. command getProcessInfo
  6701. returns
  6702. # An array of process info blocks.
  6703. array of ProcessInfo processInfo
  6704. # Supports additional targets discovery and allows to attach to them.
  6705. domain Target
  6706. type TargetID extends string
  6707. # Unique identifier of attached debugging session.
  6708. type SessionID extends string
  6709. type TargetInfo extends object
  6710. properties
  6711. TargetID targetId
  6712. string type
  6713. string title
  6714. string url
  6715. # Whether the target has an attached client.
  6716. boolean attached
  6717. # Opener target Id
  6718. optional TargetID openerId
  6719. # Whether the target has access to the originating window.
  6720. experimental boolean canAccessOpener
  6721. # Frame id of originating window (is only set if target has an opener).
  6722. experimental optional Page.FrameId openerFrameId
  6723. experimental optional Browser.BrowserContextID browserContextId
  6724. experimental type RemoteLocation extends object
  6725. properties
  6726. string host
  6727. integer port
  6728. # Activates (focuses) the target.
  6729. command activateTarget
  6730. parameters
  6731. TargetID targetId
  6732. # Attaches to the target with given id.
  6733. command attachToTarget
  6734. parameters
  6735. TargetID targetId
  6736. # Enables "flat" access to the session via specifying sessionId attribute in the commands.
  6737. # We plan to make this the default, deprecate non-flattened mode,
  6738. # and eventually retire it. See crbug.com/991325.
  6739. optional boolean flatten
  6740. returns
  6741. # Id assigned to the session.
  6742. SessionID sessionId
  6743. # Attaches to the browser target, only uses flat sessionId mode.
  6744. experimental command attachToBrowserTarget
  6745. returns
  6746. # Id assigned to the session.
  6747. SessionID sessionId
  6748. # Closes the target. If the target is a page that gets closed too.
  6749. command closeTarget
  6750. parameters
  6751. TargetID targetId
  6752. returns
  6753. # Always set to true. If an error occurs, the response indicates protocol error.
  6754. deprecated boolean success
  6755. # Inject object to the target's main frame that provides a communication
  6756. # channel with browser target.
  6757. #
  6758. # Injected object will be available as `window[bindingName]`.
  6759. #
  6760. # The object has the follwing API:
  6761. # - `binding.send(json)` - a method to send messages over the remote debugging protocol
  6762. # - `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.
  6763. experimental command exposeDevToolsProtocol
  6764. parameters
  6765. TargetID targetId
  6766. # Binding name, 'cdp' if not specified.
  6767. optional string bindingName
  6768. # Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than
  6769. # one.
  6770. experimental command createBrowserContext
  6771. parameters
  6772. # If specified, disposes this context when debugging session disconnects.
  6773. optional boolean disposeOnDetach
  6774. # Proxy server, similar to the one passed to --proxy-server
  6775. optional string proxyServer
  6776. # Proxy bypass list, similar to the one passed to --proxy-bypass-list
  6777. optional string proxyBypassList
  6778. returns
  6779. # The id of the context created.
  6780. Browser.BrowserContextID browserContextId
  6781. # Returns all browser contexts created with `Target.createBrowserContext` method.
  6782. experimental command getBrowserContexts
  6783. returns
  6784. # An array of browser context ids.
  6785. array of Browser.BrowserContextID browserContextIds
  6786. # Creates a new page.
  6787. command createTarget
  6788. parameters
  6789. # The initial URL the page will be navigated to.
  6790. string url
  6791. # Frame width in DIP (headless chrome only).
  6792. optional integer width
  6793. # Frame height in DIP (headless chrome only).
  6794. optional integer height
  6795. # The browser context to create the page in.
  6796. optional Browser.BrowserContextID browserContextId
  6797. # Whether BeginFrames for this target will be controlled via DevTools (headless chrome only,
  6798. # not supported on MacOS yet, false by default).
  6799. experimental optional boolean enableBeginFrameControl
  6800. # Whether to create a new Window or Tab (chrome-only, false by default).
  6801. optional boolean newWindow
  6802. # Whether to create the target in background or foreground (chrome-only,
  6803. # false by default).
  6804. optional boolean background
  6805. returns
  6806. # The id of the page opened.
  6807. TargetID targetId
  6808. # Detaches session with given id.
  6809. command detachFromTarget
  6810. parameters
  6811. # Session to detach.
  6812. optional SessionID sessionId
  6813. # Deprecated.
  6814. deprecated optional TargetID targetId
  6815. # Deletes a BrowserContext. All the belonging pages will be closed without calling their
  6816. # beforeunload hooks.
  6817. experimental command disposeBrowserContext
  6818. parameters
  6819. Browser.BrowserContextID browserContextId
  6820. # Returns information about a target.
  6821. experimental command getTargetInfo
  6822. parameters
  6823. optional TargetID targetId
  6824. returns
  6825. TargetInfo targetInfo
  6826. # Retrieves a list of available targets.
  6827. command getTargets
  6828. returns
  6829. # The list of targets.
  6830. array of TargetInfo targetInfos
  6831. # Sends protocol message over session with given id.
  6832. # Consider using flat mode instead; see commands attachToTarget, setAutoAttach,
  6833. # and crbug.com/991325.
  6834. deprecated command sendMessageToTarget
  6835. parameters
  6836. string message
  6837. # Identifier of the session.
  6838. optional SessionID sessionId
  6839. # Deprecated.
  6840. deprecated optional TargetID targetId
  6841. # Controls whether to automatically attach to new targets which are considered to be related to
  6842. # this one. When turned on, attaches to all existing related targets as well. When turned off,
  6843. # automatically detaches from all currently attached targets.
  6844. experimental command setAutoAttach
  6845. parameters
  6846. # Whether to auto-attach to related targets.
  6847. boolean autoAttach
  6848. # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
  6849. # to run paused targets.
  6850. boolean waitForDebuggerOnStart
  6851. # Enables "flat" access to the session via specifying sessionId attribute in the commands.
  6852. # We plan to make this the default, deprecate non-flattened mode,
  6853. # and eventually retire it. See crbug.com/991325.
  6854. optional boolean flatten
  6855. # Controls whether to discover available targets and notify via
  6856. # `targetCreated/targetInfoChanged/targetDestroyed` events.
  6857. command setDiscoverTargets
  6858. parameters
  6859. # Whether to discover available targets.
  6860. boolean discover
  6861. # Enables target discovery for the specified locations, when `setDiscoverTargets` was set to
  6862. # `true`.
  6863. experimental command setRemoteLocations
  6864. parameters
  6865. # List of remote locations.
  6866. array of RemoteLocation locations
  6867. # Issued when attached to target because of auto-attach or `attachToTarget` command.
  6868. experimental event attachedToTarget
  6869. parameters
  6870. # Identifier assigned to the session used to send/receive messages.
  6871. SessionID sessionId
  6872. TargetInfo targetInfo
  6873. boolean waitingForDebugger
  6874. # Issued when detached from target for any reason (including `detachFromTarget` command). Can be
  6875. # issued multiple times per target if multiple sessions have been attached to it.
  6876. experimental event detachedFromTarget
  6877. parameters
  6878. # Detached session identifier.
  6879. SessionID sessionId
  6880. # Deprecated.
  6881. deprecated optional TargetID targetId
  6882. # Notifies about a new protocol message received from the session (as reported in
  6883. # `attachedToTarget` event).
  6884. event receivedMessageFromTarget
  6885. parameters
  6886. # Identifier of a session which sends a message.
  6887. SessionID sessionId
  6888. string message
  6889. # Deprecated.
  6890. deprecated optional TargetID targetId
  6891. # Issued when a possible inspection target is created.
  6892. event targetCreated
  6893. parameters
  6894. TargetInfo targetInfo
  6895. # Issued when a target is destroyed.
  6896. event targetDestroyed
  6897. parameters
  6898. TargetID targetId
  6899. # Issued when a target has crashed.
  6900. event targetCrashed
  6901. parameters
  6902. TargetID targetId
  6903. # Termination status type.
  6904. string status
  6905. # Termination error code.
  6906. integer errorCode
  6907. # Issued when some information about a target has changed. This only happens between
  6908. # `targetCreated` and `targetDestroyed`.
  6909. event targetInfoChanged
  6910. parameters
  6911. TargetInfo targetInfo
  6912. # The Tethering domain defines methods and events for browser port binding.
  6913. experimental domain Tethering
  6914. # Request browser port binding.
  6915. command bind
  6916. parameters
  6917. # Port number to bind.
  6918. integer port
  6919. # Request browser port unbinding.
  6920. command unbind
  6921. parameters
  6922. # Port number to unbind.
  6923. integer port
  6924. # Informs that port was successfully bound and got a specified connection id.
  6925. event accepted
  6926. parameters
  6927. # Port number that was successfully bound.
  6928. integer port
  6929. # Connection id to be used.
  6930. string connectionId
  6931. experimental domain Tracing
  6932. depends on IO
  6933. # Configuration for memory dump. Used only when "memory-infra" category is enabled.
  6934. type MemoryDumpConfig extends object
  6935. type TraceConfig extends object
  6936. properties
  6937. # Controls how the trace buffer stores data.
  6938. optional enum recordMode
  6939. recordUntilFull
  6940. recordContinuously
  6941. recordAsMuchAsPossible
  6942. echoToConsole
  6943. # Turns on JavaScript stack sampling.
  6944. optional boolean enableSampling
  6945. # Turns on system tracing.
  6946. optional boolean enableSystrace
  6947. # Turns on argument filter.
  6948. optional boolean enableArgumentFilter
  6949. # Included category filters.
  6950. optional array of string includedCategories
  6951. # Excluded category filters.
  6952. optional array of string excludedCategories
  6953. # Configuration to synthesize the delays in tracing.
  6954. optional array of string syntheticDelays
  6955. # Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.
  6956. optional MemoryDumpConfig memoryDumpConfig
  6957. # Data format of a trace. Can be either the legacy JSON format or the
  6958. # protocol buffer format. Note that the JSON format will be deprecated soon.
  6959. type StreamFormat extends string
  6960. enum
  6961. json
  6962. proto
  6963. # Compression type to use for traces returned via streams.
  6964. type StreamCompression extends string
  6965. enum
  6966. none
  6967. gzip
  6968. # Stop trace events collection.
  6969. command end
  6970. # Gets supported tracing categories.
  6971. command getCategories
  6972. returns
  6973. # A list of supported tracing categories.
  6974. array of string categories
  6975. # Record a clock sync marker in the trace.
  6976. command recordClockSyncMarker
  6977. parameters
  6978. # The ID of this clock sync marker
  6979. string syncId
  6980. # Request a global memory dump.
  6981. command requestMemoryDump
  6982. parameters
  6983. # Enables more deterministic results by forcing garbage collection
  6984. optional boolean deterministic
  6985. returns
  6986. # GUID of the resulting global memory dump.
  6987. string dumpGuid
  6988. # True iff the global memory dump succeeded.
  6989. boolean success
  6990. # Start trace events collection.
  6991. command start
  6992. parameters
  6993. # Category/tag filter
  6994. deprecated optional string categories
  6995. # Tracing options
  6996. deprecated optional string options
  6997. # If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
  6998. optional number bufferUsageReportingInterval
  6999. # Whether to report trace events as series of dataCollected events or to save trace to a
  7000. # stream (defaults to `ReportEvents`).
  7001. optional enum transferMode
  7002. ReportEvents
  7003. ReturnAsStream
  7004. # Trace data format to use. This only applies when using `ReturnAsStream`
  7005. # transfer mode (defaults to `json`).
  7006. optional StreamFormat streamFormat
  7007. # Compression format to use. This only applies when using `ReturnAsStream`
  7008. # transfer mode (defaults to `none`)
  7009. optional StreamCompression streamCompression
  7010. optional TraceConfig traceConfig
  7011. event bufferUsage
  7012. parameters
  7013. # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
  7014. # total size.
  7015. optional number percentFull
  7016. # An approximate number of events in the trace log.
  7017. optional number eventCount
  7018. # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
  7019. # total size.
  7020. optional number value
  7021. # Contains an bucket of collected trace events. When tracing is stopped collected events will be
  7022. # send as a sequence of dataCollected events followed by tracingComplete event.
  7023. event dataCollected
  7024. parameters
  7025. array of object value
  7026. # Signals that tracing is stopped and there is no trace buffers pending flush, all data were
  7027. # delivered via dataCollected events.
  7028. event tracingComplete
  7029. parameters
  7030. # Indicates whether some trace data is known to have been lost, e.g. because the trace ring
  7031. # buffer wrapped around.
  7032. boolean dataLossOccurred
  7033. # A handle of the stream that holds resulting trace data.
  7034. optional IO.StreamHandle stream
  7035. # Trace data format of returned stream.
  7036. optional StreamFormat traceFormat
  7037. # Compression format of returned stream.
  7038. optional StreamCompression streamCompression
  7039. # A domain for letting clients substitute browser's network layer with client code.
  7040. domain Fetch
  7041. depends on Network
  7042. depends on IO
  7043. depends on Page
  7044. # Unique request identifier.
  7045. type RequestId extends string
  7046. # Stages of the request to handle. Request will intercept before the request is
  7047. # sent. Response will intercept after the response is received (but before response
  7048. # body is received.
  7049. type RequestStage extends string
  7050. enum
  7051. Request
  7052. Response
  7053. type RequestPattern extends object
  7054. properties
  7055. # Wildcards ('*' -> zero or more, '?' -> exactly one) are allowed. Escape character is
  7056. # backslash. Omitting is equivalent to "*".
  7057. optional string urlPattern
  7058. # If set, only requests for matching resource types will be intercepted.
  7059. optional Network.ResourceType resourceType
  7060. # Stage at wich to begin intercepting requests. Default is Request.
  7061. optional RequestStage requestStage
  7062. # Response HTTP header entry
  7063. type HeaderEntry extends object
  7064. properties
  7065. string name
  7066. string value
  7067. # Authorization challenge for HTTP status code 401 or 407.
  7068. type AuthChallenge extends object
  7069. properties
  7070. # Source of the authentication challenge.
  7071. optional enum source
  7072. Server
  7073. Proxy
  7074. # Origin of the challenger.
  7075. string origin
  7076. # The authentication scheme used, such as basic or digest
  7077. string scheme
  7078. # The realm of the challenge. May be empty.
  7079. string realm
  7080. # Response to an AuthChallenge.
  7081. type AuthChallengeResponse extends object
  7082. properties
  7083. # The decision on what to do in response to the authorization challenge. Default means
  7084. # deferring to the default behavior of the net stack, which will likely either the Cancel
  7085. # authentication or display a popup dialog box.
  7086. enum response
  7087. Default
  7088. CancelAuth
  7089. ProvideCredentials
  7090. # The username to provide, possibly empty. Should only be set if response is
  7091. # ProvideCredentials.
  7092. optional string username
  7093. # The password to provide, possibly empty. Should only be set if response is
  7094. # ProvideCredentials.
  7095. optional string password
  7096. # Disables the fetch domain.
  7097. command disable
  7098. # Enables issuing of requestPaused events. A request will be paused until client
  7099. # calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
  7100. command enable
  7101. parameters
  7102. # If specified, only requests matching any of these patterns will produce
  7103. # fetchRequested event and will be paused until clients response. If not set,
  7104. # all requests will be affected.
  7105. optional array of RequestPattern patterns
  7106. # If true, authRequired events will be issued and requests will be paused
  7107. # expecting a call to continueWithAuth.
  7108. optional boolean handleAuthRequests
  7109. # Causes the request to fail with specified reason.
  7110. command failRequest
  7111. parameters
  7112. # An id the client received in requestPaused event.
  7113. RequestId requestId
  7114. # Causes the request to fail with the given reason.
  7115. Network.ErrorReason errorReason
  7116. # Provides response to the request.
  7117. command fulfillRequest
  7118. parameters
  7119. # An id the client received in requestPaused event.
  7120. RequestId requestId
  7121. # An HTTP response code.
  7122. integer responseCode
  7123. # Response headers.
  7124. optional array of HeaderEntry responseHeaders
  7125. # Alternative way of specifying response headers as a \0-separated
  7126. # series of name: value pairs. Prefer the above method unless you
  7127. # need to represent some non-UTF8 values that can't be transmitted
  7128. # over the protocol as text.
  7129. optional binary binaryResponseHeaders
  7130. # A response body.
  7131. optional binary body
  7132. # A textual representation of responseCode.
  7133. # If absent, a standard phrase matching responseCode is used.
  7134. optional string responsePhrase
  7135. # Continues the request, optionally modifying some of its parameters.
  7136. command continueRequest
  7137. parameters
  7138. # An id the client received in requestPaused event.
  7139. RequestId requestId
  7140. # If set, the request url will be modified in a way that's not observable by page.
  7141. optional string url
  7142. # If set, the request method is overridden.
  7143. optional string method
  7144. # If set, overrides the post data in the request.
  7145. optional binary postData
  7146. # If set, overrides the request headers.
  7147. optional array of HeaderEntry headers
  7148. # Continues a request supplying authChallengeResponse following authRequired event.
  7149. command continueWithAuth
  7150. parameters
  7151. # An id the client received in authRequired event.
  7152. RequestId requestId
  7153. # Response to with an authChallenge.
  7154. AuthChallengeResponse authChallengeResponse
  7155. # Causes the body of the response to be received from the server and
  7156. # returned as a single string. May only be issued for a request that
  7157. # is paused in the Response stage and is mutually exclusive with
  7158. # takeResponseBodyForInterceptionAsStream. Calling other methods that
  7159. # affect the request or disabling fetch domain before body is received
  7160. # results in an undefined behavior.
  7161. command getResponseBody
  7162. parameters
  7163. # Identifier for the intercepted request to get body for.
  7164. RequestId requestId
  7165. returns
  7166. # Response body.
  7167. string body
  7168. # True, if content was sent as base64.
  7169. boolean base64Encoded
  7170. # Returns a handle to the stream representing the response body.
  7171. # The request must be paused in the HeadersReceived stage.
  7172. # Note that after this command the request can't be continued
  7173. # as is -- client either needs to cancel it or to provide the
  7174. # response body.
  7175. # The stream only supports sequential read, IO.read will fail if the position
  7176. # is specified.
  7177. # This method is mutually exclusive with getResponseBody.
  7178. # Calling other methods that affect the request or disabling fetch
  7179. # domain before body is received results in an undefined behavior.
  7180. command takeResponseBodyAsStream
  7181. parameters
  7182. RequestId requestId
  7183. returns
  7184. IO.StreamHandle stream
  7185. # Issued when the domain is enabled and the request URL matches the
  7186. # specified filter. The request is paused until the client responds
  7187. # with one of continueRequest, failRequest or fulfillRequest.
  7188. # The stage of the request can be determined by presence of responseErrorReason
  7189. # and responseStatusCode -- the request is at the response stage if either
  7190. # of these fields is present and in the request stage otherwise.
  7191. event requestPaused
  7192. parameters
  7193. # Each request the page makes will have a unique id.
  7194. RequestId requestId
  7195. # The details of the request.
  7196. Network.Request request
  7197. # The id of the frame that initiated the request.
  7198. Page.FrameId frameId
  7199. # How the requested resource will be used.
  7200. Network.ResourceType resourceType
  7201. # Response error if intercepted at response stage.
  7202. optional Network.ErrorReason responseErrorReason
  7203. # Response code if intercepted at response stage.
  7204. optional integer responseStatusCode
  7205. # Response headers if intercepted at the response stage.
  7206. optional array of HeaderEntry responseHeaders
  7207. # If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
  7208. # then this networkId will be the same as the requestId present in the requestWillBeSent event.
  7209. optional RequestId networkId
  7210. # Issued when the domain is enabled with handleAuthRequests set to true.
  7211. # The request is paused until client responds with continueWithAuth.
  7212. event authRequired
  7213. parameters
  7214. # Each request the page makes will have a unique id.
  7215. RequestId requestId
  7216. # The details of the request.
  7217. Network.Request request
  7218. # The id of the frame that initiated the request.
  7219. Page.FrameId frameId
  7220. # How the requested resource will be used.
  7221. Network.ResourceType resourceType
  7222. # Details of the Authorization Challenge encountered.
  7223. # If this is set, client should respond with continueRequest that
  7224. # contains AuthChallengeResponse.
  7225. AuthChallenge authChallenge
  7226. # This domain allows inspection of Web Audio API.
  7227. # https://webaudio.github.io/web-audio-api/
  7228. experimental domain WebAudio
  7229. # An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
  7230. type GraphObjectId extends string
  7231. # Enum of BaseAudioContext types
  7232. type ContextType extends string
  7233. enum
  7234. realtime
  7235. offline
  7236. # Enum of AudioContextState from the spec
  7237. type ContextState extends string
  7238. enum
  7239. suspended
  7240. running
  7241. closed
  7242. # Enum of AudioNode types
  7243. type NodeType extends string
  7244. # Enum of AudioNode::ChannelCountMode from the spec
  7245. type ChannelCountMode extends string
  7246. enum
  7247. clamped-max
  7248. explicit
  7249. max
  7250. # Enum of AudioNode::ChannelInterpretation from the spec
  7251. type ChannelInterpretation extends string
  7252. enum
  7253. discrete
  7254. speakers
  7255. # Enum of AudioParam types
  7256. type ParamType extends string
  7257. # Enum of AudioParam::AutomationRate from the spec
  7258. type AutomationRate extends string
  7259. enum
  7260. a-rate
  7261. k-rate
  7262. # Fields in AudioContext that change in real-time.
  7263. type ContextRealtimeData extends object
  7264. properties
  7265. # The current context time in second in BaseAudioContext.
  7266. number currentTime
  7267. # The time spent on rendering graph divided by render qunatum duration,
  7268. # and multiplied by 100. 100 means the audio renderer reached the full
  7269. # capacity and glitch may occur.
  7270. number renderCapacity
  7271. # A running mean of callback interval.
  7272. number callbackIntervalMean
  7273. # A running variance of callback interval.
  7274. number callbackIntervalVariance
  7275. # Protocol object for BaseAudioContext
  7276. type BaseAudioContext extends object
  7277. properties
  7278. GraphObjectId contextId
  7279. ContextType contextType
  7280. ContextState contextState
  7281. optional ContextRealtimeData realtimeData
  7282. # Platform-dependent callback buffer size.
  7283. number callbackBufferSize
  7284. # Number of output channels supported by audio hardware in use.
  7285. number maxOutputChannelCount
  7286. # Context sample rate.
  7287. number sampleRate
  7288. # Protocol object for AudioListener
  7289. type AudioListener extends object
  7290. properties
  7291. GraphObjectId listenerId
  7292. GraphObjectId contextId
  7293. # Protocol object for AudioNode
  7294. type AudioNode extends object
  7295. properties
  7296. GraphObjectId nodeId
  7297. GraphObjectId contextId
  7298. NodeType nodeType
  7299. number numberOfInputs
  7300. number numberOfOutputs
  7301. number channelCount
  7302. ChannelCountMode channelCountMode
  7303. ChannelInterpretation channelInterpretation
  7304. # Protocol object for AudioParam
  7305. type AudioParam extends object
  7306. properties
  7307. GraphObjectId paramId
  7308. GraphObjectId nodeId
  7309. GraphObjectId contextId
  7310. ParamType paramType
  7311. AutomationRate rate
  7312. number defaultValue
  7313. number minValue
  7314. number maxValue
  7315. # Enables the WebAudio domain and starts sending context lifetime events.
  7316. command enable
  7317. # Disables the WebAudio domain.
  7318. command disable
  7319. # Fetch the realtime data from the registered contexts.
  7320. command getRealtimeData
  7321. parameters
  7322. GraphObjectId contextId
  7323. returns
  7324. ContextRealtimeData realtimeData
  7325. # Notifies that a new BaseAudioContext has been created.
  7326. event contextCreated
  7327. parameters
  7328. BaseAudioContext context
  7329. # Notifies that an existing BaseAudioContext will be destroyed.
  7330. event contextWillBeDestroyed
  7331. parameters
  7332. GraphObjectId contextId
  7333. # Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
  7334. event contextChanged
  7335. parameters
  7336. BaseAudioContext context
  7337. # Notifies that the construction of an AudioListener has finished.
  7338. event audioListenerCreated
  7339. parameters
  7340. AudioListener listener
  7341. # Notifies that a new AudioListener has been created.
  7342. event audioListenerWillBeDestroyed
  7343. parameters
  7344. GraphObjectId contextId
  7345. GraphObjectId listenerId
  7346. # Notifies that a new AudioNode has been created.
  7347. event audioNodeCreated
  7348. parameters
  7349. AudioNode node
  7350. # Notifies that an existing AudioNode has been destroyed.
  7351. event audioNodeWillBeDestroyed
  7352. parameters
  7353. GraphObjectId contextId
  7354. GraphObjectId nodeId
  7355. # Notifies that a new AudioParam has been created.
  7356. event audioParamCreated
  7357. parameters
  7358. AudioParam param
  7359. # Notifies that an existing AudioParam has been destroyed.
  7360. event audioParamWillBeDestroyed
  7361. parameters
  7362. GraphObjectId contextId
  7363. GraphObjectId nodeId
  7364. GraphObjectId paramId
  7365. # Notifies that two AudioNodes are connected.
  7366. event nodesConnected
  7367. parameters
  7368. GraphObjectId contextId
  7369. GraphObjectId sourceId
  7370. GraphObjectId destinationId
  7371. optional number sourceOutputIndex
  7372. optional number destinationInputIndex
  7373. # Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
  7374. event nodesDisconnected
  7375. parameters
  7376. GraphObjectId contextId
  7377. GraphObjectId sourceId
  7378. GraphObjectId destinationId
  7379. optional number sourceOutputIndex
  7380. optional number destinationInputIndex
  7381. # Notifies that an AudioNode is connected to an AudioParam.
  7382. event nodeParamConnected
  7383. parameters
  7384. GraphObjectId contextId
  7385. GraphObjectId sourceId
  7386. GraphObjectId destinationId
  7387. optional number sourceOutputIndex
  7388. # Notifies that an AudioNode is disconnected to an AudioParam.
  7389. event nodeParamDisconnected
  7390. parameters
  7391. GraphObjectId contextId
  7392. GraphObjectId sourceId
  7393. GraphObjectId destinationId
  7394. optional number sourceOutputIndex
  7395. # This domain allows configuring virtual authenticators to test the WebAuthn
  7396. # API.
  7397. experimental domain WebAuthn
  7398. type AuthenticatorId extends string
  7399. type AuthenticatorProtocol extends string
  7400. enum
  7401. # Universal 2nd Factor.
  7402. u2f
  7403. # Client To Authenticator Protocol 2.
  7404. ctap2
  7405. type AuthenticatorTransport extends string
  7406. enum
  7407. # Cross-Platform authenticator attachments:
  7408. usb
  7409. nfc
  7410. ble
  7411. cable
  7412. # Platform authenticator attachment:
  7413. internal
  7414. type VirtualAuthenticatorOptions extends object
  7415. properties
  7416. AuthenticatorProtocol protocol
  7417. AuthenticatorTransport transport
  7418. # Defaults to false.
  7419. optional boolean hasResidentKey
  7420. # Defaults to false.
  7421. optional boolean hasUserVerification
  7422. # If set to true, the authenticator will support the largeBlob extension.
  7423. # https://w3c.github.io/webauthn#largeBlob
  7424. # Defaults to false.
  7425. optional boolean hasLargeBlob
  7426. # If set to true, tests of user presence will succeed immediately.
  7427. # Otherwise, they will not be resolved. Defaults to true.
  7428. optional boolean automaticPresenceSimulation
  7429. # Sets whether User Verification succeeds or fails for an authenticator.
  7430. # Defaults to false.
  7431. optional boolean isUserVerified
  7432. type Credential extends object
  7433. properties
  7434. binary credentialId
  7435. boolean isResidentCredential
  7436. # Relying Party ID the credential is scoped to. Must be set when adding a
  7437. # credential.
  7438. optional string rpId
  7439. # The ECDSA P-256 private key in PKCS#8 format.
  7440. binary privateKey
  7441. # An opaque byte sequence with a maximum size of 64 bytes mapping the
  7442. # credential to a specific user.
  7443. optional binary userHandle
  7444. # Signature counter. This is incremented by one for each successful
  7445. # assertion.
  7446. # See https://w3c.github.io/webauthn/#signature-counter
  7447. integer signCount
  7448. # Enable the WebAuthn domain and start intercepting credential storage and
  7449. # retrieval with a virtual authenticator.
  7450. command enable
  7451. # Disable the WebAuthn domain.
  7452. command disable
  7453. # Creates and adds a virtual authenticator.
  7454. command addVirtualAuthenticator
  7455. parameters
  7456. VirtualAuthenticatorOptions options
  7457. returns
  7458. AuthenticatorId authenticatorId
  7459. # Removes the given authenticator.
  7460. command removeVirtualAuthenticator
  7461. parameters
  7462. AuthenticatorId authenticatorId
  7463. # Adds the credential to the specified authenticator.
  7464. command addCredential
  7465. parameters
  7466. AuthenticatorId authenticatorId
  7467. Credential credential
  7468. # Returns a single credential stored in the given virtual authenticator that
  7469. # matches the credential ID.
  7470. command getCredential
  7471. parameters
  7472. AuthenticatorId authenticatorId
  7473. binary credentialId
  7474. returns
  7475. Credential credential
  7476. # Returns all the credentials stored in the given virtual authenticator.
  7477. command getCredentials
  7478. parameters
  7479. AuthenticatorId authenticatorId
  7480. returns
  7481. array of Credential credentials
  7482. # Removes a credential from the authenticator.
  7483. command removeCredential
  7484. parameters
  7485. AuthenticatorId authenticatorId
  7486. binary credentialId
  7487. # Clears all the credentials from the specified device.
  7488. command clearCredentials
  7489. parameters
  7490. AuthenticatorId authenticatorId
  7491. # Sets whether User Verification succeeds or fails for an authenticator.
  7492. # The default is true.
  7493. command setUserVerified
  7494. parameters
  7495. AuthenticatorId authenticatorId
  7496. boolean isUserVerified
  7497. # Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
  7498. # The default is true.
  7499. command setAutomaticPresenceSimulation
  7500. parameters
  7501. AuthenticatorId authenticatorId
  7502. boolean enabled
  7503. # This domain allows detailed inspection of media elements
  7504. experimental domain Media
  7505. # Players will get an ID that is unique within the agent context.
  7506. type PlayerId extends string
  7507. type Timestamp extends number
  7508. # Have one type per entry in MediaLogRecord::Type
  7509. # Corresponds to kMessage
  7510. type PlayerMessage extends object
  7511. properties
  7512. # Keep in sync with MediaLogMessageLevel
  7513. # We are currently keeping the message level 'error' separate from the
  7514. # PlayerError type because right now they represent different things,
  7515. # this one being a DVLOG(ERROR) style log message that gets printed
  7516. # based on what log level is selected in the UI, and the other is a
  7517. # representation of a media::PipelineStatus object. Soon however we're
  7518. # going to be moving away from using PipelineStatus for errors and
  7519. # introducing a new error type which should hopefully let us integrate
  7520. # the error log level into the PlayerError type.
  7521. enum level
  7522. error
  7523. warning
  7524. info
  7525. debug
  7526. string message
  7527. # Corresponds to kMediaPropertyChange
  7528. type PlayerProperty extends object
  7529. properties
  7530. string name
  7531. string value
  7532. # Corresponds to kMediaEventTriggered
  7533. type PlayerEvent extends object
  7534. properties
  7535. Timestamp timestamp
  7536. string value
  7537. # Corresponds to kMediaError
  7538. type PlayerError extends object
  7539. properties
  7540. enum type
  7541. # Compatability until we switch to media_error
  7542. pipeline_error
  7543. media_error
  7544. # When this switches to using media::Status instead of PipelineStatus
  7545. # we can remove "errorCode" and replace it with the fields from
  7546. # a Status instance. This also seems like a duplicate of the error
  7547. # level enum - there is a todo bug to have that level removed and
  7548. # use this instead. (crbug.com/1068454)
  7549. string errorCode
  7550. # This can be called multiple times, and can be used to set / override /
  7551. # remove player properties. A null propValue indicates removal.
  7552. event playerPropertiesChanged
  7553. parameters
  7554. PlayerId playerId
  7555. array of PlayerProperty properties
  7556. # Send events as a list, allowing them to be batched on the browser for less
  7557. # congestion. If batched, events must ALWAYS be in chronological order.
  7558. event playerEventsAdded
  7559. parameters
  7560. PlayerId playerId
  7561. array of PlayerEvent events
  7562. # Send a list of any messages that need to be delivered.
  7563. event playerMessagesLogged
  7564. parameters
  7565. PlayerId playerId
  7566. array of PlayerMessage messages
  7567. # Send a list of any errors that need to be delivered.
  7568. event playerErrorsRaised
  7569. parameters
  7570. PlayerId playerId
  7571. array of PlayerError errors
  7572. # Called whenever a player is created, or when a new agent joins and recieves
  7573. # a list of active players. If an agent is restored, it will recieve the full
  7574. # list of player ids and all events again.
  7575. event playersCreated
  7576. parameters
  7577. array of PlayerId players
  7578. # Enables the Media domain
  7579. command enable
  7580. # Disables the Media domain.
  7581. command disable