12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194 |
- # Copyright 2017 The Chromium Authors
- # Use of this source code is governed by a BSD-style license that can be
- # found in the LICENSE file.
- #
- # Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
- version
- major 1
- minor 3
- experimental domain Accessibility
- depends on DOM
- # Unique accessibility node identifier.
- type AXNodeId extends string
- # Enum of possible property types.
- type AXValueType extends string
- enum
- boolean
- tristate
- booleanOrUndefined
- idref
- idrefList
- integer
- node
- nodeList
- number
- string
- computedString
- token
- tokenList
- domRelation
- role
- internalRole
- valueUndefined
- # Enum of possible property sources.
- type AXValueSourceType extends string
- enum
- attribute
- implicit
- style
- contents
- placeholder
- relatedElement
- # Enum of possible native property sources (as a subtype of a particular AXValueSourceType).
- type AXValueNativeSourceType extends string
- enum
- description
- figcaption
- label
- labelfor
- labelwrapped
- legend
- rubyannotation
- tablecaption
- title
- other
- # A single source for a computed AX property.
- type AXValueSource extends object
- properties
- # What type of source this is.
- AXValueSourceType type
- # The value of this property source.
- optional AXValue value
- # The name of the relevant attribute, if any.
- optional string attribute
- # The value of the relevant attribute, if any.
- optional AXValue attributeValue
- # Whether this source is superseded by a higher priority source.
- optional boolean superseded
- # The native markup source for this value, e.g. a <label> element.
- optional AXValueNativeSourceType nativeSource
- # The value, such as a node or node list, of the native source.
- optional AXValue nativeSourceValue
- # Whether the value for this property is invalid.
- optional boolean invalid
- # Reason for the value being invalid, if it is.
- optional string invalidReason
- type AXRelatedNode extends object
- properties
- # The BackendNodeId of the related DOM node.
- DOM.BackendNodeId backendDOMNodeId
- # The IDRef value provided, if any.
- optional string idref
- # The text alternative of this node in the current context.
- optional string text
- type AXProperty extends object
- properties
- # The name of this property.
- AXPropertyName name
- # The value of this property.
- AXValue value
- # A single computed AX property.
- type AXValue extends object
- properties
- # The type of this value.
- AXValueType type
- # The computed value of this property.
- optional any value
- # One or more related nodes, if applicable.
- optional array of AXRelatedNode relatedNodes
- # The sources which contributed to the computation of this property.
- optional array of AXValueSource sources
- # Values of AXProperty name:
- # - from 'busy' to 'roledescription': states which apply to every AX node
- # - from 'live' to 'root': attributes which apply to nodes in live regions
- # - from 'autocomplete' to 'valuetext': attributes which apply to widgets
- # - from 'checked' to 'selected': states which apply to widgets
- # - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
- type AXPropertyName extends string
- enum
- busy
- disabled
- editable
- focusable
- focused
- hidden
- hiddenRoot
- invalid
- keyshortcuts
- settable
- roledescription
- live
- atomic
- relevant
- root
- autocomplete
- hasPopup
- level
- multiselectable
- orientation
- multiline
- readonly
- required
- valuemin
- valuemax
- valuetext
- checked
- expanded
- modal
- pressed
- selected
- activedescendant
- controls
- describedby
- details
- errormessage
- flowto
- labelledby
- owns
- # A node in the accessibility tree.
- type AXNode extends object
- properties
- # Unique identifier for this node.
- AXNodeId nodeId
- # Whether this node is ignored for accessibility
- boolean ignored
- # Collection of reasons why this node is hidden.
- optional array of AXProperty ignoredReasons
- # This `Node`'s role, whether explicit or implicit.
- optional AXValue role
- # This `Node`'s Chrome raw role.
- optional AXValue chromeRole
- # The accessible name for this `Node`.
- optional AXValue name
- # The accessible description for this `Node`.
- optional AXValue description
- # The value for this `Node`.
- optional AXValue value
- # All other properties
- optional array of AXProperty properties
- # ID for this node's parent.
- optional AXNodeId parentId
- # IDs for each of this node's child nodes.
- optional array of AXNodeId childIds
- # The backend ID for the associated DOM node, if any.
- optional DOM.BackendNodeId backendDOMNodeId
- # The frame ID for the frame associated with this nodes document.
- optional Page.FrameId frameId
- # Disables the accessibility domain.
- command disable
- # Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
- # This turns on accessibility for the page, which can impact performance until accessibility is disabled.
- command enable
- # Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
- experimental command getPartialAXTree
- parameters
- # Identifier of the node to get the partial accessibility tree for.
- optional DOM.NodeId nodeId
- # Identifier of the backend node to get the partial accessibility tree for.
- optional DOM.BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper to get the partial accessibility tree for.
- optional Runtime.RemoteObjectId objectId
- # Whether to fetch this node's ancestors, siblings and children. Defaults to true.
- optional boolean fetchRelatives
- returns
- # The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and
- # children, if requested.
- array of AXNode nodes
- # Fetches the entire accessibility tree for the root Document
- experimental command getFullAXTree
- parameters
- # The maximum depth at which descendants of the root node should be retrieved.
- # If omitted, the full tree is returned.
- optional integer depth
- # The frame for whose document the AX tree should be retrieved.
- # If omited, the root frame is used.
- optional Page.FrameId frameId
- returns
- array of AXNode nodes
- # Fetches the root node.
- # Requires `enable()` to have been called previously.
- experimental command getRootAXNode
- parameters
- # The frame in whose document the node resides.
- # If omitted, the root frame is used.
- optional Page.FrameId frameId
- returns
- AXNode node
- # Fetches a node and all ancestors up to and including the root.
- # Requires `enable()` to have been called previously.
- experimental command getAXNodeAndAncestors
- parameters
- # Identifier of the node to get.
- optional DOM.NodeId nodeId
- # Identifier of the backend node to get.
- optional DOM.BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper to get.
- optional Runtime.RemoteObjectId objectId
- returns
- array of AXNode nodes
- # Fetches a particular accessibility node by AXNodeId.
- # Requires `enable()` to have been called previously.
- experimental command getChildAXNodes
- parameters
- AXNodeId id
- # The frame in whose document the node resides.
- # If omitted, the root frame is used.
- optional Page.FrameId frameId
- returns
- array of AXNode nodes
- # Query a DOM node's accessibility subtree for accessible name and role.
- # This command computes the name and role for all nodes in the subtree, including those that are
- # ignored for accessibility, and returns those that mactch the specified name and role. If no DOM
- # node is specified, or the DOM node does not exist, the command returns an error. If neither
- # `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree.
- experimental command queryAXTree
- parameters
- # Identifier of the node for the root to query.
- optional DOM.NodeId nodeId
- # Identifier of the backend node for the root to query.
- optional DOM.BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper for the root to query.
- optional Runtime.RemoteObjectId objectId
- # Find nodes with this computed name.
- optional string accessibleName
- # Find nodes with this computed role.
- optional string role
- returns
- # A list of `Accessibility.AXNode` matching the specified attributes,
- # including nodes that are ignored for accessibility.
- array of AXNode nodes
- # The loadComplete event mirrors the load complete event sent by the browser to assistive
- # technology when the web page has finished loading.
- experimental event loadComplete
- parameters
- # New document root node.
- AXNode root
- # The nodesUpdated event is sent every time a previously requested node has changed the in tree.
- experimental event nodesUpdated
- parameters
- # Updated node data.
- array of AXNode nodes
- experimental domain Animation
- depends on Runtime
- depends on DOM
- # Animation instance.
- type Animation extends object
- properties
- # `Animation`'s id.
- string id
- # `Animation`'s name.
- string name
- # `Animation`'s internal paused state.
- boolean pausedState
- # `Animation`'s play state.
- string playState
- # `Animation`'s playback rate.
- number playbackRate
- # `Animation`'s start time.
- number startTime
- # `Animation`'s current time.
- number currentTime
- # Animation type of `Animation`.
- enum type
- CSSTransition
- CSSAnimation
- WebAnimation
- # `Animation`'s source animation node.
- optional AnimationEffect source
- # A unique ID for `Animation` representing the sources that triggered this CSS
- # animation/transition.
- optional string cssId
- # AnimationEffect instance
- type AnimationEffect extends object
- properties
- # `AnimationEffect`'s delay.
- number delay
- # `AnimationEffect`'s end delay.
- number endDelay
- # `AnimationEffect`'s iteration start.
- number iterationStart
- # `AnimationEffect`'s iterations.
- number iterations
- # `AnimationEffect`'s iteration duration.
- number duration
- # `AnimationEffect`'s playback direction.
- string direction
- # `AnimationEffect`'s fill mode.
- string fill
- # `AnimationEffect`'s target node.
- optional DOM.BackendNodeId backendNodeId
- # `AnimationEffect`'s keyframes.
- optional KeyframesRule keyframesRule
- # `AnimationEffect`'s timing function.
- string easing
- # Keyframes Rule
- type KeyframesRule extends object
- properties
- # CSS keyframed animation's name.
- optional string name
- # List of animation keyframes.
- array of KeyframeStyle keyframes
- # Keyframe Style
- type KeyframeStyle extends object
- properties
- # Keyframe's time offset.
- string offset
- # `AnimationEffect`'s timing function.
- string easing
- # Disables animation domain notifications.
- command disable
- # Enables animation domain notifications.
- command enable
- # Returns the current time of the an animation.
- command getCurrentTime
- parameters
- # Id of animation.
- string id
- returns
- # Current time of the page.
- number currentTime
- # Gets the playback rate of the document timeline.
- command getPlaybackRate
- returns
- # Playback rate for animations on page.
- number playbackRate
- # Releases a set of animations to no longer be manipulated.
- command releaseAnimations
- parameters
- # List of animation ids to seek.
- array of string animations
- # Gets the remote object of the Animation.
- command resolveAnimation
- parameters
- # Animation id.
- string animationId
- returns
- # Corresponding remote object.
- Runtime.RemoteObject remoteObject
- # Seek a set of animations to a particular time within each animation.
- command seekAnimations
- parameters
- # List of animation ids to seek.
- array of string animations
- # Set the current time of each animation.
- number currentTime
- # Sets the paused state of a set of animations.
- command setPaused
- parameters
- # Animations to set the pause state of.
- array of string animations
- # Paused state to set to.
- boolean paused
- # Sets the playback rate of the document timeline.
- command setPlaybackRate
- parameters
- # Playback rate for animations on page
- number playbackRate
- # Sets the timing of an animation node.
- command setTiming
- parameters
- # Animation id.
- string animationId
- # Duration of the animation.
- number duration
- # Delay of the animation.
- number delay
- # Event for when an animation has been cancelled.
- event animationCanceled
- parameters
- # Id of the animation that was cancelled.
- string id
- # Event for each animation that has been created.
- event animationCreated
- parameters
- # Id of the animation that was created.
- string id
- # Event for animation that has been started.
- event animationStarted
- parameters
- # Animation that was started.
- Animation animation
- # Audits domain allows investigation of page violations and possible improvements.
- experimental domain Audits
- depends on Network
- # Information about a cookie that is affected by an inspector issue.
- type AffectedCookie extends object
- properties
- # The following three properties uniquely identify a cookie
- string name
- string path
- string domain
- # Information about a request that is affected by an inspector issue.
- type AffectedRequest extends object
- properties
- # The unique request id.
- Network.RequestId requestId
- optional string url
- # Information about the frame affected by an inspector issue.
- type AffectedFrame extends object
- properties
- Page.FrameId frameId
- type CookieExclusionReason extends string
- enum
- ExcludeSameSiteUnspecifiedTreatedAsLax
- ExcludeSameSiteNoneInsecure
- ExcludeSameSiteLax
- ExcludeSameSiteStrict
- ExcludeInvalidSameParty
- ExcludeSamePartyCrossPartyContext
- ExcludeDomainNonASCII
- ExcludeThirdPartyCookieBlockedInFirstPartySet
- type CookieWarningReason extends string
- enum
- WarnSameSiteUnspecifiedCrossSiteContext
- WarnSameSiteNoneInsecure
- WarnSameSiteUnspecifiedLaxAllowUnsafe
- WarnSameSiteStrictLaxDowngradeStrict
- WarnSameSiteStrictCrossDowngradeStrict
- WarnSameSiteStrictCrossDowngradeLax
- WarnSameSiteLaxCrossDowngradeStrict
- WarnSameSiteLaxCrossDowngradeLax
- WarnAttributeValueExceedsMaxSize
- WarnDomainNonASCII
- type CookieOperation extends string
- enum
- SetCookie
- ReadCookie
- # This information is currently necessary, as the front-end has a difficult
- # time finding a specific cookie. With this, we can convey specific error
- # information without the cookie.
- type CookieIssueDetails extends object
- properties
- # If AffectedCookie is not set then rawCookieLine contains the raw
- # Set-Cookie header string. This hints at a problem where the
- # cookie line is syntactically or semantically malformed in a way
- # that no valid cookie could be created.
- optional AffectedCookie cookie
- optional string rawCookieLine
- array of CookieWarningReason cookieWarningReasons
- array of CookieExclusionReason cookieExclusionReasons
- # Optionally identifies the site-for-cookies and the cookie url, which
- # may be used by the front-end as additional context.
- CookieOperation operation
- optional string siteForCookies
- optional string cookieUrl
- optional AffectedRequest request
- type MixedContentResolutionStatus extends string
- enum
- MixedContentBlocked
- MixedContentAutomaticallyUpgraded
- MixedContentWarning
- type MixedContentResourceType extends string
- enum
- AttributionSrc
- Audio
- Beacon
- CSPReport
- Download
- EventSource
- Favicon
- Font
- Form
- Frame
- Image
- Import
- Manifest
- Ping
- PluginData
- PluginResource
- Prefetch
- Resource
- Script
- ServiceWorker
- SharedWorker
- Stylesheet
- Track
- Video
- Worker
- XMLHttpRequest
- XSLT
- type MixedContentIssueDetails extends object
- properties
- # The type of resource causing the mixed content issue (css, js, iframe,
- # form,...). Marked as optional because it is mapped to from
- # blink::mojom::RequestContextType, which will be replaced
- # by network::mojom::RequestDestination
- optional MixedContentResourceType resourceType
- # The way the mixed content issue is being resolved.
- MixedContentResolutionStatus resolutionStatus
- # The unsafe http url causing the mixed content issue.
- string insecureURL
- # The url responsible for the call to an unsafe url.
- string mainResourceURL
- # The mixed content request.
- # Does not always exist (e.g. for unsafe form submission urls).
- optional AffectedRequest request
- # Optional because not every mixed content issue is necessarily linked to a frame.
- optional AffectedFrame frame
- # Enum indicating the reason a response has been blocked. These reasons are
- # refinements of the net error BLOCKED_BY_RESPONSE.
- type BlockedByResponseReason extends string
- enum
- CoepFrameResourceNeedsCoepHeader
- CoopSandboxedIFrameCannotNavigateToCoopPage
- CorpNotSameOrigin
- CorpNotSameOriginAfterDefaultedToSameOriginByCoep
- CorpNotSameSite
- # Details for a request that has been blocked with the BLOCKED_BY_RESPONSE
- # code. Currently only used for COEP/COOP, but may be extended to include
- # some CSP errors in the future.
- type BlockedByResponseIssueDetails extends object
- properties
- AffectedRequest request
- optional AffectedFrame parentFrame
- optional AffectedFrame blockedFrame
- BlockedByResponseReason reason
- type HeavyAdResolutionStatus extends string
- enum
- HeavyAdBlocked
- HeavyAdWarning
- type HeavyAdReason extends string
- enum
- NetworkTotalLimit
- CpuTotalLimit
- CpuPeakLimit
- type HeavyAdIssueDetails extends object
- properties
- # The resolution status, either blocking the content or warning.
- HeavyAdResolutionStatus resolution
- # The reason the ad was blocked, total network or cpu or peak cpu.
- HeavyAdReason reason
- # The frame that was blocked.
- AffectedFrame frame
- type ContentSecurityPolicyViolationType extends string
- enum
- kInlineViolation
- kEvalViolation
- kURLViolation
- kTrustedTypesSinkViolation
- kTrustedTypesPolicyViolation
- kWasmEvalViolation
- type SourceCodeLocation extends object
- properties
- optional Runtime.ScriptId scriptId
- string url
- integer lineNumber
- integer columnNumber
- type ContentSecurityPolicyIssueDetails extends object
- properties
- # The url not included in allowed sources.
- optional string blockedURL
- # Specific directive that is violated, causing the CSP issue.
- string violatedDirective
- boolean isReportOnly
- ContentSecurityPolicyViolationType contentSecurityPolicyViolationType
- optional AffectedFrame frameAncestor
- optional SourceCodeLocation sourceCodeLocation
- optional DOM.BackendNodeId violatingNodeId
- type SharedArrayBufferIssueType extends string
- enum
- TransferIssue
- CreationIssue
- # Details for a issue arising from an SAB being instantiated in, or
- # transferred to a context that is not cross-origin isolated.
- type SharedArrayBufferIssueDetails extends object
- properties
- SourceCodeLocation sourceCodeLocation
- boolean isWarning
- SharedArrayBufferIssueType type
- type LowTextContrastIssueDetails extends object
- properties
- DOM.BackendNodeId violatingNodeId
- string violatingNodeSelector
- number contrastRatio
- number thresholdAA
- number thresholdAAA
- string fontSize
- string fontWeight
- # Details for a CORS related issue, e.g. a warning or error related to
- # CORS RFC1918 enforcement.
- type CorsIssueDetails extends object
- properties
- Network.CorsErrorStatus corsErrorStatus
- boolean isWarning
- AffectedRequest request
- optional SourceCodeLocation location
- optional string initiatorOrigin
- optional Network.IPAddressSpace resourceIPAddressSpace
- optional Network.ClientSecurityState clientSecurityState
- type AttributionReportingIssueType extends string
- enum
- PermissionPolicyDisabled
- UntrustworthyReportingOrigin
- InsecureContext
- # TODO(apaseltiner): Rename this to InvalidRegisterSourceHeader
- InvalidHeader
- InvalidRegisterTriggerHeader
- SourceAndTriggerHeaders
- SourceIgnored
- TriggerIgnored
- OsSourceIgnored
- OsTriggerIgnored
- InvalidRegisterOsSourceHeader
- InvalidRegisterOsTriggerHeader
- WebAndOsHeaders
- NoWebOrOsSupport
- # Details for issues around "Attribution Reporting API" usage.
- # Explainer: https://github.com/WICG/attribution-reporting-api
- type AttributionReportingIssueDetails extends object
- properties
- AttributionReportingIssueType violationType
- optional AffectedRequest request
- optional DOM.BackendNodeId violatingNodeId
- optional string invalidParameter
- # Details for issues about documents in Quirks Mode
- # or Limited Quirks Mode that affects page layouting.
- type QuirksModeIssueDetails extends object
- properties
- # If false, it means the document's mode is "quirks"
- # instead of "limited-quirks".
- boolean isLimitedQuirksMode
- DOM.BackendNodeId documentNodeId
- string url
- Page.FrameId frameId
- Network.LoaderId loaderId
- type NavigatorUserAgentIssueDetails extends object
- properties
- string url
- optional SourceCodeLocation location
- type GenericIssueErrorType extends string
- enum
- CrossOriginPortalPostMessageError
- FormLabelForNameError
- FormDuplicateIdForInputError
- FormInputWithNoLabelError
- FormAutocompleteAttributeEmptyError
- FormEmptyIdAndNameAttributesForInputError
- FormAriaLabelledByToNonExistingId
- FormInputAssignedAutocompleteValueToIdOrNameAttributeError
- FormLabelHasNeitherForNorNestedInput
- FormLabelForMatchesNonExistingIdError
- FormInputHasWrongButWellIntendedAutocompleteValueError
- # Depending on the concrete errorType, different properties are set.
- type GenericIssueDetails extends object
- properties
- # Issues with the same errorType are aggregated in the frontend.
- GenericIssueErrorType errorType
- optional Page.FrameId frameId
- optional DOM.BackendNodeId violatingNodeId
- optional string violatingNodeAttribute
- # This issue tracks information needed to print a deprecation message.
- # https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/frame/third_party/blink/renderer/core/frame/deprecation/README.md
- type DeprecationIssueDetails extends object
- properties
- optional AffectedFrame affectedFrame
- SourceCodeLocation sourceCodeLocation
- # One of the deprecation names from third_party/blink/renderer/core/frame/deprecation/deprecation.json5
- string type
- # This issue warns about sites in the redirect chain of a finished navigation
- # that may be flagged as trackers and have their state cleared if they don't
- # receive a user interaction. Note that in this context 'site' means eTLD+1.
- # For example, if the URL `https://example.test:80/bounce` was in the
- # redirect chain, the site reported would be `example.test`.
- type BounceTrackingIssueDetails extends object
- properties
- array of string trackingSites
- type ClientHintIssueReason extends string
- enum
- # Items in the accept-ch meta tag allow list must be valid origins.
- # No special values (e.g. self, none, and *) are permitted.
- MetaTagAllowListInvalidOrigin
- # Only accept-ch meta tags in the original HTML sent from the server
- # are respected. Any injected via javascript (or other means) are ignored.
- MetaTagModifiedHTML
- type FederatedAuthRequestIssueDetails extends object
- properties
- FederatedAuthRequestIssueReason federatedAuthRequestIssueReason
- # Represents the failure reason when a federated authentication reason fails.
- # Should be updated alongside RequestIdTokenStatus in
- # third_party/blink/public/mojom/devtools/inspector_issue.mojom to include
- # all cases except for success.
- type FederatedAuthRequestIssueReason extends string
- enum
- ShouldEmbargo
- TooManyRequests
- WellKnownHttpNotFound
- WellKnownNoResponse
- WellKnownInvalidResponse
- WellKnownListEmpty
- WellKnownInvalidContentType
- ConfigNotInWellKnown
- WellKnownTooBig
- ConfigHttpNotFound
- ConfigNoResponse
- ConfigInvalidResponse
- ConfigInvalidContentType
- ClientMetadataHttpNotFound
- ClientMetadataNoResponse
- ClientMetadataInvalidResponse
- ClientMetadataInvalidContentType
- DisabledInSettings
- ErrorFetchingSignin
- InvalidSigninResponse
- AccountsHttpNotFound
- AccountsNoResponse
- AccountsInvalidResponse
- AccountsListEmpty
- AccountsInvalidContentType
- IdTokenHttpNotFound
- IdTokenNoResponse
- IdTokenInvalidResponse
- IdTokenInvalidRequest
- IdTokenInvalidContentType
- ErrorIdToken
- Canceled
- RpPageNotVisible
- SilentMediationFailure
- # This issue tracks client hints related issues. It's used to deprecate old
- # features, encourage the use of new ones, and provide general guidance.
- type ClientHintIssueDetails extends object
- properties
- SourceCodeLocation sourceCodeLocation
- ClientHintIssueReason clientHintIssueReason
- # A unique identifier for the type of issue. Each type may use one of the
- # optional fields in InspectorIssueDetails to convey more specific
- # information about the kind of issue.
- type InspectorIssueCode extends string
- enum
- CookieIssue
- MixedContentIssue
- BlockedByResponseIssue
- HeavyAdIssue
- ContentSecurityPolicyIssue
- SharedArrayBufferIssue
- LowTextContrastIssue
- CorsIssue
- AttributionReportingIssue
- QuirksModeIssue
- NavigatorUserAgentIssue
- GenericIssue
- DeprecationIssue
- ClientHintIssue
- FederatedAuthRequestIssue
- BounceTrackingIssue
- # This struct holds a list of optional fields with additional information
- # specific to the kind of issue. When adding a new issue code, please also
- # add a new optional field to this type.
- type InspectorIssueDetails extends object
- properties
- optional CookieIssueDetails cookieIssueDetails
- optional MixedContentIssueDetails mixedContentIssueDetails
- optional BlockedByResponseIssueDetails blockedByResponseIssueDetails
- optional HeavyAdIssueDetails heavyAdIssueDetails
- optional ContentSecurityPolicyIssueDetails contentSecurityPolicyIssueDetails
- optional SharedArrayBufferIssueDetails sharedArrayBufferIssueDetails
- optional LowTextContrastIssueDetails lowTextContrastIssueDetails
- optional CorsIssueDetails corsIssueDetails
- optional AttributionReportingIssueDetails attributionReportingIssueDetails
- optional QuirksModeIssueDetails quirksModeIssueDetails
- optional NavigatorUserAgentIssueDetails navigatorUserAgentIssueDetails
- optional GenericIssueDetails genericIssueDetails
- optional DeprecationIssueDetails deprecationIssueDetails
- optional ClientHintIssueDetails clientHintIssueDetails
- optional FederatedAuthRequestIssueDetails federatedAuthRequestIssueDetails
- optional BounceTrackingIssueDetails bounceTrackingIssueDetails
- # A unique id for a DevTools inspector issue. Allows other entities (e.g.
- # exceptions, CDP message, console messages, etc.) to reference an issue.
- type IssueId extends string
- # An inspector issue reported from the back-end.
- type InspectorIssue extends object
- properties
- InspectorIssueCode code
- InspectorIssueDetails details
- # A unique id for this issue. May be omitted if no other entity (e.g.
- # exception, CDP message, etc.) is referencing this issue.
- optional IssueId issueId
- # Returns the response body and size if it were re-encoded with the specified settings. Only
- # applies to images.
- command getEncodedResponse
- parameters
- # Identifier of the network request to get content for.
- Network.RequestId requestId
- # The encoding to use.
- enum encoding
- webp
- jpeg
- png
- # The quality of the encoding (0-1). (defaults to 1)
- optional number quality
- # Whether to only return the size information (defaults to false).
- optional boolean sizeOnly
- returns
- # The encoded body as a base64 string. Omitted if sizeOnly is true.
- optional binary body
- # Size before re-encoding.
- integer originalSize
- # Size after re-encoding.
- integer encodedSize
- # Disables issues domain, prevents further issues from being reported to the client.
- command disable
- # Enables issues domain, sends the issues collected so far to the client by means of the
- # `issueAdded` event.
- command enable
- # Runs the contrast check for the target page. Found issues are reported
- # using Audits.issueAdded event.
- command checkContrast
- parameters
- # Whether to report WCAG AAA level issues. Default is false.
- optional boolean reportAAA
- # Runs the form issues check for the target page. Found issues are reported
- # using Audits.issueAdded event.
- command checkFormsIssues
- returns
- array of GenericIssueDetails formIssues
- event issueAdded
- parameters
- InspectorIssue issue
- # Defines commands and events for Autofill.
- experimental domain Autofill
- type CreditCard extends object
- properties
- # 16-digit credit card number.
- string number
- # Name of the credit card owner.
- string name
- # 2-digit expiry month.
- string expiryMonth
- # 4-digit expiry year.
- string expiryYear
- # 3-digit card verification code.
- string cvc
- # Trigger autofill on a form identified by the fieldId.
- # If the field and related form cannot be autofilled, returns an error.
- command trigger
- parameters
- # Identifies a field that serves as an anchor for autofill.
- DOM.BackendNodeId fieldId
- # Identifies the frame that field belongs to.
- optional Page.FrameId frameId
- # Credit card information to fill out the form. Credit card data is not saved.
- CreditCard card
- # Defines events for background web platform features.
- experimental domain BackgroundService
- # The Background Service that will be associated with the commands/events.
- # Every Background Service operates independently, but they share the same
- # API.
- type ServiceName extends string
- enum
- backgroundFetch
- backgroundSync
- pushMessaging
- notifications
- paymentHandler
- periodicBackgroundSync
- # Enables event updates for the service.
- command startObserving
- parameters
- ServiceName service
- # Disables event updates for the service.
- command stopObserving
- parameters
- ServiceName service
- # Set the recording state for the service.
- command setRecording
- parameters
- boolean shouldRecord
- ServiceName service
- # Clears all stored data for the service.
- command clearEvents
- parameters
- ServiceName service
- # Called when the recording state for the service has been updated.
- event recordingStateChanged
- parameters
- boolean isRecording
- ServiceName service
- # A key-value pair for additional event information to pass along.
- type EventMetadata extends object
- properties
- string key
- string value
- type BackgroundServiceEvent extends object
- properties
- # Timestamp of the event (in seconds).
- Network.TimeSinceEpoch timestamp
- # The origin this event belongs to.
- string origin
- # The Service Worker ID that initiated the event.
- ServiceWorker.RegistrationID serviceWorkerRegistrationId
- # The Background Service this event belongs to.
- ServiceName service
- # A description of the event.
- string eventName
- # An identifier that groups related events together.
- string instanceId
- # A list of event-specific information.
- array of EventMetadata eventMetadata
- # Storage key this event belongs to.
- string storageKey
- # Called with all existing backgroundServiceEvents when enabled, and all new
- # events afterwards if enabled and recording.
- event backgroundServiceEventReceived
- parameters
- BackgroundServiceEvent backgroundServiceEvent
- # The Browser domain defines methods and events for browser managing.
- domain Browser
- experimental type BrowserContextID extends string
- experimental type WindowID extends integer
- # The state of the browser window.
- experimental type WindowState extends string
- enum
- normal
- minimized
- maximized
- fullscreen
- # Browser window bounds information
- experimental type Bounds extends object
- properties
- # The offset from the left edge of the screen to the window in pixels.
- optional integer left
- # The offset from the top edge of the screen to the window in pixels.
- optional integer top
- # The window width in pixels.
- optional integer width
- # The window height in pixels.
- optional integer height
- # The window state. Default to normal.
- optional WindowState windowState
- experimental type PermissionType extends string
- enum
- accessibilityEvents
- audioCapture
- backgroundSync
- backgroundFetch
- clipboardReadWrite
- clipboardSanitizedWrite
- displayCapture
- durableStorage
- flash
- geolocation
- idleDetection
- localFonts
- midi
- midiSysex
- nfc
- notifications
- paymentHandler
- periodicBackgroundSync
- protectedMediaIdentifier
- sensors
- storageAccess
- topLevelStorageAccess
- videoCapture
- videoCapturePanTiltZoom
- wakeLockScreen
- wakeLockSystem
- windowManagement
- experimental type PermissionSetting extends string
- enum
- granted
- denied
- prompt
- # Definition of PermissionDescriptor defined in the Permissions API:
- # https://w3c.github.io/permissions/#dictdef-permissiondescriptor.
- experimental type PermissionDescriptor extends object
- properties
- # Name of permission.
- # See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
- string name
- # For "midi" permission, may also specify sysex control.
- optional boolean sysex
- # For "push" permission, may specify userVisibleOnly.
- # Note that userVisibleOnly = true is the only currently supported type.
- optional boolean userVisibleOnly
- # For "clipboard" permission, may specify allowWithoutSanitization.
- optional boolean allowWithoutSanitization
- # For "camera" permission, may specify panTiltZoom.
- optional boolean panTiltZoom
- # Browser command ids used by executeBrowserCommand.
- experimental type BrowserCommandId extends string
- enum
- openTabSearch
- closeTabSearch
- # Set permission settings for given origin.
- experimental command setPermission
- parameters
- # Descriptor of permission to override.
- PermissionDescriptor permission
- # Setting of the permission.
- PermissionSetting setting
- # Origin the permission applies to, all origins if not specified.
- optional string origin
- # Context to override. When omitted, default browser context is used.
- optional BrowserContextID browserContextId
- # Grant specific permissions to the given origin and reject all others.
- experimental command grantPermissions
- parameters
- array of PermissionType permissions
- # Origin the permission applies to, all origins if not specified.
- optional string origin
- # BrowserContext to override permissions. When omitted, default browser context is used.
- optional BrowserContextID browserContextId
- # Reset all permission management for all origins.
- experimental command resetPermissions
- parameters
- # BrowserContext to reset permissions. When omitted, default browser context is used.
- optional BrowserContextID browserContextId
- # Set the behavior when downloading a file.
- experimental command setDownloadBehavior
- parameters
- # Whether to allow all or deny all download requests, or use default Chrome behavior if
- # available (otherwise deny). |allowAndName| allows download and names files according to
- # their dowmload guids.
- enum behavior
- deny
- allow
- allowAndName
- default
- # BrowserContext to set download behavior. When omitted, default browser context is used.
- optional BrowserContextID browserContextId
- # The default path to save downloaded files to. This is required if behavior is set to 'allow'
- # or 'allowAndName'.
- optional string downloadPath
- # Whether to emit download events (defaults to false).
- optional boolean eventsEnabled
- # Cancel a download if in progress
- experimental command cancelDownload
- parameters
- # Global unique identifier of the download.
- string guid
- # BrowserContext to perform the action in. When omitted, default browser context is used.
- optional BrowserContextID browserContextId
- # Fired when page is about to start a download.
- experimental event downloadWillBegin
- parameters
- # Id of the frame that caused the download to begin.
- Page.FrameId frameId
- # Global unique identifier of the download.
- string guid
- # URL of the resource being downloaded.
- string url
- # Suggested file name of the resource (the actual name of the file saved on disk may differ).
- string suggestedFilename
- # Fired when download makes progress. Last call has |done| == true.
- experimental event downloadProgress
- parameters
- # Global unique identifier of the download.
- string guid
- # Total expected bytes to download.
- number totalBytes
- # Total bytes received.
- number receivedBytes
- # Download status.
- enum state
- inProgress
- completed
- canceled
- # Close browser gracefully.
- command close
- # Crashes browser on the main thread.
- experimental command crash
- # Crashes GPU process.
- experimental command crashGpuProcess
- # Returns version information.
- command getVersion
- returns
- # Protocol version.
- string protocolVersion
- # Product name.
- string product
- # Product revision.
- string revision
- # User-Agent.
- string userAgent
- # V8 version.
- string jsVersion
- # Returns the command line switches for the browser process if, and only if
- # --enable-automation is on the commandline.
- experimental command getBrowserCommandLine
- returns
- # Commandline parameters
- array of string arguments
- # Chrome histogram bucket.
- experimental type Bucket extends object
- properties
- # Minimum value (inclusive).
- integer low
- # Maximum value (exclusive).
- integer high
- # Number of samples.
- integer count
- # Chrome histogram.
- experimental type Histogram extends object
- properties
- # Name.
- string name
- # Sum of sample values.
- integer sum
- # Total number of samples.
- integer count
- # Buckets.
- array of Bucket buckets
- # Get Chrome histograms.
- experimental command getHistograms
- parameters
- # Requested substring in name. Only histograms which have query as a
- # substring in their name are extracted. An empty or absent query returns
- # all histograms.
- optional string query
- # If true, retrieve delta since last delta call.
- optional boolean delta
- returns
- # Histograms.
- array of Histogram histograms
- # Get a Chrome histogram by name.
- experimental command getHistogram
- parameters
- # Requested histogram name.
- string name
- # If true, retrieve delta since last delta call.
- optional boolean delta
- returns
- # Histogram.
- Histogram histogram
- # Get position and size of the browser window.
- experimental command getWindowBounds
- parameters
- # Browser window id.
- WindowID windowId
- returns
- # Bounds information of the window. When window state is 'minimized', the restored window
- # position and size are returned.
- Bounds bounds
- # Get the browser window that contains the devtools target.
- experimental command getWindowForTarget
- parameters
- # Devtools agent host id. If called as a part of the session, associated targetId is used.
- optional Target.TargetID targetId
- returns
- # Browser window id.
- WindowID windowId
- # Bounds information of the window. When window state is 'minimized', the restored window
- # position and size are returned.
- Bounds bounds
- # Set position and/or size of the browser window.
- experimental command setWindowBounds
- parameters
- # Browser window id.
- WindowID windowId
- # New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
- # with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
- Bounds bounds
- # Set dock tile details, platform-specific.
- experimental command setDockTile
- parameters
- optional string badgeLabel
- # Png encoded image.
- optional binary image
- # Invoke custom browser commands used by telemetry.
- experimental command executeBrowserCommand
- parameters
- BrowserCommandId commandId
- # Allows a site to use privacy sandbox features that require enrollment
- # without the site actually being enrolled. Only supported on page targets.
- command addPrivacySandboxEnrollmentOverride
- parameters
- string url
- # This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
- # have an associated `id` used in subsequent operations on the related object. Each object type has
- # a specific `id` structure, and those are not interchangeable between objects of different kinds.
- # CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
- # can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
- # subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
- experimental domain CSS
- depends on DOM
- depends on Page
- type StyleSheetId extends string
- # Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
- # stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
- # inspector" rules), "regular" for regular stylesheets.
- type StyleSheetOrigin extends string
- enum
- injected
- user-agent
- inspector
- regular
- # CSS rule collection for a single pseudo style.
- type PseudoElementMatches extends object
- properties
- # Pseudo element type.
- DOM.PseudoType pseudoType
- # Pseudo element custom ident.
- optional string pseudoIdentifier
- # Matches of CSS rules applicable to the pseudo style.
- array of RuleMatch matches
- # Inherited CSS rule collection from ancestor node.
- type InheritedStyleEntry extends object
- properties
- # The ancestor node's inline style, if any, in the style inheritance chain.
- optional CSSStyle inlineStyle
- # Matches of CSS rules matching the ancestor node in the style inheritance chain.
- array of RuleMatch matchedCSSRules
- # Inherited pseudo element matches from pseudos of an ancestor node.
- type InheritedPseudoElementMatches extends object
- properties
- # Matches of pseudo styles from the pseudos of an ancestor node.
- array of PseudoElementMatches pseudoElements
- # Match data for a CSS rule.
- type RuleMatch extends object
- properties
- # CSS rule in the match.
- CSSRule rule
- # Matching selector indices in the rule's selectorList selectors (0-based).
- array of integer matchingSelectors
- # Data for a simple selector (these are delimited by commas in a selector list).
- type Value extends object
- properties
- # Value text.
- string text
- # Value range in the underlying resource (if available).
- optional SourceRange range
- # Specificity of the selector.
- experimental optional Specificity specificity
- # Specificity:
- # https://drafts.csswg.org/selectors/#specificity-rules
- experimental type Specificity extends object
- properties
- # The a component, which represents the number of ID selectors.
- integer a
- # The b component, which represents the number of class selectors, attributes selectors, and
- # pseudo-classes.
- integer b
- # The c component, which represents the number of type selectors and pseudo-elements.
- integer c
- # Selector list data.
- type SelectorList extends object
- properties
- # Selectors in the list.
- array of Value selectors
- # Rule selector text.
- string text
- # CSS stylesheet metainformation.
- type CSSStyleSheetHeader extends object
- properties
- # The stylesheet identifier.
- StyleSheetId styleSheetId
- # Owner frame identifier.
- Page.FrameId frameId
- # Stylesheet resource URL. Empty if this is a constructed stylesheet created using
- # new CSSStyleSheet() (but non-empty if this is a constructed sylesheet imported
- # as a CSS module script).
- string sourceURL
- # URL of source map associated with the stylesheet (if any).
- optional string sourceMapURL
- # Stylesheet origin.
- StyleSheetOrigin origin
- # Stylesheet title.
- string title
- # The backend id for the owner node of the stylesheet.
- optional DOM.BackendNodeId ownerNode
- # Denotes whether the stylesheet is disabled.
- boolean disabled
- # Whether the sourceURL field value comes from the sourceURL comment.
- optional boolean hasSourceURL
- # Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
- # document.written STYLE tags.
- boolean isInline
- # Whether this stylesheet is mutable. Inline stylesheets become mutable
- # after they have been modified via CSSOM API.
- # <link> element's stylesheets become mutable only if DevTools modifies them.
- # Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
- boolean isMutable
- # True if this stylesheet is created through new CSSStyleSheet() or imported as a
- # CSS module script.
- boolean isConstructed
- # Line offset of the stylesheet within the resource (zero based).
- number startLine
- # Column offset of the stylesheet within the resource (zero based).
- number startColumn
- # Size of the content (in characters).
- number length
- # Line offset of the end of the stylesheet within the resource (zero based).
- number endLine
- # Column offset of the end of the stylesheet within the resource (zero based).
- number endColumn
- # If the style sheet was loaded from a network resource, this indicates when the resource failed to load
- experimental optional boolean loadingFailed
- # CSS rule representation.
- type CSSRule extends object
- properties
- # The css style sheet identifier (absent for user agent stylesheet and user-specified
- # stylesheet rules) this rule came from.
- optional StyleSheetId styleSheetId
- # Rule selector data.
- SelectorList selectorList
- # Array of selectors from ancestor style rules, sorted by distance from the current rule.
- experimental optional array of string nestingSelectors
- # Parent stylesheet's origin.
- StyleSheetOrigin origin
- # Associated style declaration.
- CSSStyle style
- # Media list array (for rules involving media queries). The array enumerates media queries
- # starting with the innermost one, going outwards.
- optional array of CSSMedia media
- # Container query list array (for rules involving container queries).
- # The array enumerates container queries starting with the innermost one, going outwards.
- experimental optional array of CSSContainerQuery containerQueries
- # @supports CSS at-rule array.
- # The array enumerates @supports at-rules starting with the innermost one, going outwards.
- experimental optional array of CSSSupports supports
- # Cascade layer array. Contains the layer hierarchy that this rule belongs to starting
- # with the innermost layer and going outwards.
- experimental optional array of CSSLayer layers
- # @scope CSS at-rule array.
- # The array enumerates @scope at-rules starting with the innermost one, going outwards.
- experimental optional array of CSSScope scopes
- # CSS coverage information.
- type RuleUsage extends object
- properties
- # The css style sheet identifier (absent for user agent stylesheet and user-specified
- # stylesheet rules) this rule came from.
- StyleSheetId styleSheetId
- # Offset of the start of the rule (including selector) from the beginning of the stylesheet.
- number startOffset
- # Offset of the end of the rule body from the beginning of the stylesheet.
- number endOffset
- # Indicates whether the rule was actually used by some element in the page.
- boolean used
- # Text range within a resource. All numbers are zero-based.
- type SourceRange extends object
- properties
- # Start line of range.
- integer startLine
- # Start column of range (inclusive).
- integer startColumn
- # End line of range
- integer endLine
- # End column of range (exclusive).
- integer endColumn
- type ShorthandEntry extends object
- properties
- # Shorthand name.
- string name
- # Shorthand value.
- string value
- # Whether the property has "!important" annotation (implies `false` if absent).
- optional boolean important
- type CSSComputedStyleProperty extends object
- properties
- # Computed style property name.
- string name
- # Computed style property value.
- string value
- # CSS style representation.
- type CSSStyle extends object
- properties
- # The css style sheet identifier (absent for user agent stylesheet and user-specified
- # stylesheet rules) this rule came from.
- optional StyleSheetId styleSheetId
- # CSS properties in the style.
- array of CSSProperty cssProperties
- # Computed values for all shorthands found in the style.
- array of ShorthandEntry shorthandEntries
- # Style declaration text (if available).
- optional string cssText
- # Style declaration range in the enclosing stylesheet (if available).
- optional SourceRange range
- # CSS property declaration data.
- type CSSProperty extends object
- properties
- # The property name.
- string name
- # The property value.
- string value
- # Whether the property has "!important" annotation (implies `false` if absent).
- optional boolean important
- # Whether the property is implicit (implies `false` if absent).
- optional boolean implicit
- # The full property text as specified in the style.
- optional string text
- # Whether the property is understood by the browser (implies `true` if absent).
- optional boolean parsedOk
- # Whether the property is disabled by the user (present for source-based properties only).
- optional boolean disabled
- # The entire property range in the enclosing style declaration (if available).
- optional SourceRange range
- # Parsed longhand components of this property if it is a shorthand.
- # This field will be empty if the given property is not a shorthand.
- experimental optional array of CSSProperty longhandProperties
- # CSS media rule descriptor.
- type CSSMedia extends object
- properties
- # Media query text.
- string text
- # Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
- # specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
- # stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
- # stylesheet's STYLE tag.
- enum source
- mediaRule
- importRule
- linkedSheet
- inlineSheet
- # URL of the document containing the media query description.
- optional string sourceURL
- # The associated rule (@media or @import) header range in the enclosing stylesheet (if
- # available).
- optional SourceRange range
- # Identifier of the stylesheet containing this object (if exists).
- optional StyleSheetId styleSheetId
- # Array of media queries.
- optional array of MediaQuery mediaList
- # Media query descriptor.
- type MediaQuery extends object
- properties
- # Array of media query expressions.
- array of MediaQueryExpression expressions
- # Whether the media query condition is satisfied.
- boolean active
- # Media query expression descriptor.
- type MediaQueryExpression extends object
- properties
- # Media query expression value.
- number value
- # Media query expression units.
- string unit
- # Media query expression feature.
- string feature
- # The associated range of the value text in the enclosing stylesheet (if available).
- optional SourceRange valueRange
- # Computed length of media query expression (if applicable).
- optional number computedLength
- # CSS container query rule descriptor.
- experimental type CSSContainerQuery extends object
- properties
- # Container query text.
- string text
- # The associated rule header range in the enclosing stylesheet (if
- # available).
- optional SourceRange range
- # Identifier of the stylesheet containing this object (if exists).
- optional StyleSheetId styleSheetId
- # Optional name for the container.
- optional string name
- # Optional physical axes queried for the container.
- optional DOM.PhysicalAxes physicalAxes
- # Optional logical axes queried for the container.
- optional DOM.LogicalAxes logicalAxes
- # CSS Supports at-rule descriptor.
- experimental type CSSSupports extends object
- properties
- # Supports rule text.
- string text
- # Whether the supports condition is satisfied.
- boolean active
- # The associated rule header range in the enclosing stylesheet (if
- # available).
- optional SourceRange range
- # Identifier of the stylesheet containing this object (if exists).
- optional StyleSheetId styleSheetId
- # CSS Scope at-rule descriptor.
- experimental type CSSScope extends object
- properties
- # Scope rule text.
- string text
- # The associated rule header range in the enclosing stylesheet (if
- # available).
- optional SourceRange range
- # Identifier of the stylesheet containing this object (if exists).
- optional StyleSheetId styleSheetId
- # CSS Layer at-rule descriptor.
- experimental type CSSLayer extends object
- properties
- # Layer name.
- string text
- # The associated rule header range in the enclosing stylesheet (if
- # available).
- optional SourceRange range
- # Identifier of the stylesheet containing this object (if exists).
- optional StyleSheetId styleSheetId
- # CSS Layer data.
- experimental type CSSLayerData extends object
- properties
- # Layer name.
- string name
- # Direct sub-layers
- optional array of CSSLayerData subLayers
- # Layer order. The order determines the order of the layer in the cascade order.
- # A higher number has higher priority in the cascade order.
- number order
- # Information about amount of glyphs that were rendered with given font.
- type PlatformFontUsage extends object
- properties
- # Font's family name reported by platform.
- string familyName
- # Indicates if the font was downloaded or resolved locally.
- boolean isCustomFont
- # Amount of glyphs that were rendered with this font.
- number glyphCount
- # Information about font variation axes for variable fonts
- type FontVariationAxis extends object
- properties
- # The font-variation-setting tag (a.k.a. "axis tag").
- string tag
- # Human-readable variation name in the default language (normally, "en").
- string name
- # The minimum value (inclusive) the font supports for this tag.
- number minValue
- # The maximum value (inclusive) the font supports for this tag.
- number maxValue
- # The default value.
- number defaultValue
- # Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
- # and additional information such as platformFontFamily and fontVariationAxes.
- type FontFace extends object
- properties
- # The font-family.
- string fontFamily
- # The font-style.
- string fontStyle
- # The font-variant.
- string fontVariant
- # The font-weight.
- string fontWeight
- # The font-stretch.
- string fontStretch
- # The font-display.
- string fontDisplay
- # The unicode-range.
- string unicodeRange
- # The src.
- string src
- # The resolved platform font family
- string platformFontFamily
- # Available variation settings (a.k.a. "axes").
- optional array of FontVariationAxis fontVariationAxes
- # CSS try rule representation.
- type CSSTryRule extends object
- properties
- # The css style sheet identifier (absent for user agent stylesheet and user-specified
- # stylesheet rules) this rule came from.
- optional StyleSheetId styleSheetId
- # Parent stylesheet's origin.
- StyleSheetOrigin origin
- # Associated style declaration.
- CSSStyle style
- # CSS position-fallback rule representation.
- type CSSPositionFallbackRule extends object
- properties
- Value name
- # List of keyframes.
- array of CSSTryRule tryRules
- # CSS keyframes rule representation.
- type CSSKeyframesRule extends object
- properties
- # Animation name.
- Value animationName
- # List of keyframes.
- array of CSSKeyframeRule keyframes
- # CSS keyframe rule representation.
- type CSSKeyframeRule extends object
- properties
- # The css style sheet identifier (absent for user agent stylesheet and user-specified
- # stylesheet rules) this rule came from.
- optional StyleSheetId styleSheetId
- # Parent stylesheet's origin.
- StyleSheetOrigin origin
- # Associated key text.
- Value keyText
- # Associated style declaration.
- CSSStyle style
- # A descriptor of operation to mutate style declaration text.
- type StyleDeclarationEdit extends object
- properties
- # The css style sheet identifier.
- StyleSheetId styleSheetId
- # The range of the style text in the enclosing stylesheet.
- SourceRange range
- # New style text.
- string text
- # Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
- # position specified by `location`.
- command addRule
- parameters
- # The css style sheet identifier where a new rule should be inserted.
- StyleSheetId styleSheetId
- # The text of a new rule.
- string ruleText
- # Text position of a new rule in the target style sheet.
- SourceRange location
- returns
- # The newly created rule.
- CSSRule rule
- # Returns all class names from specified stylesheet.
- command collectClassNames
- parameters
- StyleSheetId styleSheetId
- returns
- # Class name list.
- array of string classNames
- # Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
- command createStyleSheet
- parameters
- # Identifier of the frame where "via-inspector" stylesheet should be created.
- Page.FrameId frameId
- returns
- # Identifier of the created "via-inspector" stylesheet.
- StyleSheetId styleSheetId
- # Disables the CSS agent for the given page.
- command disable
- # Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
- # enabled until the result of this command is received.
- command enable
- # Ensures that the given node will have specified pseudo-classes whenever its style is computed by
- # the browser.
- command forcePseudoState
- parameters
- # The element id for which to force the pseudo state.
- DOM.NodeId nodeId
- # Element pseudo classes to force when computing the element's style.
- array of string forcedPseudoClasses
- command getBackgroundColors
- parameters
- # Id of the node to get background colors for.
- DOM.NodeId nodeId
- returns
- # The range of background colors behind this element, if it contains any visible text. If no
- # visible text is present, this will be undefined. In the case of a flat background color,
- # this will consist of simply that color. In the case of a gradient, this will consist of each
- # of the color stops. For anything more complicated, this will be an empty array. Images will
- # be ignored (as if the image had failed to load).
- optional array of string backgroundColors
- # The computed font size for this node, as a CSS computed value string (e.g. '12px').
- optional string computedFontSize
- # The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
- # '100').
- optional string computedFontWeight
- # Returns the computed style for a DOM node identified by `nodeId`.
- command getComputedStyleForNode
- parameters
- DOM.NodeId nodeId
- returns
- # Computed style for the specified DOM node.
- array of CSSComputedStyleProperty computedStyle
- # Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
- # attributes) for a DOM node identified by `nodeId`.
- command getInlineStylesForNode
- parameters
- DOM.NodeId nodeId
- returns
- # Inline style for the specified DOM node.
- optional CSSStyle inlineStyle
- # Attribute-defined element style (e.g. resulting from "width=20 height=100%").
- optional CSSStyle attributesStyle
- # Returns requested styles for a DOM node identified by `nodeId`.
- command getMatchedStylesForNode
- parameters
- DOM.NodeId nodeId
- returns
- # Inline style for the specified DOM node.
- optional CSSStyle inlineStyle
- # Attribute-defined element style (e.g. resulting from "width=20 height=100%").
- optional CSSStyle attributesStyle
- # CSS rules matching this node, from all applicable stylesheets.
- optional array of RuleMatch matchedCSSRules
- # Pseudo style matches for this node.
- optional array of PseudoElementMatches pseudoElements
- # A chain of inherited styles (from the immediate node parent up to the DOM tree root).
- optional array of InheritedStyleEntry inherited
- # A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).
- optional array of InheritedPseudoElementMatches inheritedPseudoElements
- # A list of CSS keyframed animations matching this node.
- optional array of CSSKeyframesRule cssKeyframesRules
- # A list of CSS position fallbacks matching this node.
- optional array of CSSPositionFallbackRule cssPositionFallbackRules
- # Id of the first parent element that does not have display: contents.
- experimental optional DOM.NodeId parentLayoutNodeId
- # Returns all media queries parsed by the rendering engine.
- command getMediaQueries
- returns
- array of CSSMedia medias
- # Requests information about platform fonts which we used to render child TextNodes in the given
- # node.
- command getPlatformFontsForNode
- parameters
- DOM.NodeId nodeId
- returns
- # Usage statistics for every employed platform font.
- array of PlatformFontUsage fonts
- # Returns the current textual content for a stylesheet.
- command getStyleSheetText
- parameters
- StyleSheetId styleSheetId
- returns
- # The stylesheet text.
- string text
- # Returns all layers parsed by the rendering engine for the tree scope of a node.
- # Given a DOM element identified by nodeId, getLayersForNode returns the root
- # layer for the nearest ancestor document or shadow root. The layer root contains
- # the full layer tree for the tree scope and their ordering.
- experimental command getLayersForNode
- parameters
- DOM.NodeId nodeId
- returns
- CSSLayerData rootLayer
- # Starts tracking the given computed styles for updates. The specified array of properties
- # replaces the one previously specified. Pass empty array to disable tracking.
- # Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
- # The changes to computed style properties are only tracked for nodes pushed to the front-end
- # by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
- # to the front-end, no updates will be issued for the node.
- experimental command trackComputedStyleUpdates
- parameters
- array of CSSComputedStyleProperty propertiesToTrack
- # Polls the next batch of computed style updates.
- experimental command takeComputedStyleUpdates
- returns
- # The list of node Ids that have their tracked computed styles updated.
- array of DOM.NodeId nodeIds
- # Find a rule with the given active property for the given node and set the new value for this
- # property
- command setEffectivePropertyValueForNode
- parameters
- # The element id for which to set property.
- DOM.NodeId nodeId
- string propertyName
- string value
- # Modifies the keyframe rule key text.
- command setKeyframeKey
- parameters
- StyleSheetId styleSheetId
- SourceRange range
- string keyText
- returns
- # The resulting key text after modification.
- Value keyText
- # Modifies the rule selector.
- command setMediaText
- parameters
- StyleSheetId styleSheetId
- SourceRange range
- string text
- returns
- # The resulting CSS media rule after modification.
- CSSMedia media
- # Modifies the expression of a container query.
- experimental command setContainerQueryText
- parameters
- StyleSheetId styleSheetId
- SourceRange range
- string text
- returns
- # The resulting CSS container query rule after modification.
- CSSContainerQuery containerQuery
- # Modifies the expression of a supports at-rule.
- experimental command setSupportsText
- parameters
- StyleSheetId styleSheetId
- SourceRange range
- string text
- returns
- # The resulting CSS Supports rule after modification.
- CSSSupports supports
- # Modifies the expression of a scope at-rule.
- experimental command setScopeText
- parameters
- StyleSheetId styleSheetId
- SourceRange range
- string text
- returns
- # The resulting CSS Scope rule after modification.
- CSSScope scope
- # Modifies the rule selector.
- command setRuleSelector
- parameters
- StyleSheetId styleSheetId
- SourceRange range
- string selector
- returns
- # The resulting selector list after modification.
- SelectorList selectorList
- # Sets the new stylesheet text.
- command setStyleSheetText
- parameters
- StyleSheetId styleSheetId
- string text
- returns
- # URL of source map associated with script (if any).
- optional string sourceMapURL
- # Applies specified style edits one after another in the given order.
- command setStyleTexts
- parameters
- array of StyleDeclarationEdit edits
- returns
- # The resulting styles after modification.
- array of CSSStyle styles
- # Enables the selector recording.
- command startRuleUsageTracking
- # Stop tracking rule usage and return the list of rules that were used since last call to
- # `takeCoverageDelta` (or since start of coverage instrumentation).
- command stopRuleUsageTracking
- returns
- array of RuleUsage ruleUsage
- # Obtain list of rules that became used since last call to this method (or since start of coverage
- # instrumentation).
- command takeCoverageDelta
- returns
- array of RuleUsage coverage
- # Monotonically increasing time, in seconds.
- number timestamp
- # Enables/disables rendering of local CSS fonts (enabled by default).
- experimental command setLocalFontsEnabled
- parameters
- # Whether rendering of local fonts is enabled.
- boolean enabled
- # Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
- # web font.
- event fontsUpdated
- parameters
- # The web font that has loaded.
- optional FontFace font
- # Fires whenever a MediaQuery result changes (for example, after a browser window has been
- # resized.) The current implementation considers only viewport-dependent media features.
- event mediaQueryResultChanged
- # Fired whenever an active document stylesheet is added.
- event styleSheetAdded
- parameters
- # Added stylesheet metainfo.
- CSSStyleSheetHeader header
- # Fired whenever a stylesheet is changed as a result of the client operation.
- event styleSheetChanged
- parameters
- StyleSheetId styleSheetId
- # Fired whenever an active document stylesheet is removed.
- event styleSheetRemoved
- parameters
- # Identifier of the removed stylesheet.
- StyleSheetId styleSheetId
- experimental domain CacheStorage
- depends on Storage
- # Unique identifier of the Cache object.
- type CacheId extends string
- # type of HTTP response cached
- type CachedResponseType extends string
- enum
- basic
- cors
- default
- error
- opaqueResponse
- opaqueRedirect
- # Data entry.
- type DataEntry extends object
- properties
- # Request URL.
- string requestURL
- # Request method.
- string requestMethod
- # Request headers
- array of Header requestHeaders
- # Number of seconds since epoch.
- number responseTime
- # HTTP response status code.
- integer responseStatus
- # HTTP response status text.
- string responseStatusText
- # HTTP response type
- CachedResponseType responseType
- # Response headers
- array of Header responseHeaders
- # Cache identifier.
- type Cache extends object
- properties
- # An opaque unique id of the cache.
- CacheId cacheId
- # Security origin of the cache.
- string securityOrigin
- # Storage key of the cache.
- string storageKey
- # Storage bucket of the cache.
- optional Storage.StorageBucket storageBucket
- # The name of the cache.
- string cacheName
- type Header extends object
- properties
- string name
- string value
- # Cached response
- type CachedResponse extends object
- properties
- # Entry content, base64-encoded.
- binary body
- # Deletes a cache.
- command deleteCache
- parameters
- # Id of cache for deletion.
- CacheId cacheId
- # Deletes a cache entry.
- command deleteEntry
- parameters
- # Id of cache where the entry will be deleted.
- CacheId cacheId
- # URL spec of the request.
- string request
- # Requests cache names.
- command requestCacheNames
- parameters
- # At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- returns
- # Caches for the security origin.
- array of Cache caches
- # Fetches cache entry.
- command requestCachedResponse
- parameters
- # Id of cache that contains the entry.
- CacheId cacheId
- # URL spec of the request.
- string requestURL
- # headers of the request.
- array of Header requestHeaders
- returns
- # Response read from the cache.
- CachedResponse response
- # Requests data from cache.
- command requestEntries
- parameters
- # ID of cache to get entries from.
- CacheId cacheId
- # Number of records to skip.
- optional integer skipCount
- # Number of records to fetch.
- optional integer pageSize
- # If present, only return the entries containing this substring in the path
- optional string pathFilter
- returns
- # Array of object store data entries.
- array of DataEntry cacheDataEntries
- # Count of returned entries from this storage. If pathFilter is empty, it
- # is the count of all entries from this storage.
- number returnCount
- # A domain for interacting with Cast, Presentation API, and Remote Playback API
- # functionalities.
- experimental domain Cast
- type Sink extends object
- properties
- string name
- string id
- # Text describing the current session. Present only if there is an active
- # session on the sink.
- optional string session
- # Starts observing for sinks that can be used for tab mirroring, and if set,
- # sinks compatible with |presentationUrl| as well. When sinks are found, a
- # |sinksUpdated| event is fired.
- # Also starts observing for issue messages. When an issue is added or removed,
- # an |issueUpdated| event is fired.
- command enable
- parameters
- optional string presentationUrl
- # Stops observing for sinks and issues.
- command disable
- # Sets a sink to be used when the web page requests the browser to choose a
- # sink via Presentation API, Remote Playback API, or Cast SDK.
- command setSinkToUse
- parameters
- string sinkName
- # Starts mirroring the desktop to the sink.
- command startDesktopMirroring
- parameters
- string sinkName
- # Starts mirroring the tab to the sink.
- command startTabMirroring
- parameters
- string sinkName
- # Stops the active Cast session on the sink.
- command stopCasting
- parameters
- string sinkName
- # This is fired whenever the list of available sinks changes. A sink is a
- # device or a software surface that you can cast to.
- event sinksUpdated
- parameters
- array of Sink sinks
- # This is fired whenever the outstanding issue/error message changes.
- # |issueMessage| is empty if there is no issue.
- event issueUpdated
- parameters
- string issueMessage
- # This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
- # that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
- # the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
- # nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
- # and never sends the same node twice. It is client's responsibility to collect information about
- # the nodes that were sent to the client.<p>Note that `iframe` owner elements will return
- # corresponding document elements as their child nodes.</p>
- domain DOM
- depends on Runtime
- # Unique DOM node identifier.
- type NodeId extends integer
- # Unique DOM node identifier used to reference a node that may not have been pushed to the
- # front-end.
- type BackendNodeId extends integer
- # Backend node with a friendly name.
- type BackendNode extends object
- properties
- # `Node`'s nodeType.
- integer nodeType
- # `Node`'s nodeName.
- string nodeName
- BackendNodeId backendNodeId
- # Pseudo element type.
- type PseudoType extends string
- enum
- first-line
- first-letter
- before
- after
- marker
- backdrop
- selection
- target-text
- spelling-error
- grammar-error
- highlight
- first-line-inherited
- scrollbar
- scrollbar-thumb
- scrollbar-button
- scrollbar-track
- scrollbar-track-piece
- scrollbar-corner
- resizer
- input-list-button
- view-transition
- view-transition-group
- view-transition-image-pair
- view-transition-old
- view-transition-new
- # Shadow root type.
- type ShadowRootType extends string
- enum
- user-agent
- open
- closed
- # Document compatibility mode.
- type CompatibilityMode extends string
- enum
- QuirksMode
- LimitedQuirksMode
- NoQuirksMode
- # ContainerSelector physical axes
- type PhysicalAxes extends string
- enum
- Horizontal
- Vertical
- Both
- # ContainerSelector logical axes
- type LogicalAxes extends string
- enum
- Inline
- Block
- Both
- # DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
- # DOMNode is a base node mirror type.
- type Node extends object
- properties
- # Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
- # will only push node with given `id` once. It is aware of all requested nodes and will only
- # fire DOM events for nodes known to the client.
- NodeId nodeId
- # The id of the parent node if any.
- optional NodeId parentId
- # The BackendNodeId for this node.
- BackendNodeId backendNodeId
- # `Node`'s nodeType.
- integer nodeType
- # `Node`'s nodeName.
- string nodeName
- # `Node`'s localName.
- string localName
- # `Node`'s nodeValue.
- string nodeValue
- # Child count for `Container` nodes.
- optional integer childNodeCount
- # Child nodes of this node when requested with children.
- optional array of Node children
- # Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
- optional array of string attributes
- # Document URL that `Document` or `FrameOwner` node points to.
- optional string documentURL
- # Base URL that `Document` or `FrameOwner` node uses for URL completion.
- optional string baseURL
- # `DocumentType`'s publicId.
- optional string publicId
- # `DocumentType`'s systemId.
- optional string systemId
- # `DocumentType`'s internalSubset.
- optional string internalSubset
- # `Document`'s XML version in case of XML documents.
- optional string xmlVersion
- # `Attr`'s name.
- optional string name
- # `Attr`'s value.
- optional string value
- # Pseudo element type for this node.
- optional PseudoType pseudoType
- # Pseudo element identifier for this node. Only present if there is a
- # valid pseudoType.
- optional string pseudoIdentifier
- # Shadow root type.
- optional ShadowRootType shadowRootType
- # Frame ID for frame owner elements.
- optional Page.FrameId frameId
- # Content document for frame owner elements.
- optional Node contentDocument
- # Shadow root list for given element host.
- optional array of Node shadowRoots
- # Content document fragment for template elements.
- optional Node templateContent
- # Pseudo elements associated with this node.
- optional array of Node pseudoElements
- # Deprecated, as the HTML Imports API has been removed (crbug.com/937746).
- # This property used to return the imported document for the HTMLImport links.
- # The property is always undefined now.
- deprecated optional Node importedDocument
- # Distributed nodes for given insertion point.
- optional array of BackendNode distributedNodes
- # Whether the node is SVG.
- optional boolean isSVG
- optional CompatibilityMode compatibilityMode
- optional BackendNode assignedSlot
- # A structure holding an RGBA color.
- type RGBA extends object
- properties
- # The red component, in the [0-255] range.
- integer r
- # The green component, in the [0-255] range.
- integer g
- # The blue component, in the [0-255] range.
- integer b
- # The alpha component, in the [0-1] range (default: 1).
- optional number a
- # An array of quad vertices, x immediately followed by y for each point, points clock-wise.
- type Quad extends array of number
- # Box model.
- type BoxModel extends object
- properties
- # Content box
- Quad content
- # Padding box
- Quad padding
- # Border box
- Quad border
- # Margin box
- Quad margin
- # Node width
- integer width
- # Node height
- integer height
- # Shape outside coordinates
- optional ShapeOutsideInfo shapeOutside
- # CSS Shape Outside details.
- type ShapeOutsideInfo extends object
- properties
- # Shape bounds
- Quad bounds
- # Shape coordinate details
- array of any shape
- # Margin shape bounds
- array of any marginShape
- # Rectangle.
- type Rect extends object
- properties
- # X coordinate
- number x
- # Y coordinate
- number y
- # Rectangle width
- number width
- # Rectangle height
- number height
- type CSSComputedStyleProperty extends object
- properties
- # Computed style property name.
- string name
- # Computed style property value.
- string value
- # Collects class names for the node with given id and all of it's child nodes.
- experimental command collectClassNamesFromSubtree
- parameters
- # Id of the node to collect class names.
- NodeId nodeId
- returns
- # Class name list.
- array of string classNames
- # Creates a deep copy of the specified node and places it into the target container before the
- # given anchor.
- experimental command copyTo
- parameters
- # Id of the node to copy.
- NodeId nodeId
- # Id of the element to drop the copy into.
- NodeId targetNodeId
- # Drop the copy before this node (if absent, the copy becomes the last child of
- # `targetNodeId`).
- optional NodeId insertBeforeNodeId
- returns
- # Id of the node clone.
- NodeId nodeId
- # Describes node given its id, does not require domain to be enabled. Does not start tracking any
- # objects, can be used for automation.
- command describeNode
- parameters
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
- # entire subtree or provide an integer larger than 0.
- optional integer depth
- # Whether or not iframes and shadow roots should be traversed when returning the subtree
- # (default is false).
- optional boolean pierce
- returns
- # Node description.
- Node node
- # Scrolls the specified rect of the given node into view if not already visible.
- # Note: exactly one between nodeId, backendNodeId and objectId should be passed
- # to identify the node.
- experimental command scrollIntoViewIfNeeded
- parameters
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- # The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
- # When omitted, center of the node will be used, similar to Element.scrollIntoView.
- optional Rect rect
- # Disables DOM agent for the given page.
- command disable
- # Discards search results from the session with the given id. `getSearchResults` should no longer
- # be called for that search.
- experimental command discardSearchResults
- parameters
- # Unique search session identifier.
- string searchId
- # Enables DOM agent for the given page.
- command enable
- parameters
- # Whether to include whitespaces in the children array of returned Nodes.
- experimental optional enum includeWhitespace
- # Strip whitespaces from child arrays (default).
- none
- # Return all children including block-level whitespace nodes.
- all
- # Focuses the given element.
- command focus
- parameters
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- # Returns attributes for the specified node.
- command getAttributes
- parameters
- # Id of the node to retrieve attibutes for.
- NodeId nodeId
- returns
- # An interleaved array of node attribute names and values.
- array of string attributes
- # Returns boxes for the given node.
- command getBoxModel
- parameters
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- returns
- # Box model for the node.
- BoxModel model
- # Returns quads that describe node position on the page. This method
- # might return multiple quads for inline nodes.
- experimental command getContentQuads
- parameters
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- returns
- # Quads that describe node layout relative to viewport.
- array of Quad quads
- # Returns the root DOM node (and optionally the subtree) to the caller.
- # Implicitly enables the DOM domain events for the current target.
- command getDocument
- parameters
- # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
- # entire subtree or provide an integer larger than 0.
- optional integer depth
- # Whether or not iframes and shadow roots should be traversed when returning the subtree
- # (default is false).
- optional boolean pierce
- returns
- # Resulting node.
- Node root
- # Returns the root DOM node (and optionally the subtree) to the caller.
- # Deprecated, as it is not designed to work well with the rest of the DOM agent.
- # Use DOMSnapshot.captureSnapshot instead.
- deprecated command getFlattenedDocument
- parameters
- # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
- # entire subtree or provide an integer larger than 0.
- optional integer depth
- # Whether or not iframes and shadow roots should be traversed when returning the subtree
- # (default is false).
- optional boolean pierce
- returns
- # Resulting node.
- array of Node nodes
- # Finds nodes with a given computed style in a subtree.
- experimental command getNodesForSubtreeByStyle
- parameters
- # Node ID pointing to the root of a subtree.
- NodeId nodeId
- # The style to filter nodes by (includes nodes if any of properties matches).
- array of CSSComputedStyleProperty computedStyles
- # Whether or not iframes and shadow roots in the same target should be traversed when returning the
- # results (default is false).
- optional boolean pierce
- returns
- # Resulting nodes.
- array of NodeId nodeIds
- # Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
- # either returned or not.
- command getNodeForLocation
- parameters
- # X coordinate.
- integer x
- # Y coordinate.
- integer y
- # False to skip to the nearest non-UA shadow root ancestor (default: false).
- optional boolean includeUserAgentShadowDOM
- # Whether to ignore pointer-events: none on elements and hit test them.
- optional boolean ignorePointerEventsNone
- returns
- # Resulting node.
- BackendNodeId backendNodeId
- # Frame this node belongs to.
- Page.FrameId frameId
- # Id of the node at given coordinates, only when enabled and requested document.
- optional NodeId nodeId
- # Returns node's HTML markup.
- command getOuterHTML
- parameters
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- returns
- # Outer HTML markup.
- string outerHTML
- # Returns the id of the nearest ancestor that is a relayout boundary.
- experimental command getRelayoutBoundary
- parameters
- # Id of the node.
- NodeId nodeId
- returns
- # Relayout boundary node id for the given node.
- NodeId nodeId
- # Returns search results from given `fromIndex` to given `toIndex` from the search with the given
- # identifier.
- experimental command getSearchResults
- parameters
- # Unique search session identifier.
- string searchId
- # Start index of the search result to be returned.
- integer fromIndex
- # End index of the search result to be returned.
- integer toIndex
- returns
- # Ids of the search result nodes.
- array of NodeId nodeIds
- # Hides any highlight.
- command hideHighlight
- # Use 'Overlay.hideHighlight' instead
- redirect Overlay
- # Highlights DOM node.
- command highlightNode
- # Use 'Overlay.highlightNode' instead
- redirect Overlay
- # Highlights given rectangle.
- command highlightRect
- # Use 'Overlay.highlightRect' instead
- redirect Overlay
- # Marks last undoable state.
- experimental command markUndoableState
- # Moves node into the new container, places it before the given anchor.
- command moveTo
- parameters
- # Id of the node to move.
- NodeId nodeId
- # Id of the element to drop the moved node into.
- NodeId targetNodeId
- # Drop node before this one (if absent, the moved node becomes the last child of
- # `targetNodeId`).
- optional NodeId insertBeforeNodeId
- returns
- # New id of the moved node.
- NodeId nodeId
- # Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
- # `cancelSearch` to end this search session.
- experimental command performSearch
- parameters
- # Plain text or query selector or XPath search query.
- string query
- # True to search in user agent shadow DOM.
- optional boolean includeUserAgentShadowDOM
- returns
- # Unique search session identifier.
- string searchId
- # Number of search results.
- integer resultCount
- # Requests that the node is sent to the caller given its path. // FIXME, use XPath
- experimental command pushNodeByPathToFrontend
- parameters
- # Path to node in the proprietary format.
- string path
- returns
- # Id of the node for given path.
- NodeId nodeId
- # Requests that a batch of nodes is sent to the caller given their backend node ids.
- experimental command pushNodesByBackendIdsToFrontend
- parameters
- # The array of backend node ids.
- array of BackendNodeId backendNodeIds
- returns
- # The array of ids of pushed nodes that correspond to the backend ids specified in
- # backendNodeIds.
- array of NodeId nodeIds
- # Executes `querySelector` on a given node.
- command querySelector
- parameters
- # Id of the node to query upon.
- NodeId nodeId
- # Selector string.
- string selector
- returns
- # Query selector result.
- NodeId nodeId
- # Executes `querySelectorAll` on a given node.
- command querySelectorAll
- parameters
- # Id of the node to query upon.
- NodeId nodeId
- # Selector string.
- string selector
- returns
- # Query selector result.
- array of NodeId nodeIds
- # Returns NodeIds of current top layer elements.
- # Top layer is rendered closest to the user within a viewport, therefore its elements always
- # appear on top of all other content.
- experimental command getTopLayerElements
- returns
- # NodeIds of top layer elements
- array of NodeId nodeIds
- # Re-does the last undone action.
- experimental command redo
- # Removes attribute with given name from an element with given id.
- command removeAttribute
- parameters
- # Id of the element to remove attribute from.
- NodeId nodeId
- # Name of the attribute to remove.
- string name
- # Removes node with given id.
- command removeNode
- parameters
- # Id of the node to remove.
- NodeId nodeId
- # Requests that children of the node with given id are returned to the caller in form of
- # `setChildNodes` events where not only immediate children are retrieved, but all children down to
- # the specified depth.
- command requestChildNodes
- parameters
- # Id of the node to get children for.
- NodeId nodeId
- # The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
- # entire subtree or provide an integer larger than 0.
- optional integer depth
- # Whether or not iframes and shadow roots should be traversed when returning the sub-tree
- # (default is false).
- optional boolean pierce
- # Requests that the node is sent to the caller given the JavaScript node object reference. All
- # nodes that form the path from the node to the root are also sent to the client as a series of
- # `setChildNodes` notifications.
- command requestNode
- parameters
- # JavaScript object id to convert into node.
- Runtime.RemoteObjectId objectId
- returns
- # Node id for given object.
- NodeId nodeId
- # Resolves the JavaScript node object for a given NodeId or BackendNodeId.
- command resolveNode
- parameters
- # Id of the node to resolve.
- optional NodeId nodeId
- # Backend identifier of the node to resolve.
- optional DOM.BackendNodeId backendNodeId
- # Symbolic group name that can be used to release multiple objects.
- optional string objectGroup
- # Execution context in which to resolve the node.
- optional Runtime.ExecutionContextId executionContextId
- returns
- # JavaScript object wrapper for given node.
- Runtime.RemoteObject object
- # Sets attribute for an element with given id.
- command setAttributeValue
- parameters
- # Id of the element to set attribute for.
- NodeId nodeId
- # Attribute name.
- string name
- # Attribute value.
- string value
- # Sets attributes on element with given id. This method is useful when user edits some existing
- # attribute value and types in several attribute name/value pairs.
- command setAttributesAsText
- parameters
- # Id of the element to set attributes for.
- NodeId nodeId
- # Text with a number of attributes. Will parse this text using HTML parser.
- string text
- # Attribute name to replace with new attributes derived from text in case text parsed
- # successfully.
- optional string name
- # Sets files for the given file input element.
- command setFileInputFiles
- parameters
- # Array of file paths to set.
- array of string files
- # Identifier of the node.
- optional NodeId nodeId
- # Identifier of the backend node.
- optional BackendNodeId backendNodeId
- # JavaScript object id of the node wrapper.
- optional Runtime.RemoteObjectId objectId
- # Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
- experimental command setNodeStackTracesEnabled
- parameters
- # Enable or disable.
- boolean enable
- # Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
- experimental command getNodeStackTraces
- parameters
- # Id of the node to get stack traces for.
- NodeId nodeId
- returns
- # Creation stack trace, if available.
- optional Runtime.StackTrace creation
- # Returns file information for the given
- # File wrapper.
- experimental command getFileInfo
- parameters
- # JavaScript object id of the node wrapper.
- Runtime.RemoteObjectId objectId
- returns
- string path
- # Enables console to refer to the node with given id via $x (see Command Line API for more details
- # $x functions).
- experimental command setInspectedNode
- parameters
- # DOM node id to be accessible by means of $x command line API.
- NodeId nodeId
- # Sets node name for a node with given id.
- command setNodeName
- parameters
- # Id of the node to set name for.
- NodeId nodeId
- # New node's name.
- string name
- returns
- # New node's id.
- NodeId nodeId
- # Sets node value for a node with given id.
- command setNodeValue
- parameters
- # Id of the node to set value for.
- NodeId nodeId
- # New node's value.
- string value
- # Sets node HTML markup, returns new node id.
- command setOuterHTML
- parameters
- # Id of the node to set markup for.
- NodeId nodeId
- # Outer HTML markup to set.
- string outerHTML
- # Undoes the last performed action.
- experimental command undo
- # Returns iframe node that owns iframe with the given domain.
- experimental command getFrameOwner
- parameters
- Page.FrameId frameId
- returns
- # Resulting node.
- BackendNodeId backendNodeId
- # Id of the node at given coordinates, only when enabled and requested document.
- optional NodeId nodeId
- # Returns the query container of the given node based on container query
- # conditions: containerName, physical, and logical axes. If no axes are
- # provided, the style container is returned, which is the direct parent or the
- # closest element with a matching container-name.
- experimental command getContainerForNode
- parameters
- NodeId nodeId
- optional string containerName
- optional PhysicalAxes physicalAxes
- optional LogicalAxes logicalAxes
- returns
- # The container node for the given node, or null if not found.
- optional NodeId nodeId
- # Returns the descendants of a container query container that have
- # container queries against this container.
- experimental command getQueryingDescendantsForContainer
- parameters
- # Id of the container node to find querying descendants from.
- NodeId nodeId
- returns
- # Descendant nodes with container queries against the given container.
- array of NodeId nodeIds
- # Fired when `Element`'s attribute is modified.
- event attributeModified
- parameters
- # Id of the node that has changed.
- NodeId nodeId
- # Attribute name.
- string name
- # Attribute value.
- string value
- # Fired when `Element`'s attribute is removed.
- event attributeRemoved
- parameters
- # Id of the node that has changed.
- NodeId nodeId
- # A ttribute name.
- string name
- # Mirrors `DOMCharacterDataModified` event.
- event characterDataModified
- parameters
- # Id of the node that has changed.
- NodeId nodeId
- # New text value.
- string characterData
- # Fired when `Container`'s child node count has changed.
- event childNodeCountUpdated
- parameters
- # Id of the node that has changed.
- NodeId nodeId
- # New node count.
- integer childNodeCount
- # Mirrors `DOMNodeInserted` event.
- event childNodeInserted
- parameters
- # Id of the node that has changed.
- NodeId parentNodeId
- # Id of the previous sibling.
- NodeId previousNodeId
- # Inserted node data.
- Node node
- # Mirrors `DOMNodeRemoved` event.
- event childNodeRemoved
- parameters
- # Parent id.
- NodeId parentNodeId
- # Id of the node that has been removed.
- NodeId nodeId
- # Called when distribution is changed.
- experimental event distributedNodesUpdated
- parameters
- # Insertion point where distributed nodes were updated.
- NodeId insertionPointId
- # Distributed nodes for given insertion point.
- array of BackendNode distributedNodes
- # Fired when `Document` has been totally updated. Node ids are no longer valid.
- event documentUpdated
- # Fired when `Element`'s inline style is modified via a CSS property modification.
- experimental event inlineStyleInvalidated
- parameters
- # Ids of the nodes for which the inline styles have been invalidated.
- array of NodeId nodeIds
- # Called when a pseudo element is added to an element.
- experimental event pseudoElementAdded
- parameters
- # Pseudo element's parent element id.
- NodeId parentId
- # The added pseudo element.
- Node pseudoElement
- # Called when top layer elements are changed.
- experimental event topLayerElementsUpdated
- # Called when a pseudo element is removed from an element.
- experimental event pseudoElementRemoved
- parameters
- # Pseudo element's parent element id.
- NodeId parentId
- # The removed pseudo element id.
- NodeId pseudoElementId
- # Fired when backend wants to provide client with the missing DOM structure. This happens upon
- # most of the calls requesting node ids.
- event setChildNodes
- parameters
- # Parent node id to populate with children.
- NodeId parentId
- # Child nodes array.
- array of Node nodes
- # Called when shadow root is popped from the element.
- experimental event shadowRootPopped
- parameters
- # Host element id.
- NodeId hostId
- # Shadow root id.
- NodeId rootId
- # Called when shadow root is pushed into the element.
- experimental event shadowRootPushed
- parameters
- # Host element id.
- NodeId hostId
- # Shadow root.
- Node root
- # DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
- # execution will stop on these operations as if there was a regular breakpoint set.
- domain DOMDebugger
- depends on DOM
- depends on Debugger
- depends on Runtime
- # DOM breakpoint type.
- type DOMBreakpointType extends string
- enum
- subtree-modified
- attribute-modified
- node-removed
- # CSP Violation type.
- experimental type CSPViolationType extends string
- enum
- trustedtype-sink-violation
- trustedtype-policy-violation
- # Object event listener.
- type EventListener extends object
- properties
- # `EventListener`'s type.
- string type
- # `EventListener`'s useCapture.
- boolean useCapture
- # `EventListener`'s passive flag.
- boolean passive
- # `EventListener`'s once flag.
- boolean once
- # Script id of the handler code.
- Runtime.ScriptId scriptId
- # Line number in the script (0-based).
- integer lineNumber
- # Column number in the script (0-based).
- integer columnNumber
- # Event handler function value.
- optional Runtime.RemoteObject handler
- # Event original handler function value.
- optional Runtime.RemoteObject originalHandler
- # Node the listener is added to (if any).
- optional DOM.BackendNodeId backendNodeId
- # Returns event listeners of the given object.
- command getEventListeners
- parameters
- # Identifier of the object to return listeners for.
- Runtime.RemoteObjectId objectId
- # The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
- # entire subtree or provide an integer larger than 0.
- optional integer depth
- # Whether or not iframes and shadow roots should be traversed when returning the subtree
- # (default is false). Reports listeners for all contexts if pierce is enabled.
- optional boolean pierce
- returns
- # Array of relevant listeners.
- array of EventListener listeners
- # Removes DOM breakpoint that was set using `setDOMBreakpoint`.
- command removeDOMBreakpoint
- parameters
- # Identifier of the node to remove breakpoint from.
- DOM.NodeId nodeId
- # Type of the breakpoint to remove.
- DOMBreakpointType type
- # Removes breakpoint on particular DOM event.
- command removeEventListenerBreakpoint
- parameters
- # Event name.
- string eventName
- # EventTarget interface name.
- experimental optional string targetName
- # Removes breakpoint on particular native event.
- experimental command removeInstrumentationBreakpoint
- parameters
- # Instrumentation name to stop on.
- string eventName
- # Removes breakpoint from XMLHttpRequest.
- command removeXHRBreakpoint
- parameters
- # Resource URL substring.
- string url
- # Sets breakpoint on particular CSP violations.
- experimental command setBreakOnCSPViolation
- parameters
- # CSP Violations to stop upon.
- array of CSPViolationType violationTypes
- # Sets breakpoint on particular operation with DOM.
- command setDOMBreakpoint
- parameters
- # Identifier of the node to set breakpoint on.
- DOM.NodeId nodeId
- # Type of the operation to stop upon.
- DOMBreakpointType type
- # Sets breakpoint on particular DOM event.
- command setEventListenerBreakpoint
- parameters
- # DOM Event name to stop on (any DOM event will do).
- string eventName
- # EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
- # EventTarget.
- experimental optional string targetName
- # Sets breakpoint on particular native event.
- experimental command setInstrumentationBreakpoint
- parameters
- # Instrumentation name to stop on.
- string eventName
- # Sets breakpoint on XMLHttpRequest.
- command setXHRBreakpoint
- parameters
- # Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
- string url
- # EventBreakpoints permits setting breakpoints on particular operations and
- # events in targets that run JavaScript but do not have a DOM.
- # JavaScript execution will stop on these operations as if there was a regular
- # breakpoint set.
- experimental domain EventBreakpoints
- # Sets breakpoint on particular native event.
- command setInstrumentationBreakpoint
- parameters
- # Instrumentation name to stop on.
- string eventName
- # Removes breakpoint on particular native event.
- command removeInstrumentationBreakpoint
- parameters
- # Instrumentation name to stop on.
- string eventName
- # This domain facilitates obtaining document snapshots with DOM, layout, and style information.
- experimental domain DOMSnapshot
- depends on CSS
- depends on DOM
- depends on DOMDebugger
- depends on Page
- # A Node in the DOM tree.
- type DOMNode extends object
- properties
- # `Node`'s nodeType.
- integer nodeType
- # `Node`'s nodeName.
- string nodeName
- # `Node`'s nodeValue.
- string nodeValue
- # Only set for textarea elements, contains the text value.
- optional string textValue
- # Only set for input elements, contains the input's associated text value.
- optional string inputValue
- # Only set for radio and checkbox input elements, indicates if the element has been checked
- optional boolean inputChecked
- # Only set for option elements, indicates if the element has been selected
- optional boolean optionSelected
- # `Node`'s id, corresponds to DOM.Node.backendNodeId.
- DOM.BackendNodeId backendNodeId
- # The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
- # any.
- optional array of integer childNodeIndexes
- # Attributes of an `Element` node.
- optional array of NameValue attributes
- # Indexes of pseudo elements associated with this node in the `domNodes` array returned by
- # `getSnapshot`, if any.
- optional array of integer pseudoElementIndexes
- # The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
- # `getSnapshot`, if any.
- optional integer layoutNodeIndex
- # Document URL that `Document` or `FrameOwner` node points to.
- optional string documentURL
- # Base URL that `Document` or `FrameOwner` node uses for URL completion.
- optional string baseURL
- # Only set for documents, contains the document's content language.
- optional string contentLanguage
- # Only set for documents, contains the document's character set encoding.
- optional string documentEncoding
- # `DocumentType` node's publicId.
- optional string publicId
- # `DocumentType` node's systemId.
- optional string systemId
- # Frame ID for frame owner elements and also for the document node.
- optional Page.FrameId frameId
- # The index of a frame owner element's content document in the `domNodes` array returned by
- # `getSnapshot`, if any.
- optional integer contentDocumentIndex
- # Type of a pseudo element node.
- optional DOM.PseudoType pseudoType
- # Shadow root type.
- optional DOM.ShadowRootType shadowRootType
- # Whether this DOM node responds to mouse clicks. This includes nodes that have had click
- # event listeners attached via JavaScript as well as anchor tags that naturally navigate when
- # clicked.
- optional boolean isClickable
- # Details of the node's event listeners, if any.
- optional array of DOMDebugger.EventListener eventListeners
- # The selected url for nodes with a srcset attribute.
- optional string currentSourceURL
- # The url of the script (if any) that generates this node.
- optional string originURL
- # Scroll offsets, set when this node is a Document.
- optional number scrollOffsetX
- optional number scrollOffsetY
- # Details of post layout rendered text positions. The exact layout should not be regarded as
- # stable and may change between versions.
- type InlineTextBox extends object
- properties
- # The bounding box in document coordinates. Note that scroll offset of the document is ignored.
- DOM.Rect boundingBox
- # The starting index in characters, for this post layout textbox substring. Characters that
- # would be represented as a surrogate pair in UTF-16 have length 2.
- integer startCharacterIndex
- # The number of characters in this post layout textbox substring. Characters that would be
- # represented as a surrogate pair in UTF-16 have length 2.
- integer numCharacters
- # Details of an element in the DOM tree with a LayoutObject.
- type LayoutTreeNode extends object
- properties
- # The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
- integer domNodeIndex
- # The bounding box in document coordinates. Note that scroll offset of the document is ignored.
- DOM.Rect boundingBox
- # Contents of the LayoutText, if any.
- optional string layoutText
- # The post-layout inline text nodes, if any.
- optional array of InlineTextBox inlineTextNodes
- # Index into the `computedStyles` array returned by `getSnapshot`.
- optional integer styleIndex
- # Global paint order index, which is determined by the stacking order of the nodes. Nodes
- # that are painted together will have the same index. Only provided if includePaintOrder in
- # getSnapshot was true.
- optional integer paintOrder
- # Set to true to indicate the element begins a new stacking context.
- optional boolean isStackingContext
- # A subset of the full ComputedStyle as defined by the request whitelist.
- type ComputedStyle extends object
- properties
- # Name/value pairs of computed style properties.
- array of NameValue properties
- # A name/value pair.
- type NameValue extends object
- properties
- # Attribute/property name.
- string name
- # Attribute/property value.
- string value
- # Index of the string in the strings table.
- type StringIndex extends integer
- # Index of the string in the strings table.
- type ArrayOfStrings extends array of StringIndex
- # Data that is only present on rare nodes.
- type RareStringData extends object
- properties
- array of integer index
- array of StringIndex value
- type RareBooleanData extends object
- properties
- array of integer index
- type RareIntegerData extends object
- properties
- array of integer index
- array of integer value
- type Rectangle extends array of number
- # Document snapshot.
- type DocumentSnapshot extends object
- properties
- # Document URL that `Document` or `FrameOwner` node points to.
- StringIndex documentURL
- # Document title.
- StringIndex title
- # Base URL that `Document` or `FrameOwner` node uses for URL completion.
- StringIndex baseURL
- # Contains the document's content language.
- StringIndex contentLanguage
- # Contains the document's character set encoding.
- StringIndex encodingName
- # `DocumentType` node's publicId.
- StringIndex publicId
- # `DocumentType` node's systemId.
- StringIndex systemId
- # Frame ID for frame owner elements and also for the document node.
- StringIndex frameId
- # A table with dom nodes.
- NodeTreeSnapshot nodes
- # The nodes in the layout tree.
- LayoutTreeSnapshot layout
- # The post-layout inline text nodes.
- TextBoxSnapshot textBoxes
- # Horizontal scroll offset.
- optional number scrollOffsetX
- # Vertical scroll offset.
- optional number scrollOffsetY
- # Document content width.
- optional number contentWidth
- # Document content height.
- optional number contentHeight
- # Table containing nodes.
- type NodeTreeSnapshot extends object
- properties
- # Parent node index.
- optional array of integer parentIndex
- # `Node`'s nodeType.
- optional array of integer nodeType
- # Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.
- optional RareStringData shadowRootType
- # `Node`'s nodeName.
- optional array of StringIndex nodeName
- # `Node`'s nodeValue.
- optional array of StringIndex nodeValue
- # `Node`'s id, corresponds to DOM.Node.backendNodeId.
- optional array of DOM.BackendNodeId backendNodeId
- # Attributes of an `Element` node. Flatten name, value pairs.
- optional array of ArrayOfStrings attributes
- # Only set for textarea elements, contains the text value.
- optional RareStringData textValue
- # Only set for input elements, contains the input's associated text value.
- optional RareStringData inputValue
- # Only set for radio and checkbox input elements, indicates if the element has been checked
- optional RareBooleanData inputChecked
- # Only set for option elements, indicates if the element has been selected
- optional RareBooleanData optionSelected
- # The index of the document in the list of the snapshot documents.
- optional RareIntegerData contentDocumentIndex
- # Type of a pseudo element node.
- optional RareStringData pseudoType
- # Pseudo element identifier for this node. Only present if there is a
- # valid pseudoType.
- optional RareStringData pseudoIdentifier
- # Whether this DOM node responds to mouse clicks. This includes nodes that have had click
- # event listeners attached via JavaScript as well as anchor tags that naturally navigate when
- # clicked.
- optional RareBooleanData isClickable
- # The selected url for nodes with a srcset attribute.
- optional RareStringData currentSourceURL
- # The url of the script (if any) that generates this node.
- optional RareStringData originURL
- # Table of details of an element in the DOM tree with a LayoutObject.
- type LayoutTreeSnapshot extends object
- properties
- # Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
- array of integer nodeIndex
- # Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
- array of ArrayOfStrings styles
- # The absolute position bounding box.
- array of Rectangle bounds
- # Contents of the LayoutText, if any.
- array of StringIndex text
- # Stacking context information.
- RareBooleanData stackingContexts
- # Global paint order index, which is determined by the stacking order of the nodes. Nodes
- # that are painted together will have the same index. Only provided if includePaintOrder in
- # captureSnapshot was true.
- optional array of integer paintOrders
- # The offset rect of nodes. Only available when includeDOMRects is set to true
- optional array of Rectangle offsetRects
- # The scroll rect of nodes. Only available when includeDOMRects is set to true
- optional array of Rectangle scrollRects
- # The client rect of nodes. Only available when includeDOMRects is set to true
- optional array of Rectangle clientRects
- # The list of background colors that are blended with colors of overlapping elements.
- experimental optional array of StringIndex blendedBackgroundColors
- # The list of computed text opacities.
- experimental optional array of number textColorOpacities
- # Table of details of the post layout rendered text positions. The exact layout should not be regarded as
- # stable and may change between versions.
- type TextBoxSnapshot extends object
- properties
- # Index of the layout tree node that owns this box collection.
- array of integer layoutIndex
- # The absolute position bounding box.
- array of Rectangle bounds
- # The starting index in characters, for this post layout textbox substring. Characters that
- # would be represented as a surrogate pair in UTF-16 have length 2.
- array of integer start
- # The number of characters in this post layout textbox substring. Characters that would be
- # represented as a surrogate pair in UTF-16 have length 2.
- array of integer length
- # Disables DOM snapshot agent for the given page.
- command disable
- # Enables DOM snapshot agent for the given page.
- command enable
- # Returns a document snapshot, including the full DOM tree of the root node (including iframes,
- # template contents, and imported documents) in a flattened array, as well as layout and
- # white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
- # flattened.
- deprecated command getSnapshot
- parameters
- # Whitelist of computed styles to return.
- array of string computedStyleWhitelist
- # Whether or not to retrieve details of DOM listeners (default false).
- optional boolean includeEventListeners
- # Whether to determine and include the paint order index of LayoutTreeNodes (default false).
- optional boolean includePaintOrder
- # Whether to include UA shadow tree in the snapshot (default false).
- optional boolean includeUserAgentShadowTree
- returns
- # The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
- array of DOMNode domNodes
- # The nodes in the layout tree.
- array of LayoutTreeNode layoutTreeNodes
- # Whitelisted ComputedStyle properties for each node in the layout tree.
- array of ComputedStyle computedStyles
- # Returns a document snapshot, including the full DOM tree of the root node (including iframes,
- # template contents, and imported documents) in a flattened array, as well as layout and
- # white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is
- # flattened.
- command captureSnapshot
- parameters
- # Whitelist of computed styles to return.
- array of string computedStyles
- # Whether to include layout object paint orders into the snapshot.
- optional boolean includePaintOrder
- # Whether to include DOM rectangles (offsetRects, clientRects, scrollRects) into the snapshot
- optional boolean includeDOMRects
- # Whether to include blended background colors in the snapshot (default: false).
- # Blended background color is achieved by blending background colors of all elements
- # that overlap with the current element.
- experimental optional boolean includeBlendedBackgroundColors
- # Whether to include text color opacity in the snapshot (default: false).
- # An element might have the opacity property set that affects the text color of the element.
- # The final text color opacity is computed based on the opacity of all overlapping elements.
- experimental optional boolean includeTextColorOpacities
- returns
- # The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.
- array of DocumentSnapshot documents
- # Shared string table that all string properties refer to with indexes.
- array of string strings
- # Query and modify DOM storage.
- experimental domain DOMStorage
- type SerializedStorageKey extends string
- # DOM Storage identifier.
- type StorageId extends object
- properties
- # Security origin for the storage.
- optional string securityOrigin
- # Represents a key by which DOM Storage keys its CachedStorageAreas
- optional SerializedStorageKey storageKey
- # Whether the storage is local storage (not session storage).
- boolean isLocalStorage
- # DOM Storage item.
- type Item extends array of string
- command clear
- parameters
- StorageId storageId
- # Disables storage tracking, prevents storage events from being sent to the client.
- command disable
- # Enables storage tracking, storage events will now be delivered to the client.
- command enable
- command getDOMStorageItems
- parameters
- StorageId storageId
- returns
- array of Item entries
- command removeDOMStorageItem
- parameters
- StorageId storageId
- string key
- command setDOMStorageItem
- parameters
- StorageId storageId
- string key
- string value
- event domStorageItemAdded
- parameters
- StorageId storageId
- string key
- string newValue
- event domStorageItemRemoved
- parameters
- StorageId storageId
- string key
- event domStorageItemUpdated
- parameters
- StorageId storageId
- string key
- string oldValue
- string newValue
- event domStorageItemsCleared
- parameters
- StorageId storageId
- experimental domain Database
- # Unique identifier of Database object.
- type DatabaseId extends string
- # Database object.
- type Database extends object
- properties
- # Database ID.
- DatabaseId id
- # Database domain.
- string domain
- # Database name.
- string name
- # Database version.
- string version
- # Database error.
- type Error extends object
- properties
- # Error message.
- string message
- # Error code.
- integer code
- # Disables database tracking, prevents database events from being sent to the client.
- command disable
- # Enables database tracking, database events will now be delivered to the client.
- command enable
- command executeSQL
- parameters
- DatabaseId databaseId
- string query
- returns
- optional array of string columnNames
- optional array of any values
- optional Error sqlError
- command getDatabaseTableNames
- parameters
- DatabaseId databaseId
- returns
- array of string tableNames
- event addDatabase
- parameters
- Database database
- experimental domain DeviceOrientation
- # Clears the overridden Device Orientation.
- command clearDeviceOrientationOverride
- # Overrides the Device Orientation.
- command setDeviceOrientationOverride
- parameters
- # Mock alpha
- number alpha
- # Mock beta
- number beta
- # Mock gamma
- number gamma
- # This domain emulates different environments for the page.
- domain Emulation
- depends on DOM
- depends on Page
- depends on Runtime
- # Screen orientation.
- type ScreenOrientation extends object
- properties
- # Orientation type.
- enum type
- portraitPrimary
- portraitSecondary
- landscapePrimary
- landscapeSecondary
- # Orientation angle.
- integer angle
- type DisplayFeature extends object
- properties
- # Orientation of a display feature in relation to screen
- enum orientation
- vertical
- horizontal
- # The offset from the screen origin in either the x (for vertical
- # orientation) or y (for horizontal orientation) direction.
- integer offset
- # A display feature may mask content such that it is not physically
- # displayed - this length along with the offset describes this area.
- # A display feature that only splits content will have a 0 mask_length.
- integer maskLength
- type MediaFeature extends object
- properties
- string name
- string value
- # advance: If the scheduler runs out of immediate work, the virtual time base may fast forward to
- # allow the next delayed task (if any) to run; pause: The virtual time base may not advance;
- # pauseIfNetworkFetchesPending: The virtual time base may not advance if there are any pending
- # resource fetches.
- experimental type VirtualTimePolicy extends string
- enum
- advance
- pause
- pauseIfNetworkFetchesPending
- # Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
- experimental type UserAgentBrandVersion extends object
- properties
- string brand
- string version
- # Used to specify User Agent Cient Hints to emulate. See https://wicg.github.io/ua-client-hints
- # Missing optional values will be filled in by the target with what it would normally use.
- experimental type UserAgentMetadata extends object
- properties
- # Brands appearing in Sec-CH-UA.
- optional array of UserAgentBrandVersion brands
- # Brands appearing in Sec-CH-UA-Full-Version-List.
- optional array of UserAgentBrandVersion fullVersionList
- deprecated optional string fullVersion
- string platform
- string platformVersion
- string architecture
- string model
- boolean mobile
- optional string bitness
- optional boolean wow64
- # Tells whether emulation is supported.
- command canEmulate
- returns
- # True if emulation is supported.
- boolean result
- # Clears the overridden device metrics.
- command clearDeviceMetricsOverride
- # Clears the overridden Geolocation Position and Error.
- command clearGeolocationOverride
- # Requests that page scale factor is reset to initial values.
- experimental command resetPageScaleFactor
- # Enables or disables simulating a focused and active page.
- experimental command setFocusEmulationEnabled
- parameters
- # Whether to enable to disable focus emulation.
- boolean enabled
- # Automatically render all web contents using a dark theme.
- experimental command setAutoDarkModeOverride
- parameters
- # Whether to enable or disable automatic dark mode.
- # If not specified, any existing override will be cleared.
- optional boolean enabled
- # Enables CPU throttling to emulate slow CPUs.
- experimental command setCPUThrottlingRate
- parameters
- # Throttling rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).
- number rate
- # Sets or clears an override of the default background color of the frame. This override is used
- # if the content does not specify one.
- command setDefaultBackgroundColorOverride
- parameters
- # RGBA of the default background color. If not specified, any existing override will be
- # cleared.
- optional DOM.RGBA color
- # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
- # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
- # query results).
- command setDeviceMetricsOverride
- parameters
- # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
- integer width
- # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
- integer height
- # Overriding device scale factor value. 0 disables the override.
- number deviceScaleFactor
- # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
- # autosizing and more.
- boolean mobile
- # Scale to apply to resulting view image.
- experimental optional number scale
- # Overriding screen width value in pixels (minimum 0, maximum 10000000).
- experimental optional integer screenWidth
- # Overriding screen height value in pixels (minimum 0, maximum 10000000).
- experimental optional integer screenHeight
- # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
- experimental optional integer positionX
- # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
- experimental optional integer positionY
- # Do not set visible view size, rely upon explicit setVisibleSize call.
- experimental optional boolean dontSetVisibleSize
- # Screen orientation override.
- optional ScreenOrientation screenOrientation
- # If set, the visible area of the page will be overridden to this viewport. This viewport
- # change is not observed by the page, e.g. viewport-relative elements do not change positions.
- experimental optional Page.Viewport viewport
- # If set, the display feature of a multi-segment screen. If not set, multi-segment support
- # is turned-off.
- experimental optional DisplayFeature displayFeature
- experimental command setScrollbarsHidden
- parameters
- # Whether scrollbars should be always hidden.
- boolean hidden
- experimental command setDocumentCookieDisabled
- parameters
- # Whether document.coookie API should be disabled.
- boolean disabled
- experimental command setEmitTouchEventsForMouse
- parameters
- # Whether touch emulation based on mouse input should be enabled.
- boolean enabled
- # Touch/gesture events configuration. Default: current platform.
- optional enum configuration
- mobile
- desktop
- # Emulates the given media type or media feature for CSS media queries.
- command setEmulatedMedia
- parameters
- # Media type to emulate. Empty string disables the override.
- optional string media
- # Media features to emulate.
- optional array of MediaFeature features
- # Emulates the given vision deficiency.
- experimental command setEmulatedVisionDeficiency
- parameters
- # Vision deficiency to emulate. Order: best-effort emulations come first, followed by any
- # physiologically accurate emulations for medically recognized color vision deficiencies.
- enum type
- none
- blurredVision
- reducedContrast
- achromatopsia
- deuteranopia
- protanopia
- tritanopia
- # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
- # unavailable.
- command setGeolocationOverride
- parameters
- # Mock latitude
- optional number latitude
- # Mock longitude
- optional number longitude
- # Mock accuracy
- optional number accuracy
- # Overrides the Idle state.
- experimental command setIdleOverride
- parameters
- # Mock isUserActive
- boolean isUserActive
- # Mock isScreenUnlocked
- boolean isScreenUnlocked
- # Clears Idle state overrides.
- experimental command clearIdleOverride
- # Overrides value returned by the javascript navigator object.
- experimental deprecated command setNavigatorOverrides
- parameters
- # The platform navigator.platform should return.
- string platform
- # Sets a specified page scale factor.
- experimental command setPageScaleFactor
- parameters
- # Page scale factor.
- number pageScaleFactor
- # Switches script execution in the page.
- command setScriptExecutionDisabled
- parameters
- # Whether script execution should be disabled in the page.
- boolean value
- # Enables touch on platforms which do not support them.
- command setTouchEmulationEnabled
- parameters
- # Whether the touch event emulation should be enabled.
- boolean enabled
- # Maximum touch points supported. Defaults to one.
- optional integer maxTouchPoints
- # Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets
- # the current virtual time policy. Note this supersedes any previous time budget.
- experimental command setVirtualTimePolicy
- parameters
- VirtualTimePolicy policy
- # If set, after this many virtual milliseconds have elapsed virtual time will be paused and a
- # virtualTimeBudgetExpired event is sent.
- optional number budget
- # If set this specifies the maximum number of tasks that can be run before virtual is forced
- # forwards to prevent deadlock.
- optional integer maxVirtualTimeTaskStarvationCount
- # If set, base::Time::Now will be overridden to initially return this value.
- optional Network.TimeSinceEpoch initialVirtualTime
- returns
- # Absolute timestamp at which virtual time was first enabled (up time in milliseconds).
- number virtualTimeTicksBase
- # Overrides default host system locale with the specified one.
- experimental command setLocaleOverride
- parameters
- # ICU style C locale (e.g. "en_US"). If not specified or empty, disables the override and
- # restores default host system locale.
- optional string locale
- # Overrides default host system timezone with the specified one.
- experimental command setTimezoneOverride
- parameters
- # The timezone identifier. If empty, disables the override and
- # restores default host system timezone.
- string timezoneId
- # Resizes the frame/viewport of the page. Note that this does not affect the frame's container
- # (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported
- # on Android.
- experimental deprecated command setVisibleSize
- parameters
- # Frame width (DIP).
- integer width
- # Frame height (DIP).
- integer height
- # Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
- experimental event virtualTimeBudgetExpired
- # Enum of image types that can be disabled.
- experimental type DisabledImageType extends string
- enum
- avif
- webp
- experimental command setDisabledImageTypes
- parameters
- # Image types to disable.
- array of DisabledImageType imageTypes
- experimental command setHardwareConcurrencyOverride
- parameters
- # Hardware concurrency to report
- integer hardwareConcurrency
- # Allows overriding user agent with the given string.
- command setUserAgentOverride
- parameters
- # User agent to use.
- string userAgent
- # Browser langugage to emulate.
- optional string acceptLanguage
- # The platform navigator.platform should return.
- optional string platform
- # To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
- experimental optional UserAgentMetadata userAgentMetadata
- # Allows overriding the automation flag.
- experimental command setAutomationOverride
- parameters
- # Whether the override should be enabled.
- boolean enabled
- # This domain provides experimental commands only supported in headless mode.
- experimental domain HeadlessExperimental
- depends on Page
- depends on Runtime
- # Encoding options for a screenshot.
- type ScreenshotParams extends object
- properties
- # Image compression format (defaults to png).
- optional enum format
- jpeg
- png
- webp
- # Compression quality from range [0..100] (jpeg only).
- optional integer quality
- # Optimize image encoding for speed, not for resulting size (defaults to false)
- optional boolean optimizeForSpeed
- # Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
- # screenshot from the resulting frame. Requires that the target was created with enabled
- # BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
- # https://goo.gle/chrome-headless-rendering for more background.
- command beginFrame
- parameters
- # Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
- # the current time will be used.
- optional number frameTimeTicks
- # The interval between BeginFrames that is reported to the compositor, in milliseconds.
- # Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
- optional number interval
- # Whether updates should not be committed and drawn onto the display. False by default. If
- # true, only side effects of the BeginFrame will be run, such as layout and animations, but
- # any visual updates may not be visible on the display or in screenshots.
- optional boolean noDisplayUpdates
- # If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
- # no screenshot will be captured. Note that capturing a screenshot can fail, for example,
- # during renderer initialization. In such a case, no screenshot data will be returned.
- optional ScreenshotParams screenshot
- returns
- # Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
- # display. Reported for diagnostic uses, may be removed in the future.
- boolean hasDamage
- # Base64-encoded image data of the screenshot, if one was requested and successfully taken.
- optional binary screenshotData
- # Disables headless events for the target.
- deprecated command disable
- # Enables headless events for the target.
- deprecated command enable
- # Input/Output operations for streams produced by DevTools.
- domain IO
- # This is either obtained from another method or specified as `blob:<uuid>` where
- # `<uuid>` is an UUID of a Blob.
- type StreamHandle extends string
- # Close the stream, discard any temporary backing storage.
- command close
- parameters
- # Handle of the stream to close.
- StreamHandle handle
- # Read a chunk of the stream
- command read
- parameters
- # Handle of the stream to read.
- StreamHandle handle
- # Seek to the specified offset before reading (if not specificed, proceed with offset
- # following the last read). Some types of streams may only support sequential reads.
- optional integer offset
- # Maximum number of bytes to read (left upon the agent discretion if not specified).
- optional integer size
- returns
- # Set if the data is base64-encoded
- optional boolean base64Encoded
- # Data that were read.
- string data
- # Set if the end-of-file condition occurred while reading.
- boolean eof
- # Return UUID of Blob object specified by a remote object id.
- command resolveBlob
- parameters
- # Object id of a Blob object wrapper.
- Runtime.RemoteObjectId objectId
- returns
- # UUID of the specified Blob.
- string uuid
- experimental domain IndexedDB
- depends on Runtime
- depends on Storage
- # Database with an array of object stores.
- type DatabaseWithObjectStores extends object
- properties
- # Database name.
- string name
- # Database version (type is not 'integer', as the standard
- # requires the version number to be 'unsigned long long')
- number version
- # Object stores in this database.
- array of ObjectStore objectStores
- # Object store.
- type ObjectStore extends object
- properties
- # Object store name.
- string name
- # Object store key path.
- KeyPath keyPath
- # If true, object store has auto increment flag set.
- boolean autoIncrement
- # Indexes in this object store.
- array of ObjectStoreIndex indexes
- # Object store index.
- type ObjectStoreIndex extends object
- properties
- # Index name.
- string name
- # Index key path.
- KeyPath keyPath
- # If true, index is unique.
- boolean unique
- # If true, index allows multiple entries for a key.
- boolean multiEntry
- # Key.
- type Key extends object
- properties
- # Key type.
- enum type
- number
- string
- date
- array
- # Number value.
- optional number number
- # String value.
- optional string string
- # Date value.
- optional number date
- # Array value.
- optional array of Key array
- # Key range.
- type KeyRange extends object
- properties
- # Lower bound.
- optional Key lower
- # Upper bound.
- optional Key upper
- # If true lower bound is open.
- boolean lowerOpen
- # If true upper bound is open.
- boolean upperOpen
- # Data entry.
- type DataEntry extends object
- properties
- # Key object.
- Runtime.RemoteObject key
- # Primary key object.
- Runtime.RemoteObject primaryKey
- # Value object.
- Runtime.RemoteObject value
- # Key path.
- type KeyPath extends object
- properties
- # Key path type.
- enum type
- null
- string
- array
- # String value.
- optional string string
- # Array value.
- optional array of string array
- # Clears all entries from an object store.
- command clearObjectStore
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- # Database name.
- string databaseName
- # Object store name.
- string objectStoreName
- # Deletes a database.
- command deleteDatabase
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- # Database name.
- string databaseName
- # Delete a range of entries from an object store
- command deleteObjectStoreEntries
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- string databaseName
- string objectStoreName
- # Range of entry keys to delete
- KeyRange keyRange
- # Disables events from backend.
- command disable
- # Enables events from backend.
- command enable
- # Requests data from object store or index.
- command requestData
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- # Database name.
- string databaseName
- # Object store name.
- string objectStoreName
- # Index name, empty string for object store data requests.
- string indexName
- # Number of records to skip.
- integer skipCount
- # Number of records to fetch.
- integer pageSize
- # Key range.
- optional KeyRange keyRange
- returns
- # Array of object store data entries.
- array of DataEntry objectStoreDataEntries
- # If true, there are more entries to fetch in the given range.
- boolean hasMore
- # Gets metadata of an object store.
- command getMetadata
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- # Database name.
- string databaseName
- # Object store name.
- string objectStoreName
- returns
- # the entries count
- number entriesCount
- # the current value of key generator, to become the next inserted
- # key into the object store. Valid if objectStore.autoIncrement
- # is true.
- number keyGeneratorValue
- # Requests database with given name in given frame.
- command requestDatabase
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- # Database name.
- string databaseName
- returns
- # Database with an array of object stores.
- DatabaseWithObjectStores databaseWithObjectStores
- # Requests database names for given security origin.
- command requestDatabaseNames
- parameters
- # At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
- # Security origin.
- optional string securityOrigin
- # Storage key.
- optional string storageKey
- # Storage bucket. If not specified, it uses the default bucket.
- optional Storage.StorageBucket storageBucket
- returns
- # Database names for origin.
- array of string databaseNames
- domain Input
- type TouchPoint extends object
- properties
- # X coordinate of the event relative to the main frame's viewport in CSS pixels.
- number x
- # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
- # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
- number y
- # X radius of the touch area (default: 1.0).
- optional number radiusX
- # Y radius of the touch area (default: 1.0).
- optional number radiusY
- # Rotation angle (default: 0.0).
- optional number rotationAngle
- # Force (default: 1.0).
- optional number force
- # The normalized tangential pressure, which has a range of [-1,1] (default: 0).
- experimental optional number tangentialPressure
- # The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
- experimental optional integer tiltX
- # The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
- experimental optional integer tiltY
- # The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
- experimental optional integer twist
- # Identifier used to track touch sources between events, must be unique within an event.
- optional number id
- experimental type GestureSourceType extends string
- enum
- default
- touch
- mouse
- type MouseButton extends string
- enum
- none
- left
- middle
- right
- back
- forward
- # UTC time in seconds, counted from January 1, 1970.
- type TimeSinceEpoch extends number
- experimental type DragDataItem extends object
- properties
- # Mime type of the dragged data.
- string mimeType
- # Depending of the value of `mimeType`, it contains the dragged link,
- # text, HTML markup or any other data.
- string data
- # Title associated with a link. Only valid when `mimeType` == "text/uri-list".
- optional string title
- # Stores the base URL for the contained markup. Only valid when `mimeType`
- # == "text/html".
- optional string baseURL
- experimental type DragData extends object
- properties
- array of DragDataItem items
- # List of filenames that should be included when dropping
- optional array of string files
- # Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16
- integer dragOperationsMask
- # Dispatches a drag event into the page.
- experimental command dispatchDragEvent
- parameters
- # Type of the drag event.
- enum type
- dragEnter
- dragOver
- drop
- dragCancel
- # X coordinate of the event relative to the main frame's viewport in CSS pixels.
- number x
- # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
- # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
- number y
- DragData data
- # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
- # (default: 0).
- optional integer modifiers
- # Dispatches a key event to the page.
- command dispatchKeyEvent
- parameters
- # Type of the key event.
- enum type
- keyDown
- keyUp
- rawKeyDown
- char
- # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
- # (default: 0).
- optional integer modifiers
- # Time at which the event occurred.
- optional TimeSinceEpoch timestamp
- # Text as generated by processing a virtual key code with a keyboard layout. Not needed for
- # for `keyUp` and `rawKeyDown` events (default: "")
- optional string text
- # Text that would have been generated by the keyboard if no modifiers were pressed (except for
- # shift). Useful for shortcut (accelerator) key handling (default: "").
- optional string unmodifiedText
- # Unique key identifier (e.g., 'U+0041') (default: "").
- optional string keyIdentifier
- # Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
- optional string code
- # Unique DOM defined string value describing the meaning of the key in the context of active
- # modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
- optional string key
- # Windows virtual key code (default: 0).
- optional integer windowsVirtualKeyCode
- # Native virtual key code (default: 0).
- optional integer nativeVirtualKeyCode
- # Whether the event was generated from auto repeat (default: false).
- optional boolean autoRepeat
- # Whether the event was generated from the keypad (default: false).
- optional boolean isKeypad
- # Whether the event was a system key event (default: false).
- optional boolean isSystemKey
- # Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
- # 0).
- optional integer location
- # Editing commands to send with the key event (e.g., 'selectAll') (default: []).
- # These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
- # See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
- experimental optional array of string commands
- # This method emulates inserting text that doesn't come from a key press,
- # for example an emoji keyboard or an IME.
- experimental command insertText
- parameters
- # The text to insert.
- string text
- # This method sets the current candidate text for ime.
- # Use imeCommitComposition to commit the final text.
- # Use imeSetComposition with empty string as text to cancel composition.
- experimental command imeSetComposition
- parameters
- # The text to insert
- string text
- # selection start
- integer selectionStart
- # selection end
- integer selectionEnd
- # replacement start
- optional integer replacementStart
- # replacement end
- optional integer replacementEnd
- # Dispatches a mouse event to the page.
- command dispatchMouseEvent
- parameters
- # Type of the mouse event.
- enum type
- mousePressed
- mouseReleased
- mouseMoved
- mouseWheel
- # X coordinate of the event relative to the main frame's viewport in CSS pixels.
- number x
- # Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
- # the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
- number y
- # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
- # (default: 0).
- optional integer modifiers
- # Time at which the event occurred.
- optional TimeSinceEpoch timestamp
- # Mouse button (default: "none").
- optional MouseButton button
- # A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
- # Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
- optional integer buttons
- # Number of times the mouse button was clicked (default: 0).
- optional integer clickCount
- # The normalized pressure, which has a range of [0,1] (default: 0).
- experimental optional number force
- # The normalized tangential pressure, which has a range of [-1,1] (default: 0).
- experimental optional number tangentialPressure
- # The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
- experimental optional integer tiltX
- # The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
- experimental optional integer tiltY
- # The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
- experimental optional integer twist
- # X delta in CSS pixels for mouse wheel event (default: 0).
- optional number deltaX
- # Y delta in CSS pixels for mouse wheel event (default: 0).
- optional number deltaY
- # Pointer type (default: "mouse").
- optional enum pointerType
- mouse
- pen
- # Dispatches a touch event to the page.
- command dispatchTouchEvent
- parameters
- # Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
- # TouchStart and TouchMove must contains at least one.
- enum type
- touchStart
- touchEnd
- touchMove
- touchCancel
- # Active touch points on the touch device. One event per any changed point (compared to
- # previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
- # one by one.
- array of TouchPoint touchPoints
- # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
- # (default: 0).
- optional integer modifiers
- # Time at which the event occurred.
- optional TimeSinceEpoch timestamp
- # Emulates touch event from the mouse event parameters.
- experimental command emulateTouchFromMouseEvent
- parameters
- # Type of the mouse event.
- enum type
- mousePressed
- mouseReleased
- mouseMoved
- mouseWheel
- # X coordinate of the mouse pointer in DIP.
- integer x
- # Y coordinate of the mouse pointer in DIP.
- integer y
- # Mouse button. Only "none", "left", "right" are supported.
- MouseButton button
- # Time at which the event occurred (default: current time).
- optional TimeSinceEpoch timestamp
- # X delta in DIP for mouse wheel event (default: 0).
- optional number deltaX
- # Y delta in DIP for mouse wheel event (default: 0).
- optional number deltaY
- # Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
- # (default: 0).
- optional integer modifiers
- # Number of times the mouse button was clicked (default: 0).
- optional integer clickCount
- # Ignores input events (useful while auditing page).
- command setIgnoreInputEvents
- parameters
- # Ignores input events processing when set to true.
- boolean ignore
- # Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
- # Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
- experimental command setInterceptDrags
- parameters
- boolean enabled
- # Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
- experimental command synthesizePinchGesture
- parameters
- # X coordinate of the start of the gesture in CSS pixels.
- number x
- # Y coordinate of the start of the gesture in CSS pixels.
- number y
- # Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
- number scaleFactor
- # Relative pointer speed in pixels per second (default: 800).
- optional integer relativeSpeed
- # Which type of input events to be generated (default: 'default', which queries the platform
- # for the preferred input type).
- optional GestureSourceType gestureSourceType
- # Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
- experimental command synthesizeScrollGesture
- parameters
- # X coordinate of the start of the gesture in CSS pixels.
- number x
- # Y coordinate of the start of the gesture in CSS pixels.
- number y
- # The distance to scroll along the X axis (positive to scroll left).
- optional number xDistance
- # The distance to scroll along the Y axis (positive to scroll up).
- optional number yDistance
- # The number of additional pixels to scroll back along the X axis, in addition to the given
- # distance.
- optional number xOverscroll
- # The number of additional pixels to scroll back along the Y axis, in addition to the given
- # distance.
- optional number yOverscroll
- # Prevent fling (default: true).
- optional boolean preventFling
- # Swipe speed in pixels per second (default: 800).
- optional integer speed
- # Which type of input events to be generated (default: 'default', which queries the platform
- # for the preferred input type).
- optional GestureSourceType gestureSourceType
- # The number of times to repeat the gesture (default: 0).
- optional integer repeatCount
- # The number of milliseconds delay between each repeat. (default: 250).
- optional integer repeatDelayMs
- # The name of the interaction markers to generate, if not empty (default: "").
- optional string interactionMarkerName
- # Synthesizes a tap gesture over a time period by issuing appropriate touch events.
- experimental command synthesizeTapGesture
- parameters
- # X coordinate of the start of the gesture in CSS pixels.
- number x
- # Y coordinate of the start of the gesture in CSS pixels.
- number y
- # Duration between touchdown and touchup events in ms (default: 50).
- optional integer duration
- # Number of times to perform the tap (e.g. 2 for double tap, default: 1).
- optional integer tapCount
- # Which type of input events to be generated (default: 'default', which queries the platform
- # for the preferred input type).
- optional GestureSourceType gestureSourceType
- # Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to
- # restore normal drag and drop behavior.
- experimental event dragIntercepted
- parameters
- DragData data
- experimental domain Inspector
- # Disables inspector domain notifications.
- command disable
- # Enables inspector domain notifications.
- command enable
- # Fired when remote debugging connection is about to be terminated. Contains detach reason.
- event detached
- parameters
- # The reason why connection has been terminated.
- string reason
- # Fired when debugging target has crashed
- event targetCrashed
- # Fired when debugging target has reloaded after crash
- event targetReloadedAfterCrash
- experimental domain LayerTree
- depends on DOM
- # Unique Layer identifier.
- type LayerId extends string
- # Unique snapshot identifier.
- type SnapshotId extends string
- # Rectangle where scrolling happens on the main thread.
- type ScrollRect extends object
- properties
- # Rectangle itself.
- DOM.Rect rect
- # Reason for rectangle to force scrolling on the main thread
- enum type
- RepaintsOnScroll
- TouchEventHandler
- WheelEventHandler
- # Sticky position constraints.
- type StickyPositionConstraint extends object
- properties
- # Layout rectangle of the sticky element before being shifted
- DOM.Rect stickyBoxRect
- # Layout rectangle of the containing block of the sticky element
- DOM.Rect containingBlockRect
- # The nearest sticky layer that shifts the sticky box
- optional LayerId nearestLayerShiftingStickyBox
- # The nearest sticky layer that shifts the containing block
- optional LayerId nearestLayerShiftingContainingBlock
- # Serialized fragment of layer picture along with its offset within the layer.
- type PictureTile extends object
- properties
- # Offset from owning layer left boundary
- number x
- # Offset from owning layer top boundary
- number y
- # Base64-encoded snapshot data.
- binary picture
- # Information about a compositing layer.
- type Layer extends object
- properties
- # The unique id for this layer.
- LayerId layerId
- # The id of parent (not present for root).
- optional LayerId parentLayerId
- # The backend id for the node associated with this layer.
- optional DOM.BackendNodeId backendNodeId
- # Offset from parent layer, X coordinate.
- number offsetX
- # Offset from parent layer, Y coordinate.
- number offsetY
- # Layer width.
- number width
- # Layer height.
- number height
- # Transformation matrix for layer, default is identity matrix
- optional array of number transform
- # Transform anchor point X, absent if no transform specified
- optional number anchorX
- # Transform anchor point Y, absent if no transform specified
- optional number anchorY
- # Transform anchor point Z, absent if no transform specified
- optional number anchorZ
- # Indicates how many time this layer has painted.
- integer paintCount
- # Indicates whether this layer hosts any content, rather than being used for
- # transform/scrolling purposes only.
- boolean drawsContent
- # Set if layer is not visible.
- optional boolean invisible
- # Rectangles scrolling on main thread only.
- optional array of ScrollRect scrollRects
- # Sticky position constraint information
- optional StickyPositionConstraint stickyPositionConstraint
- # Array of timings, one per paint step.
- type PaintProfile extends array of number
- # Provides the reasons why the given layer was composited.
- command compositingReasons
- parameters
- # The id of the layer for which we want to get the reasons it was composited.
- LayerId layerId
- returns
- # A list of strings specifying reasons for the given layer to become composited.
- array of string compositingReasons
- # A list of strings specifying reason IDs for the given layer to become composited.
- array of string compositingReasonIds
- # Disables compositing tree inspection.
- command disable
- # Enables compositing tree inspection.
- command enable
- # Returns the snapshot identifier.
- command loadSnapshot
- parameters
- # An array of tiles composing the snapshot.
- array of PictureTile tiles
- returns
- # The id of the snapshot.
- SnapshotId snapshotId
- # Returns the layer snapshot identifier.
- command makeSnapshot
- parameters
- # The id of the layer.
- LayerId layerId
- returns
- # The id of the layer snapshot.
- SnapshotId snapshotId
- command profileSnapshot
- parameters
- # The id of the layer snapshot.
- SnapshotId snapshotId
- # The maximum number of times to replay the snapshot (1, if not specified).
- optional integer minRepeatCount
- # The minimum duration (in seconds) to replay the snapshot.
- optional number minDuration
- # The clip rectangle to apply when replaying the snapshot.
- optional DOM.Rect clipRect
- returns
- # The array of paint profiles, one per run.
- array of PaintProfile timings
- # Releases layer snapshot captured by the back-end.
- command releaseSnapshot
- parameters
- # The id of the layer snapshot.
- SnapshotId snapshotId
- # Replays the layer snapshot and returns the resulting bitmap.
- command replaySnapshot
- parameters
- # The id of the layer snapshot.
- SnapshotId snapshotId
- # The first step to replay from (replay from the very start if not specified).
- optional integer fromStep
- # The last step to replay to (replay till the end if not specified).
- optional integer toStep
- # The scale to apply while replaying (defaults to 1).
- optional number scale
- returns
- # A data: URL for resulting image.
- string dataURL
- # Replays the layer snapshot and returns canvas log.
- command snapshotCommandLog
- parameters
- # The id of the layer snapshot.
- SnapshotId snapshotId
- returns
- # The array of canvas function calls.
- array of object commandLog
- event layerPainted
- parameters
- # The id of the painted layer.
- LayerId layerId
- # Clip rectangle.
- DOM.Rect clip
- event layerTreeDidChange
- parameters
- # Layer tree, absent if not in the comspositing mode.
- optional array of Layer layers
- # Provides access to log entries.
- domain Log
- depends on Runtime
- depends on Network
- # Log entry.
- type LogEntry extends object
- properties
- # Log entry source.
- enum source
- xml
- javascript
- network
- storage
- appcache
- rendering
- security
- deprecation
- worker
- violation
- intervention
- recommendation
- other
- # Log entry severity.
- enum level
- verbose
- info
- warning
- error
- # Logged text.
- string text
- optional enum category
- cors
- # Timestamp when this entry was added.
- Runtime.Timestamp timestamp
- # URL of the resource if known.
- optional string url
- # Line number in the resource.
- optional integer lineNumber
- # JavaScript stack trace.
- optional Runtime.StackTrace stackTrace
- # Identifier of the network request associated with this entry.
- optional Network.RequestId networkRequestId
- # Identifier of the worker associated with this entry.
- optional string workerId
- # Call arguments.
- optional array of Runtime.RemoteObject args
- # Violation configuration setting.
- type ViolationSetting extends object
- properties
- # Violation type.
- enum name
- longTask
- longLayout
- blockedEvent
- blockedParser
- discouragedAPIUse
- handler
- recurringHandler
- # Time threshold to trigger upon.
- number threshold
- # Clears the log.
- command clear
- # Disables log domain, prevents further log entries from being reported to the client.
- command disable
- # Enables log domain, sends the entries collected so far to the client by means of the
- # `entryAdded` notification.
- command enable
- # start violation reporting.
- command startViolationsReport
- parameters
- # Configuration for violations.
- array of ViolationSetting config
- # Stop violation reporting.
- command stopViolationsReport
- # Issued when new message was logged.
- event entryAdded
- parameters
- # The entry.
- LogEntry entry
- experimental domain Memory
- # Memory pressure level.
- type PressureLevel extends string
- enum
- moderate
- critical
- command getDOMCounters
- returns
- integer documents
- integer nodes
- integer jsEventListeners
- command prepareForLeakDetection
- # Simulate OomIntervention by purging V8 memory.
- command forciblyPurgeJavaScriptMemory
- # Enable/disable suppressing memory pressure notifications in all processes.
- command setPressureNotificationsSuppressed
- parameters
- # If true, memory pressure notifications will be suppressed.
- boolean suppressed
- # Simulate a memory pressure notification in all processes.
- command simulatePressureNotification
- parameters
- # Memory pressure level of the notification.
- PressureLevel level
- # Start collecting native memory profile.
- command startSampling
- parameters
- # Average number of bytes between samples.
- optional integer samplingInterval
- # Do not randomize intervals between samples.
- optional boolean suppressRandomness
- # Stop collecting native memory profile.
- command stopSampling
- # Retrieve native memory allocations profile
- # collected since renderer process startup.
- command getAllTimeSamplingProfile
- returns
- SamplingProfile profile
- # Retrieve native memory allocations profile
- # collected since browser process startup.
- command getBrowserSamplingProfile
- returns
- SamplingProfile profile
- # Retrieve native memory allocations profile collected since last
- # `startSampling` call.
- command getSamplingProfile
- returns
- SamplingProfile profile
- # Heap profile sample.
- type SamplingProfileNode extends object
- properties
- # Size of the sampled allocation.
- number size
- # Total bytes attributed to this sample.
- number total
- # Execution stack at the point of allocation.
- array of string stack
- # Array of heap profile samples.
- type SamplingProfile extends object
- properties
- array of SamplingProfileNode samples
- array of Module modules
- # Executable module information
- type Module extends object
- properties
- # Name of the module.
- string name
- # UUID of the module.
- string uuid
- # Base address where the module is loaded into memory. Encoded as a decimal
- # or hexadecimal (0x prefixed) string.
- string baseAddress
- # Size of the module in bytes.
- number size
- # Network domain allows tracking network activities of the page. It exposes information about http,
- # file, data and other requests and responses, their headers, bodies, timing, etc.
- domain Network
- depends on Debugger
- depends on Runtime
- depends on Security
- # Resource type as it was perceived by the rendering engine.
- type ResourceType extends string
- enum
- Document
- Stylesheet
- Image
- Media
- Font
- Script
- TextTrack
- XHR
- Fetch
- Prefetch
- EventSource
- WebSocket
- Manifest
- SignedExchange
- Ping
- CSPViolationReport
- Preflight
- Other
- # Unique loader identifier.
- type LoaderId extends string
- # Unique request identifier.
- type RequestId extends string
- # Unique intercepted request identifier.
- type InterceptionId extends string
- # Network level fetch failure reason.
- type ErrorReason extends string
- enum
- Failed
- Aborted
- TimedOut
- AccessDenied
- ConnectionClosed
- ConnectionReset
- ConnectionRefused
- ConnectionAborted
- ConnectionFailed
- NameNotResolved
- InternetDisconnected
- AddressUnreachable
- BlockedByClient
- BlockedByResponse
- # UTC time in seconds, counted from January 1, 1970.
- type TimeSinceEpoch extends number
- # Monotonically increasing time in seconds since an arbitrary point in the past.
- type MonotonicTime extends number
- # Request / response headers as keys / values of JSON object.
- type Headers extends object
- # The underlying connection technology that the browser is supposedly using.
- type ConnectionType extends string
- enum
- none
- cellular2g
- cellular3g
- cellular4g
- bluetooth
- ethernet
- wifi
- wimax
- other
- # Represents the cookie's 'SameSite' status:
- # https://tools.ietf.org/html/draft-west-first-party-cookies
- type CookieSameSite extends string
- enum
- Strict
- Lax
- None
- # Represents the cookie's 'Priority' status:
- # https://tools.ietf.org/html/draft-west-cookie-priority-00
- experimental type CookiePriority extends string
- enum
- Low
- Medium
- High
- # Represents the source scheme of the origin that originally set the cookie.
- # A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme.
- # This is a temporary ability and it will be removed in the future.
- experimental type CookieSourceScheme extends string
- enum
- Unset
- NonSecure
- Secure
- # Timing information for the request.
- type ResourceTiming extends object
- properties
- # Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
- # milliseconds relatively to this requestTime.
- number requestTime
- # Started resolving proxy.
- number proxyStart
- # Finished resolving proxy.
- number proxyEnd
- # Started DNS address resolve.
- number dnsStart
- # Finished DNS address resolve.
- number dnsEnd
- # Started connecting to the remote host.
- number connectStart
- # Connected to the remote host.
- number connectEnd
- # Started SSL handshake.
- number sslStart
- # Finished SSL handshake.
- number sslEnd
- # Started running ServiceWorker.
- experimental number workerStart
- # Finished Starting ServiceWorker.
- experimental number workerReady
- # Started fetch event.
- experimental number workerFetchStart
- # Settled fetch event respondWith promise.
- experimental number workerRespondWithSettled
- # Started sending request.
- number sendStart
- # Finished sending request.
- number sendEnd
- # Time the server started pushing request.
- experimental number pushStart
- # Time the server finished pushing request.
- experimental number pushEnd
- # Finished receiving response headers.
- number receiveHeadersEnd
- # Loading priority of a resource request.
- type ResourcePriority extends string
- enum
- VeryLow
- Low
- Medium
- High
- VeryHigh
- # Post data entry for HTTP request
- type PostDataEntry extends object
- properties
- optional binary bytes
- # HTTP request data.
- type Request extends object
- properties
- # Request URL (without fragment).
- string url
- # Fragment of the requested URL starting with hash, if present.
- optional string urlFragment
- # HTTP request method.
- string method
- # HTTP request headers.
- Headers headers
- # HTTP POST request data.
- optional string postData
- # 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.
- optional boolean hasPostData
- # Request body elements. This will be converted from base64 to binary
- experimental optional array of PostDataEntry postDataEntries
- # The mixed content type of the request.
- optional Security.MixedContentType mixedContentType
- # Priority of the resource request at the time request is sent.
- ResourcePriority initialPriority
- # The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
- enum referrerPolicy
- unsafe-url
- no-referrer-when-downgrade
- no-referrer
- origin
- origin-when-cross-origin
- same-origin
- strict-origin
- strict-origin-when-cross-origin
- # Whether is loaded via link preload.
- optional boolean isLinkPreload
- # Set for requests when the TrustToken API is used. Contains the parameters
- # passed by the developer (e.g. via "fetch") as understood by the backend.
- experimental optional TrustTokenParams trustTokenParams
- # True if this resource request is considered to be the 'same site' as the
- # request correspondinfg to the main frame.
- experimental optional boolean isSameSite
- # Details of a signed certificate timestamp (SCT).
- type SignedCertificateTimestamp extends object
- properties
- # Validation status.
- string status
- # Origin.
- string origin
- # Log name / description.
- string logDescription
- # Log ID.
- string logId
- # Issuance date. Unlike TimeSinceEpoch, this contains the number of
- # milliseconds since January 1, 1970, UTC, not the number of seconds.
- number timestamp
- # Hash algorithm.
- string hashAlgorithm
- # Signature algorithm.
- string signatureAlgorithm
- # Signature data.
- string signatureData
- # Security details about a request.
- type SecurityDetails extends object
- properties
- # Protocol name (e.g. "TLS 1.2" or "QUIC").
- string protocol
- # Key Exchange used by the connection, or the empty string if not applicable.
- string keyExchange
- # (EC)DH group used by the connection, if applicable.
- optional string keyExchangeGroup
- # Cipher name.
- string cipher
- # TLS MAC. Note that AEAD ciphers do not have separate MACs.
- optional string mac
- # Certificate ID value.
- Security.CertificateId certificateId
- # Certificate subject name.
- string subjectName
- # Subject Alternative Name (SAN) DNS names and IP addresses.
- array of string sanList
- # Name of the issuing CA.
- string issuer
- # Certificate valid from date.
- TimeSinceEpoch validFrom
- # Certificate valid to (expiration) date
- TimeSinceEpoch validTo
- # List of signed certificate timestamps (SCTs).
- array of SignedCertificateTimestamp signedCertificateTimestampList
- # Whether the request complied with Certificate Transparency policy
- CertificateTransparencyCompliance certificateTransparencyCompliance
- # The signature algorithm used by the server in the TLS server signature,
- # represented as a TLS SignatureScheme code point. Omitted if not
- # applicable or not known.
- optional integer serverSignatureAlgorithm
- # Whether the connection used Encrypted ClientHello
- boolean encryptedClientHello
- # Whether the request complied with Certificate Transparency policy.
- type CertificateTransparencyCompliance extends string
- enum
- unknown
- not-compliant
- compliant
- # The reason why request was blocked.
- type BlockedReason extends string
- enum
- other
- csp
- mixed-content
- origin
- inspector
- subresource-filter
- content-type
- coep-frame-resource-needs-coep-header
- coop-sandboxed-iframe-cannot-navigate-to-coop-page
- corp-not-same-origin
- corp-not-same-origin-after-defaulted-to-same-origin-by-coep
- corp-not-same-site
- # The reason why request was blocked.
- type CorsError extends string
- enum
- DisallowedByMode
- InvalidResponse
- WildcardOriginNotAllowed
- MissingAllowOriginHeader
- MultipleAllowOriginValues
- InvalidAllowOriginValue
- AllowOriginMismatch
- InvalidAllowCredentials
- CorsDisabledScheme
- PreflightInvalidStatus
- PreflightDisallowedRedirect
- PreflightWildcardOriginNotAllowed
- PreflightMissingAllowOriginHeader
- PreflightMultipleAllowOriginValues
- PreflightInvalidAllowOriginValue
- PreflightAllowOriginMismatch
- PreflightInvalidAllowCredentials
- # TODO(https://crbug.com/1263483): Remove this once frontend code does
- # not reference it anymore.
- PreflightMissingAllowExternal
- # TODO(https://crbug.com/1263483): Remove this once frontend code does
- # not reference it anymore.
- PreflightInvalidAllowExternal
- PreflightMissingAllowPrivateNetwork
- PreflightInvalidAllowPrivateNetwork
- InvalidAllowMethodsPreflightResponse
- InvalidAllowHeadersPreflightResponse
- MethodDisallowedByPreflightResponse
- HeaderDisallowedByPreflightResponse
- RedirectContainsCredentials
- # Request was a private network request initiated by a non-secure context.
- InsecurePrivateNetwork
- # Request carried a target IP address space property that did not match
- # the target resource's address space.
- InvalidPrivateNetworkAccess
- # Request was a private network request yet did not carry a target IP
- # address space.
- UnexpectedPrivateNetworkAccess
- NoCorsRedirectModeNotFollow
- type CorsErrorStatus extends object
- properties
- CorsError corsError
- string failedParameter
- # Source of serviceworker response.
- type ServiceWorkerResponseSource extends string
- enum
- cache-storage
- http-cache
- fallback-code
- network
- # Determines what type of Trust Token operation is executed and
- # depending on the type, some additional parameters. The values
- # are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
- experimental type TrustTokenParams extends object
- properties
- TrustTokenOperationType operation
- # Only set for "token-redemption" operation and determine whether
- # to request a fresh SRR or use a still valid cached SRR.
- enum refreshPolicy
- UseCached
- Refresh
- # Origins of issuers from whom to request tokens or redemption
- # records.
- optional array of string issuers
- experimental type TrustTokenOperationType extends string
- enum
- # Type "token-request" in the Trust Token API.
- Issuance
- # Type "token-redemption" in the Trust Token API.
- Redemption
- # Type "send-redemption-record" in the Trust Token API.
- Signing
- # The reason why Chrome uses a specific transport protocol for HTTP semantics.
- experimental type AlternateProtocolUsage extends string
- enum
- # Alternate Protocol was used without racing a normal connection.
- alternativeJobWonWithoutRace
- # Alternate Protocol was used by winning a race with a normal connection.
- alternativeJobWonRace
- # Alternate Protocol was not used by losing a race with a normal connection.
- mainJobWonRace
- # Alternate Protocol was not used because no Alternate-Protocol information
- # was available when the request was issued, but an Alternate-Protocol header
- # was present in the response.
- mappingMissing
- # Alternate Protocol was not used because it was marked broken.
- broken
- # HTTPS DNS protocol upgrade job was used without racing with a normal
- # connection and an Alternate Protocol job.
- dnsAlpnH3JobWonWithoutRace
- # HTTPS DNS protocol upgrade job won a race with a normal connection and
- # an Alternate Protocol job.
- dnsAlpnH3JobWonRace
- # This value is used when the reason is unknown.
- unspecifiedReason
- # HTTP response data.
- type Response extends object
- properties
- # Response URL. This URL can be different from CachedResource.url in case of redirect.
- string url
- # HTTP response status code.
- integer status
- # HTTP response status text.
- string statusText
- # HTTP response headers.
- Headers headers
- # HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.
- deprecated optional string headersText
- # Resource mimeType as determined by the browser.
- string mimeType
- # Refined HTTP request headers that were actually transmitted over the network.
- optional Headers requestHeaders
- # HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.
- deprecated optional string requestHeadersText
- # Specifies whether physical connection was actually reused for this request.
- boolean connectionReused
- # Physical connection id that was actually used for this request.
- number connectionId
- # Remote IP address.
- optional string remoteIPAddress
- # Remote port.
- optional integer remotePort
- # Specifies that the request was served from the disk cache.
- optional boolean fromDiskCache
- # Specifies that the request was served from the ServiceWorker.
- optional boolean fromServiceWorker
- # Specifies that the request was served from the prefetch cache.
- optional boolean fromPrefetchCache
- # Total number of bytes received for this request so far.
- number encodedDataLength
- # Timing information for the given request.
- optional ResourceTiming timing
- # Response source of response from ServiceWorker.
- optional ServiceWorkerResponseSource serviceWorkerResponseSource
- # The time at which the returned response was generated.
- optional TimeSinceEpoch responseTime
- # Cache Storage Cache Name.
- optional string cacheStorageCacheName
- # Protocol used to fetch this request.
- optional string protocol
- # The reason why Chrome uses a specific transport protocol for HTTP semantics.
- experimental optional AlternateProtocolUsage alternateProtocolUsage
- # Security state of the request resource.
- Security.SecurityState securityState
- # Security details for the request.
- optional SecurityDetails securityDetails
- # WebSocket request data.
- type WebSocketRequest extends object
- properties
- # HTTP request headers.
- Headers headers
- # WebSocket response data.
- type WebSocketResponse extends object
- properties
- # HTTP response status code.
- integer status
- # HTTP response status text.
- string statusText
- # HTTP response headers.
- Headers headers
- # HTTP response headers text.
- optional string headersText
- # HTTP request headers.
- optional Headers requestHeaders
- # HTTP request headers text.
- optional string requestHeadersText
- # WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
- type WebSocketFrame extends object
- properties
- # WebSocket message opcode.
- number opcode
- # WebSocket message mask.
- boolean mask
- # WebSocket message payload data.
- # If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
- # If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
- string payloadData
- # Information about the cached resource.
- type CachedResource extends object
- properties
- # Resource URL. This is the url of the original network request.
- string url
- # Type of this resource.
- ResourceType type
- # Cached response data.
- optional Response response
- # Cached response body size.
- number bodySize
- # Information about the request initiator.
- type Initiator extends object
- properties
- # Type of this initiator.
- enum type
- parser
- script
- preload
- SignedExchange
- preflight
- other
- # Initiator JavaScript stack trace, set for Script only.
- optional Runtime.StackTrace stack
- # Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
- optional string url
- # Initiator line number, set for Parser type or for Script type (when script is importing
- # module) (0-based).
- optional number lineNumber
- # Initiator column number, set for Parser type or for Script type (when script is importing
- # module) (0-based).
- optional number columnNumber
- # Set if another request triggered this request (e.g. preflight).
- optional RequestId requestId
- # Cookie object
- type Cookie extends object
- properties
- # Cookie name.
- string name
- # Cookie value.
- string value
- # Cookie domain.
- string domain
- # Cookie path.
- string path
- # Cookie expiration date as the number of seconds since the UNIX epoch.
- number expires
- # Cookie size.
- integer size
- # True if cookie is http-only.
- boolean httpOnly
- # True if cookie is secure.
- boolean secure
- # True in case of session cookie.
- boolean session
- # Cookie SameSite type.
- optional CookieSameSite sameSite
- # Cookie Priority
- experimental CookiePriority priority
- # True if cookie is SameParty.
- experimental boolean sameParty
- # Cookie source scheme type.
- experimental CookieSourceScheme sourceScheme
- # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
- # An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
- # This is a temporary ability and it will be removed in the future.
- experimental integer sourcePort
- # Cookie partition key. The site of the top-level URL the browser was visiting at the start
- # of the request to the endpoint that set the cookie.
- experimental optional string partitionKey
- # True if cookie partition key is opaque.
- experimental optional boolean partitionKeyOpaque
- # Types of reasons why a cookie may not be stored from a response.
- experimental type SetCookieBlockedReason extends string
- enum
- # The cookie had the "Secure" attribute but was not received over a secure connection.
- SecureOnly
- # The cookie had the "SameSite=Strict" attribute but came from a cross-origin response.
- # This includes navigation requests intitiated by other origins.
- SameSiteStrict
- # The cookie had the "SameSite=Lax" attribute but came from a cross-origin response.
- SameSiteLax
- # The cookie didn't specify a "SameSite" attribute and was defaulted to "SameSite=Lax" and
- # broke the same rules specified in the SameSiteLax value.
- SameSiteUnspecifiedTreatedAsLax
- # The cookie had the "SameSite=None" attribute but did not specify the "Secure" attribute,
- # which is required in order to use "SameSite=None".
- SameSiteNoneInsecure
- # The cookie was not stored due to user preferences.
- UserPreferences
- # The cookie was blocked by third-party cookie blocking between sites in
- # the same First-Party Set.
- ThirdPartyBlockedInFirstPartySet
- # The syntax of the Set-Cookie header of the response was invalid.
- SyntaxError
- # The scheme of the connection is not allowed to store cookies.
- SchemeNotSupported
- # The cookie was not sent over a secure connection and would have overwritten a cookie with
- # the Secure attribute.
- OverwriteSecure
- # The cookie's domain attribute was invalid with regards to the current host url.
- InvalidDomain
- # The cookie used the "__Secure-" or "__Host-" prefix in its name and broke the additional
- # rules applied to cookies with these prefixes as defined in
- # https://tools.ietf.org/html/draft-west-cookie-prefixes-05
- InvalidPrefix
- # An unknown error was encountered when trying to store this cookie.
- UnknownError
- # The cookie had the "SameSite=Strict" attribute but came from a response
- # with the same registrable domain but a different scheme.
- # This includes navigation requests intitiated by other origins.
- # This is the "Schemeful Same-Site" version of the blocked reason.
- SchemefulSameSiteStrict
- # The cookie had the "SameSite=Lax" attribute but came from a response
- # with the same registrable domain but a different scheme.
- # This is the "Schemeful Same-Site" version of the blocked reason.
- SchemefulSameSiteLax
- # The cookie didn't specify a "SameSite" attribute and was defaulted to
- # "SameSite=Lax" and broke the same rules specified in the SchemefulSameSiteLax
- # value.
- # This is the "Schemeful Same-Site" version of the blocked reason.
- SchemefulSameSiteUnspecifiedTreatedAsLax
- # The cookie had the "SameParty" attribute but came from a cross-party response.
- SamePartyFromCrossPartyContext
- # The cookie had the "SameParty" attribute but did not specify the "Secure" attribute
- # (which is required in order to use "SameParty"); or specified the "SameSite=Strict"
- # attribute (which is forbidden when using "SameParty").
- SamePartyConflictsWithOtherAttributes
- # The cookie's name/value pair size exceeded the size limit defined in
- # RFC6265bis.
- NameValuePairExceedsMaxSize
- # Types of reasons why a cookie may not be sent with a request.
- experimental type CookieBlockedReason extends string
- enum
- # The cookie had the "Secure" attribute and the connection was not secure.
- SecureOnly
- # The cookie's path was not within the request url's path.
- NotOnPath
- # The cookie's domain is not configured to match the request url's domain, even though they
- # share a common TLD+1 (TLD+1 of foo.bar.example.com is example.com).
- DomainMismatch
- # The cookie had the "SameSite=Strict" attribute and the request was made on on a different
- # site. This includes navigation requests initiated by other sites.
- SameSiteStrict
- # The cookie had the "SameSite=Lax" attribute and the request was made on a different site.
- # This does not include navigation requests initiated by other sites.
- SameSiteLax
- # The cookie didn't specify a SameSite attribute when it was stored and was defaulted to
- # "SameSite=Lax" and broke the same rules specified in the SameSiteLax value. The cookie had
- # to have been set with "SameSite=None" to enable third-party usage.
- SameSiteUnspecifiedTreatedAsLax
- # The cookie had the "SameSite=None" attribute and the connection was not secure. Cookies
- # without SameSite restrictions must be sent over a secure connection.
- SameSiteNoneInsecure
- # The cookie was not sent due to user preferences.
- UserPreferences
- # The cookie was blocked by third-party cookie blocking between sites in
- # the same First-Party Set.
- ThirdPartyBlockedInFirstPartySet
- # An unknown error was encountered when trying to send this cookie.
- UnknownError
- # The cookie had the "SameSite=Strict" attribute but came from a response
- # with the same registrable domain but a different scheme.
- # This includes navigation requests intitiated by other origins.
- # This is the "Schemeful Same-Site" version of the blocked reason.
- SchemefulSameSiteStrict
- # The cookie had the "SameSite=Lax" attribute but came from a response
- # with the same registrable domain but a different scheme.
- # This is the "Schemeful Same-Site" version of the blocked reason.
- SchemefulSameSiteLax
- # The cookie didn't specify a "SameSite" attribute and was defaulted to
- # "SameSite=Lax" and broke the same rules specified in the SchemefulSameSiteLax
- # value.
- # This is the "Schemeful Same-Site" version of the blocked reason.
- SchemefulSameSiteUnspecifiedTreatedAsLax
- # The cookie had the "SameParty" attribute and the request was made from a cross-party context.
- SamePartyFromCrossPartyContext
- # The cookie's name/value pair size exceeded the size limit defined in
- # RFC6265bis.
- NameValuePairExceedsMaxSize
- # A cookie which was not stored from a response with the corresponding reason.
- experimental type BlockedSetCookieWithReason extends object
- properties
- # The reason(s) this cookie was blocked.
- array of SetCookieBlockedReason blockedReasons
- # The string representing this individual cookie as it would appear in the header.
- # This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
- string cookieLine
- # The cookie object which represents the cookie which was not stored. It is optional because
- # sometimes complete cookie information is not available, such as in the case of parsing
- # errors.
- optional Cookie cookie
- # A cookie with was not sent with a request with the corresponding reason.
- experimental type BlockedCookieWithReason extends object
- properties
- # The reason(s) the cookie was blocked.
- array of CookieBlockedReason blockedReasons
- # The cookie object representing the cookie which was not sent.
- Cookie cookie
- # Cookie parameter object
- type CookieParam extends object
- properties
- # Cookie name.
- string name
- # Cookie value.
- string value
- # The request-URI to associate with the setting of the cookie. This value can affect the
- # default domain, path, source port, and source scheme values of the created cookie.
- optional string url
- # Cookie domain.
- optional string domain
- # Cookie path.
- optional string path
- # True if cookie is secure.
- optional boolean secure
- # True if cookie is http-only.
- optional boolean httpOnly
- # Cookie SameSite type.
- optional CookieSameSite sameSite
- # Cookie expiration date, session cookie if not set
- optional TimeSinceEpoch expires
- # Cookie Priority.
- experimental optional CookiePriority priority
- # True if cookie is SameParty.
- experimental optional boolean sameParty
- # Cookie source scheme type.
- experimental optional CookieSourceScheme sourceScheme
- # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
- # An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
- # This is a temporary ability and it will be removed in the future.
- experimental optional integer sourcePort
- # Cookie partition key. The site of the top-level URL the browser was visiting at the start
- # of the request to the endpoint that set the cookie.
- # If not set, the cookie will be set as not partitioned.
- experimental optional string partitionKey
- # Authorization challenge for HTTP status code 401 or 407.
- experimental type AuthChallenge extends object
- properties
- # Source of the authentication challenge.
- optional enum source
- Server
- Proxy
- # Origin of the challenger.
- string origin
- # The authentication scheme used, such as basic or digest
- string scheme
- # The realm of the challenge. May be empty.
- string realm
- # Response to an AuthChallenge.
- experimental type AuthChallengeResponse extends object
- properties
- # The decision on what to do in response to the authorization challenge. Default means
- # deferring to the default behavior of the net stack, which will likely either the Cancel
- # authentication or display a popup dialog box.
- enum response
- Default
- CancelAuth
- ProvideCredentials
- # The username to provide, possibly empty. Should only be set if response is
- # ProvideCredentials.
- optional string username
- # The password to provide, possibly empty. Should only be set if response is
- # ProvideCredentials.
- optional string password
- # Stages of the interception to begin intercepting. Request will intercept before the request is
- # sent. Response will intercept after the response is received.
- experimental type InterceptionStage extends string
- enum
- Request
- HeadersReceived
- # Request pattern for interception.
- experimental type RequestPattern extends object
- properties
- # Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
- # backslash. Omitting is equivalent to `"*"`.
- optional string urlPattern
- # If set, only requests for matching resource types will be intercepted.
- optional ResourceType resourceType
- # Stage at which to begin intercepting requests. Default is Request.
- optional InterceptionStage interceptionStage
- # Information about a signed exchange signature.
- # https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
- experimental type SignedExchangeSignature extends object
- properties
- # Signed exchange signature label.
- string label
- # The hex string of signed exchange signature.
- string signature
- # Signed exchange signature integrity.
- string integrity
- # Signed exchange signature cert Url.
- optional string certUrl
- # The hex string of signed exchange signature cert sha256.
- optional string certSha256
- # Signed exchange signature validity Url.
- string validityUrl
- # Signed exchange signature date.
- integer date
- # Signed exchange signature expires.
- integer expires
- # The encoded certificates.
- optional array of string certificates
- # Information about a signed exchange header.
- # https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
- experimental type SignedExchangeHeader extends object
- properties
- # Signed exchange request URL.
- string requestUrl
- # Signed exchange response code.
- integer responseCode
- # Signed exchange response headers.
- Headers responseHeaders
- # Signed exchange response signature.
- array of SignedExchangeSignature signatures
- # Signed exchange header integrity hash in the form of "sha256-<base64-hash-value>".
- string headerIntegrity
- # Field type for a signed exchange related error.
- experimental type SignedExchangeErrorField extends string
- enum
- signatureSig
- signatureIntegrity
- signatureCertUrl
- signatureCertSha256
- signatureValidityUrl
- signatureTimestamps
- # Information about a signed exchange response.
- experimental type SignedExchangeError extends object
- properties
- # Error message.
- string message
- # The index of the signature which caused the error.
- optional integer signatureIndex
- # The field which caused the error.
- optional SignedExchangeErrorField errorField
- # Information about a signed exchange response.
- experimental type SignedExchangeInfo extends object
- properties
- # The outer response of signed HTTP exchange which was received from network.
- Response outerResponse
- # Information about the signed exchange header.
- optional SignedExchangeHeader header
- # Security details for the signed exchange header.
- optional SecurityDetails securityDetails
- # Errors occurred while handling the signed exchagne.
- optional array of SignedExchangeError errors
- # List of content encodings supported by the backend.
- experimental type ContentEncoding extends string
- enum
- deflate
- gzip
- br
- # Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted.
- experimental command setAcceptedEncodings
- parameters
- # List of accepted content encodings.
- array of ContentEncoding encodings
- # Clears accepted encodings set by setAcceptedEncodings
- experimental command clearAcceptedEncodingsOverride
- # Tells whether clearing browser cache is supported.
- deprecated command canClearBrowserCache
- returns
- # True if browser cache can be cleared.
- boolean result
- # Tells whether clearing browser cookies is supported.
- deprecated command canClearBrowserCookies
- returns
- # True if browser cookies can be cleared.
- boolean result
- # Tells whether emulation of network conditions is supported.
- deprecated command canEmulateNetworkConditions
- returns
- # True if emulation of network conditions is supported.
- boolean result
- # Clears browser cache.
- command clearBrowserCache
- # Clears browser cookies.
- command clearBrowserCookies
- # Response to Network.requestIntercepted which either modifies the request to continue with any
- # modifications, or blocks it, or completes it with the provided response bytes. If a network
- # fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted
- # event will be sent with the same InterceptionId.
- # Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead.
- experimental deprecated command continueInterceptedRequest
- parameters
- InterceptionId interceptionId
- # If set this causes the request to fail with the given reason. Passing `Aborted` for requests
- # marked with `isNavigationRequest` also cancels the navigation. Must not be set in response
- # to an authChallenge.
- optional ErrorReason errorReason
- # If set the requests completes using with the provided base64 encoded raw response, including
- # HTTP status line and headers etc... Must not be set in response to an authChallenge.
- optional binary rawResponse
- # If set the request url will be modified in a way that's not observable by page. Must not be
- # set in response to an authChallenge.
- optional string url
- # If set this allows the request method to be overridden. Must not be set in response to an
- # authChallenge.
- optional string method
- # If set this allows postData to be set. Must not be set in response to an authChallenge.
- optional string postData
- # If set this allows the request headers to be changed. Must not be set in response to an
- # authChallenge.
- optional Headers headers
- # Response to a requestIntercepted with an authChallenge. Must not be set otherwise.
- optional AuthChallengeResponse authChallengeResponse
- # Deletes browser cookies with matching name and url or domain/path pair.
- command deleteCookies
- parameters
- # Name of the cookies to remove.
- string name
- # If specified, deletes all the cookies with the given name where domain and path match
- # provided URL.
- optional string url
- # If specified, deletes only cookies with the exact domain.
- optional string domain
- # If specified, deletes only cookies with the exact path.
- optional string path
- # Disables network tracking, prevents network events from being sent to the client.
- command disable
- # Activates emulation of network conditions.
- command emulateNetworkConditions
- parameters
- # True to emulate internet disconnection.
- boolean offline
- # Minimum latency from request sent to response headers received (ms).
- number latency
- # Maximal aggregated download throughput (bytes/sec). -1 disables download throttling.
- number downloadThroughput
- # Maximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
- number uploadThroughput
- # Connection type if known.
- optional ConnectionType connectionType
- # Enables network tracking, network events will now be delivered to the client.
- command enable
- parameters
- # Buffer size in bytes to use when preserving network payloads (XHRs, etc).
- experimental optional integer maxTotalBufferSize
- # Per-resource buffer size in bytes to use when preserving network payloads (XHRs, etc).
- experimental optional integer maxResourceBufferSize
- # Longest post body size (in bytes) that would be included in requestWillBeSent notification
- optional integer maxPostDataSize
- # Returns all browser cookies. Depending on the backend support, will return detailed cookie
- # information in the `cookies` field.
- # Deprecated. Use Storage.getCookies instead.
- deprecated command getAllCookies
- returns
- # Array of cookie objects.
- array of Cookie cookies
- # Returns the DER-encoded certificate.
- experimental command getCertificate
- parameters
- # Origin to get certificate for.
- string origin
- returns
- array of string tableNames
- # Returns all browser cookies for the current URL. Depending on the backend support, will return
- # detailed cookie information in the `cookies` field.
- command getCookies
- parameters
- # The list of URLs for which applicable cookies will be fetched.
- # If not specified, it's assumed to be set to the list containing
- # the URLs of the page and all of its subframes.
- optional array of string urls
- returns
- # Array of cookie objects.
- array of Cookie cookies
- # Returns content served for the given request.
- command getResponseBody
- parameters
- # Identifier of the network request to get content for.
- RequestId requestId
- returns
- # Response body.
- string body
- # True, if content was sent as base64.
- boolean base64Encoded
- # Returns post data sent with the request. Returns an error when no data was sent with the request.
- command getRequestPostData
- parameters
- # Identifier of the network request to get content for.
- RequestId requestId
- returns
- # Request body string, omitting files from multipart requests
- string postData
- # Returns content served for the given currently intercepted request.
- experimental command getResponseBodyForInterception
- parameters
- # Identifier for the intercepted request to get body for.
- InterceptionId interceptionId
- returns
- # Response body.
- string body
- # True, if content was sent as base64.
- boolean base64Encoded
- # Returns a handle to the stream representing the response body. Note that after this command,
- # the intercepted request can't be continued as is -- you either need to cancel it or to provide
- # the response body. The stream only supports sequential read, IO.read will fail if the position
- # is specified.
- experimental command takeResponseBodyForInterceptionAsStream
- parameters
- InterceptionId interceptionId
- returns
- IO.StreamHandle stream
- # This method sends a new XMLHttpRequest which is identical to the original one. The following
- # parameters should be identical: method, url, async, request body, extra headers, withCredentials
- # attribute, user, password.
- experimental command replayXHR
- parameters
- # Identifier of XHR to replay.
- RequestId requestId
- # Searches for given string in response content.
- experimental command searchInResponseBody
- parameters
- # Identifier of the network response to search.
- RequestId requestId
- # String to search for.
- string query
- # If true, search is case sensitive.
- optional boolean caseSensitive
- # If true, treats string parameter as regex.
- optional boolean isRegex
- returns
- # List of search matches.
- array of Debugger.SearchMatch result
- # Blocks URLs from loading.
- experimental command setBlockedURLs
- parameters
- # URL patterns to block. Wildcards ('*') are allowed.
- array of string urls
- # Toggles ignoring of service worker for each request.
- experimental command setBypassServiceWorker
- parameters
- # Bypass service worker and load from network.
- boolean bypass
- # Toggles ignoring cache for each request. If `true`, cache will not be used.
- command setCacheDisabled
- parameters
- # Cache disabled state.
- boolean cacheDisabled
- # Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.
- command setCookie
- parameters
- # Cookie name.
- string name
- # Cookie value.
- string value
- # The request-URI to associate with the setting of the cookie. This value can affect the
- # default domain, path, source port, and source scheme values of the created cookie.
- optional string url
- # Cookie domain.
- optional string domain
- # Cookie path.
- optional string path
- # True if cookie is secure.
- optional boolean secure
- # True if cookie is http-only.
- optional boolean httpOnly
- # Cookie SameSite type.
- optional CookieSameSite sameSite
- # Cookie expiration date, session cookie if not set
- optional TimeSinceEpoch expires
- # Cookie Priority type.
- experimental optional CookiePriority priority
- # True if cookie is SameParty.
- experimental optional boolean sameParty
- # Cookie source scheme type.
- experimental optional CookieSourceScheme sourceScheme
- # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
- # An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
- # This is a temporary ability and it will be removed in the future.
- experimental optional integer sourcePort
- # Cookie partition key. The site of the top-level URL the browser was visiting at the start
- # of the request to the endpoint that set the cookie.
- # If not set, the cookie will be set as not partitioned.
- experimental optional string partitionKey
- returns
- # Always set to true. If an error occurs, the response indicates protocol error.
- deprecated boolean success
- # Sets given cookies.
- command setCookies
- parameters
- # Cookies to be set.
- array of CookieParam cookies
- # Specifies whether to always send extra HTTP headers with the requests from this page.
- command setExtraHTTPHeaders
- parameters
- # Map with extra HTTP headers.
- Headers headers
- # Specifies whether to attach a page script stack id in requests
- experimental command setAttachDebugStack
- parameters
- # Whether to attach a page script stack for debugging purpose.
- boolean enabled
- # Sets the requests to intercept that match the provided patterns and optionally resource types.
- # Deprecated, please use Fetch.enable instead.
- experimental deprecated command setRequestInterception
- parameters
- # Requests matching any of these patterns will be forwarded and wait for the corresponding
- # continueInterceptedRequest call.
- array of RequestPattern patterns
- # Allows overriding user agent with the given string.
- command setUserAgentOverride
- redirect Emulation
- parameters
- # User agent to use.
- string userAgent
- # Browser langugage to emulate.
- optional string acceptLanguage
- # The platform navigator.platform should return.
- optional string platform
- # To be sent in Sec-CH-UA-* headers and returned in navigator.userAgentData
- experimental optional Emulation.UserAgentMetadata userAgentMetadata
- # Fired when data chunk was received over the network.
- event dataReceived
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # Data chunk length.
- integer dataLength
- # Actual bytes received (might be less than dataLength for compressed encodings).
- integer encodedDataLength
- # Fired when EventSource message is received.
- event eventSourceMessageReceived
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # Message type.
- string eventName
- # Message identifier.
- string eventId
- # Message content.
- string data
- # Fired when HTTP request has failed to load.
- event loadingFailed
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # Resource type.
- ResourceType type
- # User friendly error message.
- string errorText
- # True if loading was canceled.
- optional boolean canceled
- # The reason why loading was blocked, if any.
- optional BlockedReason blockedReason
- # The reason why loading was blocked by CORS, if any.
- optional CorsErrorStatus corsErrorStatus
- # Fired when HTTP request has finished loading.
- event loadingFinished
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # Total number of bytes received for this request.
- number encodedDataLength
- # Set when 1) response was blocked by Cross-Origin Read Blocking and also
- # 2) this needs to be reported to the DevTools console.
- optional boolean shouldReportCorbBlocking
- # Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
- # mocked.
- # Deprecated, use Fetch.requestPaused instead.
- experimental deprecated event requestIntercepted
- parameters
- # Each request the page makes will have a unique id, however if any redirects are encountered
- # while processing that fetch, they will be reported with the same id as the original fetch.
- # Likewise if HTTP authentication is needed then the same fetch id will be used.
- InterceptionId interceptionId
- Request request
- # The id of the frame that initiated the request.
- Page.FrameId frameId
- # How the requested resource will be used.
- ResourceType resourceType
- # Whether this is a navigation request, which can abort the navigation completely.
- boolean isNavigationRequest
- # Set if the request is a navigation that will result in a download.
- # Only present after response is received from the server (i.e. HeadersReceived stage).
- optional boolean isDownload
- # Redirect location, only sent if a redirect was intercepted.
- optional string redirectUrl
- # Details of the Authorization Challenge encountered. If this is set then
- # continueInterceptedRequest must contain an authChallengeResponse.
- optional AuthChallenge authChallenge
- # Response error if intercepted at response stage or if redirect occurred while intercepting
- # request.
- optional ErrorReason responseErrorReason
- # Response code if intercepted at response stage or if redirect occurred while intercepting
- # request or auth retry occurred.
- optional integer responseStatusCode
- # Response headers if intercepted at the response stage or if redirect occurred while
- # intercepting request or auth retry occurred.
- optional Headers responseHeaders
- # If the intercepted request had a corresponding requestWillBeSent event fired for it, then
- # this requestId will be the same as the requestId present in the requestWillBeSent event.
- optional RequestId requestId
- # Fired if request ended up loading from cache.
- event requestServedFromCache
- parameters
- # Request identifier.
- RequestId requestId
- # Fired when page is about to send HTTP request.
- event requestWillBeSent
- parameters
- # Request identifier.
- RequestId requestId
- # Loader identifier. Empty string if the request is fetched from worker.
- LoaderId loaderId
- # URL of the document this request is loaded for.
- string documentURL
- # Request data.
- Request request
- # Timestamp.
- MonotonicTime timestamp
- # Timestamp.
- TimeSinceEpoch wallTime
- # Request initiator.
- Initiator initiator
- # In the case that redirectResponse is populated, this flag indicates whether
- # requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
- # for the request which was just redirected.
- experimental boolean redirectHasExtraInfo
- # Redirect response data.
- optional Response redirectResponse
- # Type of this resource.
- optional ResourceType type
- # Frame identifier.
- optional Page.FrameId frameId
- # Whether the request is initiated by a user gesture. Defaults to false.
- optional boolean hasUserGesture
- # Fired when resource loading priority is changed
- experimental event resourceChangedPriority
- parameters
- # Request identifier.
- RequestId requestId
- # New priority
- ResourcePriority newPriority
- # Timestamp.
- MonotonicTime timestamp
- # Fired when a signed exchange was received over the network
- experimental event signedExchangeReceived
- parameters
- # Request identifier.
- RequestId requestId
- # Information about the signed exchange response.
- SignedExchangeInfo info
- # Fired when HTTP response is available.
- event responseReceived
- parameters
- # Request identifier.
- RequestId requestId
- # Loader identifier. Empty string if the request is fetched from worker.
- LoaderId loaderId
- # Timestamp.
- MonotonicTime timestamp
- # Resource type.
- ResourceType type
- # Response data.
- Response response
- # Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
- # or were emitted for this request.
- experimental boolean hasExtraInfo
- # Frame identifier.
- optional Page.FrameId frameId
- # Fired when WebSocket is closed.
- event webSocketClosed
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # Fired upon WebSocket creation.
- event webSocketCreated
- parameters
- # Request identifier.
- RequestId requestId
- # WebSocket request URL.
- string url
- # Request initiator.
- optional Initiator initiator
- # Fired when WebSocket message error occurs.
- event webSocketFrameError
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # WebSocket error message.
- string errorMessage
- # Fired when WebSocket message is received.
- event webSocketFrameReceived
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # WebSocket response data.
- WebSocketFrame response
- # Fired when WebSocket message is sent.
- event webSocketFrameSent
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # WebSocket response data.
- WebSocketFrame response
- # Fired when WebSocket handshake response becomes available.
- event webSocketHandshakeResponseReceived
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # WebSocket response data.
- WebSocketResponse response
- # Fired when WebSocket is about to initiate handshake.
- event webSocketWillSendHandshakeRequest
- parameters
- # Request identifier.
- RequestId requestId
- # Timestamp.
- MonotonicTime timestamp
- # UTC Timestamp.
- TimeSinceEpoch wallTime
- # WebSocket request data.
- WebSocketRequest request
- # Fired upon WebTransport creation.
- event webTransportCreated
- parameters
- # WebTransport identifier.
- RequestId transportId
- # WebTransport request URL.
- string url
- # Timestamp.
- MonotonicTime timestamp
- # Request initiator.
- optional Initiator initiator
- # Fired when WebTransport handshake is finished.
- event webTransportConnectionEstablished
- parameters
- # WebTransport identifier.
- RequestId transportId
- # Timestamp.
- MonotonicTime timestamp
- # Fired when WebTransport is disposed.
- event webTransportClosed
- parameters
- # WebTransport identifier.
- RequestId transportId
- # Timestamp.
- MonotonicTime timestamp
- experimental type PrivateNetworkRequestPolicy extends string
- enum
- Allow
- BlockFromInsecureToMorePrivate
- WarnFromInsecureToMorePrivate
- PreflightBlock
- PreflightWarn
- experimental type IPAddressSpace extends string
- enum
- Local
- Private
- Public
- Unknown
- experimental type ConnectTiming extends object
- properties
- # Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
- # milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for
- # the same request (but not for redirected requests).
- number requestTime
- experimental type ClientSecurityState extends object
- properties
- boolean initiatorIsSecureContext
- IPAddressSpace initiatorIPAddressSpace
- PrivateNetworkRequestPolicy privateNetworkRequestPolicy
- # Fired when additional information about a requestWillBeSent event is available from the
- # network stack. Not every requestWillBeSent event will have an additional
- # requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent
- # or requestWillBeSentExtraInfo will be fired first for the same request.
- experimental event requestWillBeSentExtraInfo
- parameters
- # Request identifier. Used to match this information to an existing requestWillBeSent event.
- RequestId requestId
- # A list of cookies potentially associated to the requested URL. This includes both cookies sent with
- # the request and the ones not sent; the latter are distinguished by having blockedReason field set.
- array of BlockedCookieWithReason associatedCookies
- # Raw request headers as they will be sent over the wire.
- Headers headers
- # Connection timing information for the request.
- experimental ConnectTiming connectTiming
- # The client security state set for the request.
- optional ClientSecurityState clientSecurityState
- # Whether the site has partitioned cookies stored in a partition different than the current one.
- optional boolean siteHasCookieInOtherPartition
- # Fired when additional information about a responseReceived event is available from the network
- # stack. Not every responseReceived event will have an additional responseReceivedExtraInfo for
- # it, and responseReceivedExtraInfo may be fired before or after responseReceived.
- experimental event responseReceivedExtraInfo
- parameters
- # Request identifier. Used to match this information to another responseReceived event.
- RequestId requestId
- # A list of cookies which were not stored from the response along with the corresponding
- # reasons for blocking. The cookies here may not be valid due to syntax errors, which
- # are represented by the invalid cookie line string instead of a proper cookie.
- array of BlockedSetCookieWithReason blockedCookies
- # Raw response headers as they were received over the wire.
- Headers headers
- # The IP address space of the resource. The address space can only be determined once the transport
- # established the connection, so we can't send it in `requestWillBeSentExtraInfo`.
- IPAddressSpace resourceIPAddressSpace
- # The status code of the response. This is useful in cases the request failed and no responseReceived
- # event is triggered, which is the case for, e.g., CORS errors. This is also the correct status code
- # for cached requests, where the status in responseReceived is a 200 and this will be 304.
- integer statusCode
- # Raw response header text as it was received over the wire. The raw text may not always be
- # available, such as in the case of HTTP/2 or QUIC.
- optional string headersText
- # The cookie partition key that will be used to store partitioned cookies set in this response.
- # Only sent when partitioned cookies are enabled.
- optional string cookiePartitionKey
- # True if partitioned cookies are enabled, but the partition key is not serializeable to string.
- optional boolean cookiePartitionKeyOpaque
- # Fired exactly once for each Trust Token operation. Depending on
- # the type of the operation and whether the operation succeeded or
- # failed, the event is fired before the corresponding request was sent
- # or after the response was received.
- experimental event trustTokenOperationDone
- parameters
- # Detailed success or error status of the operation.
- # 'AlreadyExists' also signifies a successful operation, as the result
- # of the operation already exists und thus, the operation was abort
- # preemptively (e.g. a cache hit).
- enum status
- Ok
- InvalidArgument
- FailedPrecondition
- ResourceExhausted
- AlreadyExists
- Unavailable
- Unauthorized
- BadResponse
- InternalError
- UnknownError
- FulfilledLocally
- TrustTokenOperationType type
- RequestId requestId
- # Top level origin. The context in which the operation was attempted.
- optional string topLevelOrigin
- # Origin of the issuer in case of a "Issuance" or "Redemption" operation.
- optional string issuerOrigin
- # The number of obtained Trust Tokens on a successful "Issuance" operation.
- optional integer issuedTokenCount
- # Fired once when parsing the .wbn file has succeeded.
- # The event contains the information about the web bundle contents.
- experimental event subresourceWebBundleMetadataReceived
- parameters
- # Request identifier. Used to match this information to another event.
- RequestId requestId
- # A list of URLs of resources in the subresource Web Bundle.
- array of string urls
- # Fired once when parsing the .wbn file has failed.
- experimental event subresourceWebBundleMetadataError
- parameters
- # Request identifier. Used to match this information to another event.
- RequestId requestId
- # Error message
- string errorMessage
- # Fired when handling requests for resources within a .wbn file.
- # Note: this will only be fired for resources that are requested by the webpage.
- experimental event subresourceWebBundleInnerResponseParsed
- parameters
- # Request identifier of the subresource request
- RequestId innerRequestId
- # URL of the subresource resource.
- string innerRequestURL
- # Bundle request identifier. Used to match this information to another event.
- # This made be absent in case when the instrumentation was enabled only
- # after webbundle was parsed.
- optional RequestId bundleRequestId
- # Fired when request for resources within a .wbn file failed.
- experimental event subresourceWebBundleInnerResponseError
- parameters
- # Request identifier of the subresource request
- RequestId innerRequestId
- # URL of the subresource resource.
- string innerRequestURL
- # Error message
- string errorMessage
- # Bundle request identifier. Used to match this information to another event.
- # This made be absent in case when the instrumentation was enabled only
- # after webbundle was parsed.
- optional RequestId bundleRequestId
- experimental type CrossOriginOpenerPolicyValue extends string
- enum
- SameOrigin
- SameOriginAllowPopups
- RestrictProperties
- UnsafeNone
- SameOriginPlusCoep
- RestrictPropertiesPlusCoep
- experimental type CrossOriginOpenerPolicyStatus extends object
- properties
- CrossOriginOpenerPolicyValue value
- CrossOriginOpenerPolicyValue reportOnlyValue
- optional string reportingEndpoint
- optional string reportOnlyReportingEndpoint
- experimental type CrossOriginEmbedderPolicyValue extends string
- enum
- None
- Credentialless
- RequireCorp
- experimental type CrossOriginEmbedderPolicyStatus extends object
- properties
- CrossOriginEmbedderPolicyValue value
- CrossOriginEmbedderPolicyValue reportOnlyValue
- optional string reportingEndpoint
- optional string reportOnlyReportingEndpoint
- experimental type SecurityIsolationStatus extends object
- properties
- optional CrossOriginOpenerPolicyStatus coop
- optional CrossOriginEmbedderPolicyStatus coep
- # Returns information about the COEP/COOP isolation status.
- experimental command getSecurityIsolationStatus
- parameters
- # If no frameId is provided, the status of the target is provided.
- optional Page.FrameId frameId
- returns
- SecurityIsolationStatus status
- # Enables tracking for the Reporting API, events generated by the Reporting API will now be delivered to the client.
- # Enabling triggers 'reportingApiReportAdded' for all existing reports.
- experimental command enableReportingApi
- parameters
- # Whether to enable or disable events for the Reporting API
- boolean enable
- # The status of a Reporting API report.
- experimental type ReportStatus extends string
- enum
- # Report has been queued and no attempt has been made to deliver it yet,
- # or attempted previous upload failed (impermanently).
- Queued
- # There is an ongoing attempt to upload this report.
- Pending
- # Deletion of this report was requested while it was pending, so it will
- # be removed after possibly outstanding upload attempts complete (successful
- # or not).
- MarkedForRemoval
- # Successfully uploaded and MarkedForRemoval.
- Success
- experimental type ReportId extends string
- # An object representing a report generated by the Reporting API.
- experimental type ReportingApiReport extends object
- properties
- ReportId id
- # The URL of the document that triggered the report.
- string initiatorUrl
- # The name of the endpoint group that should be used to deliver the report.
- string destination
- # The type of the report (specifies the set of data that is contained in the report body).
- string type
- # When the report was generated.
- Network.TimeSinceEpoch timestamp
- # How many uploads deep the related request was.
- integer depth
- # The number of delivery attempts made so far, not including an active attempt.
- integer completedAttempts
- object body
- ReportStatus status
- # Is sent whenever a new report is added.
- # And after 'enableReportingApi' for all existing reports.
- experimental event reportingApiReportAdded
- parameters
- ReportingApiReport report
- experimental event reportingApiReportUpdated
- parameters
- ReportingApiReport report
- experimental type ReportingApiEndpoint extends object
- properties
- # The URL of the endpoint to which reports may be delivered.
- string url
- # Name of the endpoint group.
- string groupName
- experimental event reportingApiEndpointsChangedForOrigin
- parameters
- # Origin of the document(s) which configured the endpoints.
- string origin
- array of ReportingApiEndpoint endpoints
- # An object providing the result of a network resource load.
- experimental type LoadNetworkResourcePageResult extends object
- properties
- boolean success
- # Optional values used for error reporting.
- optional number netError
- optional string netErrorName
- optional number httpStatusCode
- # If successful, one of the following two fields holds the result.
- optional IO.StreamHandle stream
- # Response headers.
- optional Network.Headers headers
- # An options object that may be extended later to better support CORS,
- # CORB and streaming.
- experimental type LoadNetworkResourceOptions extends object
- properties
- boolean disableCache
- boolean includeCredentials
- # Fetches the resource and returns the content.
- experimental command loadNetworkResource
- parameters
- # Frame id to get the resource for. Mandatory for frame targets, and
- # should be omitted for worker targets.
- optional Page.FrameId frameId
- # URL of the resource to get content for.
- string url
- # Options for the request.
- LoadNetworkResourceOptions options
- returns
- LoadNetworkResourcePageResult resource
- # This domain provides various functionality related to drawing atop the inspected page.
- experimental domain Overlay
- depends on DOM
- depends on Page
- depends on Runtime
- # Configuration data for drawing the source order of an elements children.
- type SourceOrderConfig extends object
- properties
- # the color to outline the givent element in.
- DOM.RGBA parentOutlineColor
- # the color to outline the child elements in.
- DOM.RGBA childOutlineColor
- # Configuration data for the highlighting of Grid elements.
- type GridHighlightConfig extends object
- properties
- # Whether the extension lines from grid cells to the rulers should be shown (default: false).
- optional boolean showGridExtensionLines
- # Show Positive line number labels (default: false).
- optional boolean showPositiveLineNumbers
- # Show Negative line number labels (default: false).
- optional boolean showNegativeLineNumbers
- # Show area name labels (default: false).
- optional boolean showAreaNames
- # Show line name labels (default: false).
- optional boolean showLineNames
- # Show track size labels (default: false).
- optional boolean showTrackSizes
- # The grid container border highlight color (default: transparent).
- optional DOM.RGBA gridBorderColor
- # The cell border color (default: transparent). Deprecated, please use rowLineColor and columnLineColor instead.
- deprecated optional DOM.RGBA cellBorderColor
- # The row line color (default: transparent).
- optional DOM.RGBA rowLineColor
- # The column line color (default: transparent).
- optional DOM.RGBA columnLineColor
- # Whether the grid border is dashed (default: false).
- optional boolean gridBorderDash
- # Whether the cell border is dashed (default: false). Deprecated, please us rowLineDash and columnLineDash instead.
- deprecated optional boolean cellBorderDash
- # Whether row lines are dashed (default: false).
- optional boolean rowLineDash
- # Whether column lines are dashed (default: false).
- optional boolean columnLineDash
- # The row gap highlight fill color (default: transparent).
- optional DOM.RGBA rowGapColor
- # The row gap hatching fill color (default: transparent).
- optional DOM.RGBA rowHatchColor
- # The column gap highlight fill color (default: transparent).
- optional DOM.RGBA columnGapColor
- # The column gap hatching fill color (default: transparent).
- optional DOM.RGBA columnHatchColor
- # The named grid areas border color (Default: transparent).
- optional DOM.RGBA areaBorderColor
- # The grid container background color (Default: transparent).
- optional DOM.RGBA gridBackgroundColor
- # Configuration data for the highlighting of Flex container elements.
- type FlexContainerHighlightConfig extends object
- properties
- # The style of the container border
- optional LineStyle containerBorder
- # The style of the separator between lines
- optional LineStyle lineSeparator
- # The style of the separator between items
- optional LineStyle itemSeparator
- # Style of content-distribution space on the main axis (justify-content).
- optional BoxStyle mainDistributedSpace
- # Style of content-distribution space on the cross axis (align-content).
- optional BoxStyle crossDistributedSpace
- # Style of empty space caused by row gaps (gap/row-gap).
- optional BoxStyle rowGapSpace
- # Style of empty space caused by columns gaps (gap/column-gap).
- optional BoxStyle columnGapSpace
- # Style of the self-alignment line (align-items).
- optional LineStyle crossAlignment
- # Configuration data for the highlighting of Flex item elements.
- type FlexItemHighlightConfig extends object
- properties
- # Style of the box representing the item's base size
- optional BoxStyle baseSizeBox
- # Style of the border around the box representing the item's base size
- optional LineStyle baseSizeBorder
- # Style of the arrow representing if the item grew or shrank
- optional LineStyle flexibilityArrow
- # Style information for drawing a line.
- type LineStyle extends object
- properties
- # The color of the line (default: transparent)
- optional DOM.RGBA color
- # The line pattern (default: solid)
- optional enum pattern
- dashed
- dotted
- # Style information for drawing a box.
- type BoxStyle extends object
- properties
- # The background color for the box (default: transparent)
- optional DOM.RGBA fillColor
- # The hatching color for the box (default: transparent)
- optional DOM.RGBA hatchColor
- type ContrastAlgorithm extends string
- enum
- aa
- aaa
- apca
- # Configuration data for the highlighting of page elements.
- type HighlightConfig extends object
- properties
- # Whether the node info tooltip should be shown (default: false).
- optional boolean showInfo
- # Whether the node styles in the tooltip (default: false).
- optional boolean showStyles
- # Whether the rulers should be shown (default: false).
- optional boolean showRulers
- # Whether the a11y info should be shown (default: true).
- optional boolean showAccessibilityInfo
- # Whether the extension lines from node to the rulers should be shown (default: false).
- optional boolean showExtensionLines
- # The content box highlight fill color (default: transparent).
- optional DOM.RGBA contentColor
- # The padding highlight fill color (default: transparent).
- optional DOM.RGBA paddingColor
- # The border highlight fill color (default: transparent).
- optional DOM.RGBA borderColor
- # The margin highlight fill color (default: transparent).
- optional DOM.RGBA marginColor
- # The event target element highlight fill color (default: transparent).
- optional DOM.RGBA eventTargetColor
- # The shape outside fill color (default: transparent).
- optional DOM.RGBA shapeColor
- # The shape margin fill color (default: transparent).
- optional DOM.RGBA shapeMarginColor
- # The grid layout color (default: transparent).
- optional DOM.RGBA cssGridColor
- # The color format used to format color styles (default: hex).
- optional ColorFormat colorFormat
- # The grid layout highlight configuration (default: all transparent).
- optional GridHighlightConfig gridHighlightConfig
- # The flex container highlight configuration (default: all transparent).
- optional FlexContainerHighlightConfig flexContainerHighlightConfig
- # The flex item highlight configuration (default: all transparent).
- optional FlexItemHighlightConfig flexItemHighlightConfig
- # The contrast algorithm to use for the contrast ratio (default: aa).
- optional ContrastAlgorithm contrastAlgorithm
- # The container query container highlight configuration (default: all transparent).
- optional ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig
- type ColorFormat extends string
- enum
- rgb
- hsl
- hwb
- hex
- # Configurations for Persistent Grid Highlight
- type GridNodeHighlightConfig extends object
- properties
- # A descriptor for the highlight appearance.
- GridHighlightConfig gridHighlightConfig
- # Identifier of the node to highlight.
- DOM.NodeId nodeId
- type FlexNodeHighlightConfig extends object
- properties
- # A descriptor for the highlight appearance of flex containers.
- FlexContainerHighlightConfig flexContainerHighlightConfig
- # Identifier of the node to highlight.
- DOM.NodeId nodeId
- type ScrollSnapContainerHighlightConfig extends object
- properties
- # The style of the snapport border (default: transparent)
- optional LineStyle snapportBorder
- # The style of the snap area border (default: transparent)
- optional LineStyle snapAreaBorder
- # The margin highlight fill color (default: transparent).
- optional DOM.RGBA scrollMarginColor
- # The padding highlight fill color (default: transparent).
- optional DOM.RGBA scrollPaddingColor
- type ScrollSnapHighlightConfig extends object
- properties
- # A descriptor for the highlight appearance of scroll snap containers.
- ScrollSnapContainerHighlightConfig scrollSnapContainerHighlightConfig
- # Identifier of the node to highlight.
- DOM.NodeId nodeId
- # Configuration for dual screen hinge
- type HingeConfig extends object
- properties
- # A rectangle represent hinge
- DOM.Rect rect
- # The content box highlight fill color (default: a dark color).
- optional DOM.RGBA contentColor
- # The content box highlight outline color (default: transparent).
- optional DOM.RGBA outlineColor
- type ContainerQueryHighlightConfig extends object
- properties
- # A descriptor for the highlight appearance of container query containers.
- ContainerQueryContainerHighlightConfig containerQueryContainerHighlightConfig
- # Identifier of the container node to highlight.
- DOM.NodeId nodeId
- type ContainerQueryContainerHighlightConfig extends object
- properties
- # The style of the container border.
- optional LineStyle containerBorder
- # The style of the descendants' borders.
- optional LineStyle descendantBorder
- type IsolatedElementHighlightConfig extends object
- properties
- # A descriptor for the highlight appearance of an element in isolation mode.
- IsolationModeHighlightConfig isolationModeHighlightConfig
- # Identifier of the isolated element to highlight.
- DOM.NodeId nodeId
- type IsolationModeHighlightConfig extends object
- properties
- # The fill color of the resizers (default: transparent).
- optional DOM.RGBA resizerColor
- # The fill color for resizer handles (default: transparent).
- optional DOM.RGBA resizerHandleColor
- # The fill color for the mask covering non-isolated elements (default: transparent).
- optional DOM.RGBA maskColor
- type InspectMode extends string
- enum
- searchForNode
- searchForUAShadowDOM
- captureAreaScreenshot
- showDistances
- none
- # Disables domain notifications.
- command disable
- # Enables domain notifications.
- command enable
- # For testing.
- command getHighlightObjectForTest
- parameters
- # Id of the node to get highlight object for.
- DOM.NodeId nodeId
- # Whether to include distance info.
- optional boolean includeDistance
- # Whether to include style info.
- optional boolean includeStyle
- # The color format to get config with (default: hex).
- optional ColorFormat colorFormat
- # Whether to show accessibility info (default: true).
- optional boolean showAccessibilityInfo
- returns
- # Highlight data for the node.
- object highlight
- # For Persistent Grid testing.
- command getGridHighlightObjectsForTest
- parameters
- # Ids of the node to get highlight object for.
- array of DOM.NodeId nodeIds
- returns
- # Grid Highlight data for the node ids provided.
- object highlights
- # For Source Order Viewer testing.
- command getSourceOrderHighlightObjectForTest
- parameters
- # Id of the node to highlight.
- DOM.NodeId nodeId
- returns
- # Source order highlight data for the node id provided.
- object highlight
- # Hides any highlight.
- command hideHighlight
- # Highlights owner element of the frame with given id.
- # Deprecated: Doesn't work reliablity and cannot be fixed due to process
- # separatation (the owner node might be in a different process). Determine
- # the owner node in the client and use highlightNode.
- deprecated command highlightFrame
- parameters
- # Identifier of the frame to highlight.
- Page.FrameId frameId
- # The content box highlight fill color (default: transparent).
- optional DOM.RGBA contentColor
- # The content box highlight outline color (default: transparent).
- optional DOM.RGBA contentOutlineColor
- # Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or
- # objectId must be specified.
- command highlightNode
- parameters
- # A descriptor for the highlight appearance.
- HighlightConfig highlightConfig
- # Identifier of the node to highlight.
- optional DOM.NodeId nodeId
- # Identifier of the backend node to highlight.
- optional DOM.BackendNodeId backendNodeId
- # JavaScript object id of the node to be highlighted.
- optional Runtime.RemoteObjectId objectId
- # Selectors to highlight relevant nodes.
- optional string selector
- # Highlights given quad. Coordinates are absolute with respect to the main frame viewport.
- command highlightQuad
- parameters
- # Quad to highlight
- DOM.Quad quad
- # The highlight fill color (default: transparent).
- optional DOM.RGBA color
- # The highlight outline color (default: transparent).
- optional DOM.RGBA outlineColor
- # Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
- command highlightRect
- parameters
- # X coordinate
- integer x
- # Y coordinate
- integer y
- # Rectangle width
- integer width
- # Rectangle height
- integer height
- # The highlight fill color (default: transparent).
- optional DOM.RGBA color
- # The highlight outline color (default: transparent).
- optional DOM.RGBA outlineColor
- # Highlights the source order of the children of the DOM node with given id or with the given
- # JavaScript object wrapper. Either nodeId or objectId must be specified.
- command highlightSourceOrder
- parameters
- # A descriptor for the appearance of the overlay drawing.
- SourceOrderConfig sourceOrderConfig
- # Identifier of the node to highlight.
- optional DOM.NodeId nodeId
- # Identifier of the backend node to highlight.
- optional DOM.BackendNodeId backendNodeId
- # JavaScript object id of the node to be highlighted.
- optional Runtime.RemoteObjectId objectId
- # Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted.
- # Backend then generates 'inspectNodeRequested' event upon element selection.
- command setInspectMode
- parameters
- # Set an inspection mode.
- InspectMode mode
- # A descriptor for the highlight appearance of hovered-over nodes. May be omitted if `enabled
- # == false`.
- optional HighlightConfig highlightConfig
- # Highlights owner element of all frames detected to be ads.
- command setShowAdHighlights
- parameters
- # True for showing ad highlights
- boolean show
- command setPausedInDebuggerMessage
- parameters
- # The message to display, also triggers resume and step over controls.
- optional string message
- # Requests that backend shows debug borders on layers
- command setShowDebugBorders
- parameters
- # True for showing debug borders
- boolean show
- # Requests that backend shows the FPS counter
- command setShowFPSCounter
- parameters
- # True for showing the FPS counter
- boolean show
- # Highlight multiple elements with the CSS Grid overlay.
- command setShowGridOverlays
- parameters
- # An array of node identifiers and descriptors for the highlight appearance.
- array of GridNodeHighlightConfig gridNodeHighlightConfigs
- command setShowFlexOverlays
- parameters
- # An array of node identifiers and descriptors for the highlight appearance.
- array of FlexNodeHighlightConfig flexNodeHighlightConfigs
- command setShowScrollSnapOverlays
- parameters
- # An array of node identifiers and descriptors for the highlight appearance.
- array of ScrollSnapHighlightConfig scrollSnapHighlightConfigs
- command setShowContainerQueryOverlays
- parameters
- # An array of node identifiers and descriptors for the highlight appearance.
- array of ContainerQueryHighlightConfig containerQueryHighlightConfigs
- # Requests that backend shows paint rectangles
- command setShowPaintRects
- parameters
- # True for showing paint rectangles
- boolean result
- # Requests that backend shows layout shift regions
- command setShowLayoutShiftRegions
- parameters
- # True for showing layout shift regions
- boolean result
- # Requests that backend shows scroll bottleneck rects
- command setShowScrollBottleneckRects
- parameters
- # True for showing scroll bottleneck rects
- boolean show
- # Deprecated, no longer has any effect.
- deprecated command setShowHitTestBorders
- parameters
- # True for showing hit-test borders
- boolean show
- # Request that backend shows an overlay with web vital metrics.
- command setShowWebVitals
- parameters
- boolean show
- # Paints viewport size upon main frame resize.
- command setShowViewportSizeOnResize
- parameters
- # Whether to paint size or not.
- boolean show
- # Add a dual screen device hinge
- command setShowHinge
- parameters
- # hinge data, null means hideHinge
- optional HingeConfig hingeConfig
- # Show elements in isolation mode with overlays.
- command setShowIsolatedElements
- parameters
- # An array of node identifiers and descriptors for the highlight appearance.
- array of IsolatedElementHighlightConfig isolatedElementHighlightConfigs
- # Fired when the node should be inspected. This happens after call to `setInspectMode` or when
- # user manually inspects an element.
- event inspectNodeRequested
- parameters
- # Id of the node to inspect.
- DOM.BackendNodeId backendNodeId
- # Fired when the node should be highlighted. This happens after call to `setInspectMode`.
- event nodeHighlightRequested
- parameters
- DOM.NodeId nodeId
- # Fired when user asks to capture screenshot of some area on the page.
- event screenshotRequested
- parameters
- # Viewport to capture, in device independent pixels (dip).
- Page.Viewport viewport
- # Fired when user cancels the inspect mode.
- event inspectModeCanceled
- # Actions and events related to the inspected page belong to the page domain.
- domain Page
- depends on Debugger
- depends on DOM
- depends on IO
- depends on Network
- depends on Runtime
- # Unique frame identifier.
- type FrameId extends string
- # Indicates whether a frame has been identified as an ad.
- experimental type AdFrameType extends string
- enum
- none
- # This frame is a subframe of an ad frame.
- child
- # This frame is the root of an ad frame.
- root
- experimental type AdFrameExplanation extends string
- enum
- ParentIsAd
- CreatedByAdScript
- MatchedBlockingRule
- # Indicates whether a frame has been identified as an ad and why.
- experimental type AdFrameStatus extends object
- properties
- AdFrameType adFrameType
- optional array of AdFrameExplanation explanations
- # Identifies the bottom-most script which caused the frame to be labelled
- # as an ad.
- experimental type AdScriptId extends object
- properties
- # Script Id of the bottom-most script which caused the frame to be labelled
- # as an ad.
- Runtime.ScriptId scriptId
- # Id of adScriptId's debugger.
- Runtime.UniqueDebuggerId debuggerId
- # Indicates whether the frame is a secure context and why it is the case.
- experimental type SecureContextType extends string
- enum
- # The origin is a secure context.
- Secure
- # The host is localhost and hence is considered secure.
- SecureLocalhost
- # The origin has an insecure scheme and is not localhost.
- InsecureScheme
- # One of the ancestor frames is not a secure context.
- InsecureAncestor
- # Indicates whether the frame is cross-origin isolated and why it is the case.
- experimental type CrossOriginIsolatedContextType extends string
- enum
- # The origin is cross-origin isolated.
- Isolated
- # The origin is not cross-origin isolated.
- NotIsolated
- # The cross-origin isolation feature is disabled.
- NotIsolatedFeatureDisabled
- experimental type GatedAPIFeatures extends string
- enum
- SharedArrayBuffers
- SharedArrayBuffersTransferAllowed
- PerformanceMeasureMemory
- PerformanceProfile
- # All Permissions Policy features. This enum should match the one defined
- # in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.
- experimental type PermissionsPolicyFeature extends string
- enum
- accelerometer
- ambient-light-sensor
- attribution-reporting
- autoplay
- bluetooth
- browsing-topics
- camera
- ch-dpr
- ch-device-memory
- ch-downlink
- ch-ect
- ch-prefers-color-scheme
- ch-prefers-reduced-motion
- ch-rtt
- ch-save-data
- ch-ua
- ch-ua-arch
- ch-ua-bitness
- ch-ua-platform
- ch-ua-model
- ch-ua-mobile
- ch-ua-full
- ch-ua-full-version
- ch-ua-full-version-list
- ch-ua-platform-version
- ch-ua-reduced
- ch-ua-wow64
- ch-viewport-height
- ch-viewport-width
- ch-width
- clipboard-read
- clipboard-write
- compute-pressure
- cross-origin-isolated
- direct-sockets
- display-capture
- document-domain
- encrypted-media
- execution-while-out-of-viewport
- execution-while-not-rendered
- focus-without-user-activation
- fullscreen
- frobulate
- gamepad
- geolocation
- gyroscope
- hid
- identity-credentials-get
- idle-detection
- interest-cohort
- join-ad-interest-group
- keyboard-map
- local-fonts
- magnetometer
- microphone
- midi
- otp-credentials
- payment
- picture-in-picture
- private-aggregation
- private-state-token-issuance
- private-state-token-redemption
- publickey-credentials-get
- run-ad-auction
- screen-wake-lock
- serial
- shared-autofill
- shared-storage
- shared-storage-select-url
- smart-card
- storage-access
- sync-xhr
- unload
- usb
- vertical-scroll
- web-share
- # Alias for 'window-placement' (crbug.com/1328581).
- window-management
- window-placement
- xr-spatial-tracking
- # Reason for a permissions policy feature to be disabled.
- experimental type PermissionsPolicyBlockReason extends string
- enum
- # Declaration in HTTP header.
- Header
- # Declaration in iframe attribute.
- IframeAttribute
- # Inside fenced frame.
- InFencedFrameTree
- # Inside an Isolated Application.
- InIsolatedApp
- experimental type PermissionsPolicyBlockLocator extends object
- properties
- FrameId frameId
- PermissionsPolicyBlockReason blockReason
- experimental type PermissionsPolicyFeatureState extends object
- properties
- PermissionsPolicyFeature feature
- boolean allowed
- optional PermissionsPolicyBlockLocator locator
- # Origin Trial(https://www.chromium.org/blink/origin-trials) support.
- # Status for an Origin Trial token.
- experimental type OriginTrialTokenStatus extends string
- enum
- Success
- NotSupported
- Insecure
- Expired
- WrongOrigin
- InvalidSignature
- Malformed
- WrongVersion
- FeatureDisabled
- TokenDisabled
- FeatureDisabledForUser
- UnknownTrial
- # Status for an Origin Trial.
- experimental type OriginTrialStatus extends string
- enum
- Enabled
- ValidTokenNotProvided
- OSNotSupported
- TrialNotAllowed
- experimental type OriginTrialUsageRestriction extends string
- enum
- None
- Subset
- experimental type OriginTrialToken extends object
- properties
- string origin
- boolean matchSubDomains
- string trialName
- Network.TimeSinceEpoch expiryTime
- boolean isThirdParty
- OriginTrialUsageRestriction usageRestriction
- experimental type OriginTrialTokenWithStatus extends object
- properties
- string rawTokenText
- # `parsedToken` is present only when the token is extractable and
- # parsable.
- optional OriginTrialToken parsedToken
- OriginTrialTokenStatus status
- experimental type OriginTrial extends object
- properties
- string trialName
- OriginTrialStatus status
- array of OriginTrialTokenWithStatus tokensWithStatus
- # Information about the Frame on the page.
- type Frame extends object
- properties
- # Frame unique identifier.
- FrameId id
- # Parent frame identifier.
- optional FrameId parentId
- # Identifier of the loader associated with this frame.
- Network.LoaderId loaderId
- # Frame's name as specified in the tag.
- optional string name
- # Frame document's URL without fragment.
- string url
- # Frame document's URL fragment including the '#'.
- experimental optional string urlFragment
- # Frame document's registered domain, taking the public suffixes list into account.
- # Extracted from the Frame's url.
- # Example URLs: http://www.google.com/file.html -> "google.com"
- # http://a.b.co.uk/file.html -> "b.co.uk"
- experimental string domainAndRegistry
- # Frame document's security origin.
- string securityOrigin
- # Frame document's mimeType as determined by the browser.
- string mimeType
- # 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.
- experimental optional string unreachableUrl
- # Indicates whether this frame was tagged as an ad and why.
- experimental optional AdFrameStatus adFrameStatus
- # Indicates whether the main document is a secure context and explains why that is the case.
- experimental SecureContextType secureContextType
- # Indicates whether this is a cross origin isolated context.
- experimental CrossOriginIsolatedContextType crossOriginIsolatedContextType
- # Indicated which gated APIs / features are available.
- experimental array of GatedAPIFeatures gatedAPIFeatures
- # Information about the Resource on the page.
- experimental type FrameResource extends object
- properties
- # Resource URL.
- string url
- # Type of this resource.
- Network.ResourceType type
- # Resource mimeType as determined by the browser.
- string mimeType
- # last-modified timestamp as reported by server.
- optional Network.TimeSinceEpoch lastModified
- # Resource content size.
- optional number contentSize
- # True if the resource failed to load.
- optional boolean failed
- # True if the resource was canceled during loading.
- optional boolean canceled
- # Information about the Frame hierarchy along with their cached resources.
- experimental type FrameResourceTree extends object
- properties
- # Frame information for this tree item.
- Frame frame
- # Child frames.
- optional array of FrameResourceTree childFrames
- # Information about frame resources.
- array of FrameResource resources
- # Information about the Frame hierarchy.
- type FrameTree extends object
- properties
- # Frame information for this tree item.
- Frame frame
- # Child frames.
- optional array of FrameTree childFrames
- # Unique script identifier.
- type ScriptIdentifier extends string
- # Transition type.
- type TransitionType extends string
- enum
- link
- typed
- address_bar
- auto_bookmark
- auto_subframe
- manual_subframe
- generated
- auto_toplevel
- form_submit
- reload
- keyword
- keyword_generated
- other
- # Navigation history entry.
- type NavigationEntry extends object
- properties
- # Unique id of the navigation history entry.
- integer id
- # URL of the navigation history entry.
- string url
- # URL that the user typed in the url bar.
- string userTypedURL
- # Title of the navigation history entry.
- string title
- # Transition type.
- TransitionType transitionType
- # Screencast frame metadata.
- experimental type ScreencastFrameMetadata extends object
- properties
- # Top offset in DIP.
- number offsetTop
- # Page scale factor.
- number pageScaleFactor
- # Device screen width in DIP.
- number deviceWidth
- # Device screen height in DIP.
- number deviceHeight
- # Position of horizontal scroll in CSS pixels.
- number scrollOffsetX
- # Position of vertical scroll in CSS pixels.
- number scrollOffsetY
- # Frame swap timestamp.
- optional Network.TimeSinceEpoch timestamp
- # Javascript dialog type.
- type DialogType extends string
- enum
- alert
- confirm
- prompt
- beforeunload
- # Error while paring app manifest.
- type AppManifestError extends object
- properties
- # Error message.
- string message
- # If criticial, this is a non-recoverable parse error.
- integer critical
- # Error line.
- integer line
- # Error column.
- integer column
- # Parsed app manifest properties.
- experimental type AppManifestParsedProperties extends object
- properties
- # Computed scope value
- string scope
- # Layout viewport position and dimensions.
- type LayoutViewport extends object
- properties
- # Horizontal offset relative to the document (CSS pixels).
- integer pageX
- # Vertical offset relative to the document (CSS pixels).
- integer pageY
- # Width (CSS pixels), excludes scrollbar if present.
- integer clientWidth
- # Height (CSS pixels), excludes scrollbar if present.
- integer clientHeight
- # Visual viewport position, dimensions, and scale.
- type VisualViewport extends object
- properties
- # Horizontal offset relative to the layout viewport (CSS pixels).
- number offsetX
- # Vertical offset relative to the layout viewport (CSS pixels).
- number offsetY
- # Horizontal offset relative to the document (CSS pixels).
- number pageX
- # Vertical offset relative to the document (CSS pixels).
- number pageY
- # Width (CSS pixels), excludes scrollbar if present.
- number clientWidth
- # Height (CSS pixels), excludes scrollbar if present.
- number clientHeight
- # Scale relative to the ideal viewport (size at width=device-width).
- number scale
- # Page zoom factor (CSS to device independent pixels ratio).
- optional number zoom
- # Viewport for capturing screenshot.
- type Viewport extends object
- properties
- # X offset in device independent pixels (dip).
- number x
- # Y offset in device independent pixels (dip).
- number y
- # Rectangle width in device independent pixels (dip).
- number width
- # Rectangle height in device independent pixels (dip).
- number height
- # Page scale factor.
- number scale
- # Generic font families collection.
- experimental type FontFamilies extends object
- properties
- # The standard font-family.
- optional string standard
- # The fixed font-family.
- optional string fixed
- # The serif font-family.
- optional string serif
- # The sansSerif font-family.
- optional string sansSerif
- # The cursive font-family.
- optional string cursive
- # The fantasy font-family.
- optional string fantasy
- # The math font-family.
- optional string math
- # Font families collection for a script.
- experimental type ScriptFontFamilies extends object
- properties
- # Name of the script which these font families are defined for.
- string script
- # Generic font families collection for the script.
- FontFamilies fontFamilies
- # Default font sizes.
- experimental type FontSizes extends object
- properties
- # Default standard font size.
- optional integer standard
- # Default fixed font size.
- optional integer fixed
- experimental type ClientNavigationReason extends string
- enum
- formSubmissionGet
- formSubmissionPost
- httpHeaderRefresh
- scriptInitiated
- metaTagRefresh
- pageBlockInterstitial
- reload
- anchorClick
- experimental type ClientNavigationDisposition extends string
- enum
- currentTab
- newTab
- newWindow
- download
- experimental type InstallabilityErrorArgument extends object
- properties
- # Argument name (e.g. name:'minimum-icon-size-in-pixels').
- string name
- # Argument value (e.g. value:'64').
- string value
- # The installability error
- experimental type InstallabilityError extends object
- properties
- # The error id (e.g. 'manifest-missing-suitable-icon').
- string errorId
- # The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).
- array of InstallabilityErrorArgument errorArguments
- # The referring-policy used for the navigation.
- experimental type ReferrerPolicy extends string
- enum
- noReferrer
- noReferrerWhenDowngrade
- origin
- originWhenCrossOrigin
- sameOrigin
- strictOrigin
- strictOriginWhenCrossOrigin
- unsafeUrl
- # Per-script compilation cache parameters for `Page.produceCompilationCache`
- experimental type CompilationCacheParams extends object
- properties
- # The URL of the script to produce a compilation cache entry for.
- string url
- # A hint to the backend whether eager compilation is recommended.
- # (the actual compilation mode used is upon backend discretion).
- optional boolean eager
- # Deprecated, please use addScriptToEvaluateOnNewDocument instead.
- experimental deprecated command addScriptToEvaluateOnLoad
- parameters
- string scriptSource
- returns
- # Identifier of the added script.
- ScriptIdentifier identifier
- # Evaluates given script in every frame upon creation (before loading frame's scripts).
- command addScriptToEvaluateOnNewDocument
- parameters
- string source
- # If specified, creates an isolated world with the given name and evaluates given script in it.
- # This world name will be used as the ExecutionContextDescription::name when the corresponding
- # event is emitted.
- experimental optional string worldName
- # Specifies whether command line API should be available to the script, defaults
- # to false.
- experimental optional boolean includeCommandLineAPI
- returns
- # Identifier of the added script.
- ScriptIdentifier identifier
- # Brings page to front (activates tab).
- command bringToFront
- # Capture page screenshot.
- command captureScreenshot
- parameters
- # Image compression format (defaults to png).
- optional enum format
- jpeg
- png
- webp
- # Compression quality from range [0..100] (jpeg only).
- optional integer quality
- # Capture the screenshot of a given region only.
- optional Viewport clip
- # Capture the screenshot from the surface, rather than the view. Defaults to true.
- experimental optional boolean fromSurface
- # Capture the screenshot beyond the viewport. Defaults to false.
- experimental optional boolean captureBeyondViewport
- # Optimize image encoding for speed, not for resulting size (defaults to false)
- experimental optional boolean optimizeForSpeed
- returns
- # Base64-encoded image data.
- binary data
- # Returns a snapshot of the page as a string. For MHTML format, the serialization includes
- # iframes, shadow DOM, external resources, and element-inline styles.
- experimental command captureSnapshot
- parameters
- # Format (defaults to mhtml).
- optional enum format
- mhtml
- returns
- # Serialized page data.
- string data
- # Clears the overridden device metrics.
- experimental deprecated command clearDeviceMetricsOverride
- # Use 'Emulation.clearDeviceMetricsOverride' instead
- redirect Emulation
- # Clears the overridden Device Orientation.
- experimental deprecated command clearDeviceOrientationOverride
- # Use 'DeviceOrientation.clearDeviceOrientationOverride' instead
- redirect DeviceOrientation
- # Clears the overridden Geolocation Position and Error.
- deprecated command clearGeolocationOverride
- # Use 'Emulation.clearGeolocationOverride' instead
- redirect Emulation
- # Creates an isolated world for the given frame.
- command createIsolatedWorld
- parameters
- # Id of the frame in which the isolated world should be created.
- FrameId frameId
- # An optional name which is reported in the Execution Context.
- optional string worldName
- # Whether or not universal access should be granted to the isolated world. This is a powerful
- # option, use with caution.
- optional boolean grantUniveralAccess
- returns
- # Execution context of the isolated world.
- Runtime.ExecutionContextId executionContextId
- # Deletes browser cookie with given name, domain and path.
- experimental deprecated command deleteCookie
- # Use 'Network.deleteCookie' instead
- redirect Network
- parameters
- # Name of the cookie to remove.
- string cookieName
- # URL to match cooke domain and path.
- string url
- # Disables page domain notifications.
- command disable
- # Enables page domain notifications.
- command enable
- command getAppManifest
- returns
- # Manifest location.
- string url
- array of AppManifestError errors
- # Manifest content.
- optional string data
- # Parsed manifest properties
- experimental optional AppManifestParsedProperties parsed
- experimental command getInstallabilityErrors
- returns
- array of InstallabilityError installabilityErrors
- # Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.
- experimental deprecated command getManifestIcons
- returns
- optional binary primaryIcon
- # Returns the unique (PWA) app id.
- # Only returns values if the feature flag 'WebAppEnableManifestId' is enabled
- experimental command getAppId
- returns
- # App id, either from manifest's id attribute or computed from start_url
- optional string appId
- # Recommendation for manifest's id attribute to match current id computed from start_url
- optional string recommendedId
- experimental command getAdScriptId
- parameters
- FrameId frameId
- returns
- # Identifies the bottom-most script which caused the frame to be labelled
- # as an ad. Only sent if frame is labelled as an ad and id is available.
- optional AdScriptId adScriptId
- # Returns all browser cookies for the page and all of its subframes. Depending
- # on the backend support, will return detailed cookie information in the
- # `cookies` field.
- experimental deprecated command getCookies
- # Use 'Network.getCookies' instead
- redirect Network
- returns
- # Array of cookie objects.
- array of Network.Cookie cookies
- # Returns present frame tree structure.
- command getFrameTree
- returns
- # Present frame tree structure.
- FrameTree frameTree
- # Returns metrics relating to the layouting of the page, such as viewport bounds/scale.
- command getLayoutMetrics
- returns
- # Deprecated metrics relating to the layout viewport. Is in device pixels. Use `cssLayoutViewport` instead.
- deprecated LayoutViewport layoutViewport
- # Deprecated metrics relating to the visual viewport. Is in device pixels. Use `cssVisualViewport` instead.
- deprecated VisualViewport visualViewport
- # Deprecated size of scrollable area. Is in DP. Use `cssContentSize` instead.
- deprecated DOM.Rect contentSize
- # Metrics relating to the layout viewport in CSS pixels.
- LayoutViewport cssLayoutViewport
- # Metrics relating to the visual viewport in CSS pixels.
- VisualViewport cssVisualViewport
- # Size of scrollable area in CSS pixels.
- DOM.Rect cssContentSize
- # Returns navigation history for the current page.
- command getNavigationHistory
- returns
- # Index of the current navigation history entry.
- integer currentIndex
- # Array of navigation history entries.
- array of NavigationEntry entries
- # Resets navigation history for the current page.
- command resetNavigationHistory
- # Returns content of the given resource.
- experimental command getResourceContent
- parameters
- # Frame id to get resource for.
- FrameId frameId
- # URL of the resource to get content for.
- string url
- returns
- # Resource content.
- string content
- # True, if content was served as base64.
- boolean base64Encoded
- # Returns present frame / resource tree structure.
- experimental command getResourceTree
- returns
- # Present frame / resource tree structure.
- FrameResourceTree frameTree
- # Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).
- command handleJavaScriptDialog
- parameters
- # Whether to accept or dismiss the dialog.
- boolean accept
- # The text to enter into the dialog prompt before accepting. Used only if this is a prompt
- # dialog.
- optional string promptText
- # Navigates current page to the given URL.
- command navigate
- parameters
- # URL to navigate the page to.
- string url
- # Referrer URL.
- optional string referrer
- # Intended transition type.
- optional TransitionType transitionType
- # Frame id to navigate, if not specified navigates the top frame.
- optional FrameId frameId
- # Referrer-policy used for the navigation.
- experimental optional ReferrerPolicy referrerPolicy
- returns
- # Frame id that has navigated (or failed to navigate)
- FrameId frameId
- # Loader identifier. This is omitted in case of same-document navigation,
- # as the previously committed loaderId would not change.
- optional Network.LoaderId loaderId
- # User friendly error message, present if and only if navigation has failed.
- optional string errorText
- # Navigates current page to the given history entry.
- command navigateToHistoryEntry
- parameters
- # Unique id of the entry to navigate to.
- integer entryId
- # Print page as PDF.
- command printToPDF
- parameters
- # Paper orientation. Defaults to false.
- optional boolean landscape
- # Display header and footer. Defaults to false.
- optional boolean displayHeaderFooter
- # Print background graphics. Defaults to false.
- optional boolean printBackground
- # Scale of the webpage rendering. Defaults to 1.
- optional number scale
- # Paper width in inches. Defaults to 8.5 inches.
- optional number paperWidth
- # Paper height in inches. Defaults to 11 inches.
- optional number paperHeight
- # Top margin in inches. Defaults to 1cm (~0.4 inches).
- optional number marginTop
- # Bottom margin in inches. Defaults to 1cm (~0.4 inches).
- optional number marginBottom
- # Left margin in inches. Defaults to 1cm (~0.4 inches).
- optional number marginLeft
- # Right margin in inches. Defaults to 1cm (~0.4 inches).
- optional number marginRight
- # Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are
- # printed in the document order, not in the order specified, and no
- # more than once.
- # Defaults to empty string, which implies the entire document is printed.
- # The page numbers are quietly capped to actual page count of the
- # document, and ranges beyond the end of the document are ignored.
- # If this results in no pages to print, an error is reported.
- # It is an error to specify a range with start greater than end.
- optional string pageRanges
- # HTML template for the print header. Should be valid HTML markup with following
- # classes used to inject printing values into them:
- # - `date`: formatted print date
- # - `title`: document title
- # - `url`: document location
- # - `pageNumber`: current page number
- # - `totalPages`: total pages in the document
- #
- # For example, `<span class=title></span>` would generate span containing the title.
- optional string headerTemplate
- # HTML template for the print footer. Should use the same format as the `headerTemplate`.
- optional string footerTemplate
- # Whether or not to prefer page size as defined by css. Defaults to false,
- # in which case the content will be scaled to fit the paper size.
- optional boolean preferCSSPageSize
- # return as stream
- experimental optional enum transferMode
- ReturnAsBase64
- ReturnAsStream
- returns
- # Base64-encoded pdf data. Empty if |returnAsStream| is specified.
- binary data
- # A handle of the stream that holds resulting PDF data.
- experimental optional IO.StreamHandle stream
- # Reloads given page optionally ignoring the cache.
- command reload
- parameters
- # If true, browser cache is ignored (as if the user pressed Shift+refresh).
- optional boolean ignoreCache
- # If set, the script will be injected into all frames of the inspected page after reload.
- # Argument will be ignored if reloading dataURL origin.
- optional string scriptToEvaluateOnLoad
- # Deprecated, please use removeScriptToEvaluateOnNewDocument instead.
- experimental deprecated command removeScriptToEvaluateOnLoad
- parameters
- ScriptIdentifier identifier
- # Removes given script from the list.
- command removeScriptToEvaluateOnNewDocument
- parameters
- ScriptIdentifier identifier
- # Acknowledges that a screencast frame has been received by the frontend.
- experimental command screencastFrameAck
- parameters
- # Frame number.
- integer sessionId
- # Searches for given string in resource content.
- experimental command searchInResource
- parameters
- # Frame id for resource to search in.
- FrameId frameId
- # URL of the resource to search in.
- string url
- # String to search for.
- string query
- # If true, search is case sensitive.
- optional boolean caseSensitive
- # If true, treats string parameter as regex.
- optional boolean isRegex
- returns
- # List of search matches.
- array of Debugger.SearchMatch result
- # Enable Chrome's experimental ad filter on all sites.
- experimental command setAdBlockingEnabled
- parameters
- # Whether to block ads.
- boolean enabled
- # Enable page Content Security Policy by-passing.
- experimental command setBypassCSP
- parameters
- # Whether to bypass page CSP.
- boolean enabled
- # Get Permissions Policy state on given frame.
- experimental command getPermissionsPolicyState
- parameters
- FrameId frameId
- returns
- array of PermissionsPolicyFeatureState states
- # Get Origin Trials on given frame.
- experimental command getOriginTrials
- parameters
- FrameId frameId
- returns
- array of OriginTrial originTrials
- # Overrides the values of device screen dimensions (window.screen.width, window.screen.height,
- # window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media
- # query results).
- experimental deprecated command setDeviceMetricsOverride
- # Use 'Emulation.setDeviceMetricsOverride' instead
- redirect Emulation
- parameters
- # Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.
- integer width
- # Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.
- integer height
- # Overriding device scale factor value. 0 disables the override.
- number deviceScaleFactor
- # Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text
- # autosizing and more.
- boolean mobile
- # Scale to apply to resulting view image.
- optional number scale
- # Overriding screen width value in pixels (minimum 0, maximum 10000000).
- optional integer screenWidth
- # Overriding screen height value in pixels (minimum 0, maximum 10000000).
- optional integer screenHeight
- # Overriding view X position on screen in pixels (minimum 0, maximum 10000000).
- optional integer positionX
- # Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).
- optional integer positionY
- # Do not set visible view size, rely upon explicit setVisibleSize call.
- optional boolean dontSetVisibleSize
- # Screen orientation override.
- optional Emulation.ScreenOrientation screenOrientation
- # The viewport dimensions and scale. If not set, the override is cleared.
- optional Viewport viewport
- # Overrides the Device Orientation.
- experimental deprecated command setDeviceOrientationOverride
- # Use 'DeviceOrientation.setDeviceOrientationOverride' instead
- redirect DeviceOrientation
- parameters
- # Mock alpha
- number alpha
- # Mock beta
- number beta
- # Mock gamma
- number gamma
- # Set generic font families.
- experimental command setFontFamilies
- parameters
- # Specifies font families to set. If a font family is not specified, it won't be changed.
- FontFamilies fontFamilies
- # Specifies font families to set for individual scripts.
- optional array of ScriptFontFamilies forScripts
- # Set default font sizes.
- experimental command setFontSizes
- parameters
- # Specifies font sizes to set. If a font size is not specified, it won't be changed.
- FontSizes fontSizes
- # Sets given markup as the document's HTML.
- command setDocumentContent
- parameters
- # Frame id to set HTML for.
- FrameId frameId
- # HTML content to set.
- string html
- # Set the behavior when downloading a file.
- experimental deprecated command setDownloadBehavior
- parameters
- # Whether to allow all or deny all download requests, or use default Chrome behavior if
- # available (otherwise deny).
- enum behavior
- deny
- allow
- default
- # The default path to save downloaded files to. This is required if behavior is set to 'allow'
- optional string downloadPath
- # Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position
- # unavailable.
- deprecated command setGeolocationOverride
- # Use 'Emulation.setGeolocationOverride' instead
- redirect Emulation
- parameters
- # Mock latitude
- optional number latitude
- # Mock longitude
- optional number longitude
- # Mock accuracy
- optional number accuracy
- # Controls whether page will emit lifecycle events.
- experimental command setLifecycleEventsEnabled
- parameters
- # If true, starts emitting lifecycle events.
- boolean enabled
- # Toggles mouse event-based touch event emulation.
- experimental deprecated command setTouchEmulationEnabled
- # Use 'Emulation.setTouchEmulationEnabled' instead
- redirect Emulation
- parameters
- # Whether the touch event emulation should be enabled.
- boolean enabled
- # Touch/gesture events configuration. Default: current platform.
- optional enum configuration
- mobile
- desktop
- # Starts sending each frame using the `screencastFrame` event.
- experimental command startScreencast
- parameters
- # Image compression format.
- optional enum format
- jpeg
- png
- # Compression quality from range [0..100].
- optional integer quality
- # Maximum screenshot width.
- optional integer maxWidth
- # Maximum screenshot height.
- optional integer maxHeight
- # Send every n-th frame.
- optional integer everyNthFrame
- # Force the page stop all navigations and pending resource fetches.
- command stopLoading
- # Crashes renderer on the IO thread, generates minidumps.
- experimental command crash
- # Tries to close page, running its beforeunload hooks, if any.
- experimental command close
- # Tries to update the web lifecycle state of the page.
- # It will transition the page to the given state according to:
- # https://github.com/WICG/web-lifecycle/
- experimental command setWebLifecycleState
- parameters
- # Target lifecycle state
- enum state
- frozen
- active
- # Stops sending each frame in the `screencastFrame`.
- experimental command stopScreencast
- # Requests backend to produce compilation cache for the specified scripts.
- # `scripts` are appeneded to the list of scripts for which the cache
- # would be produced. The list may be reset during page navigation.
- # When script with a matching URL is encountered, the cache is optionally
- # produced upon backend discretion, based on internal heuristics.
- # See also: `Page.compilationCacheProduced`.
- experimental command produceCompilationCache
- parameters
- array of CompilationCacheParams scripts
- # Seeds compilation cache for given url. Compilation cache does not survive
- # cross-process navigation.
- experimental command addCompilationCache
- parameters
- string url
- # Base64-encoded data
- binary data
- # Clears seeded compilation cache.
- experimental command clearCompilationCache
- # Enum of possible auto-reponse for permisison / prompt dialogs.
- experimental type AutoResponseMode extends string
- enum
- none
- autoAccept
- autoReject
- autoOptOut
- # Sets the Secure Payment Confirmation transaction mode.
- # https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode
- experimental command setSPCTransactionMode
- parameters
- AutoResponseMode mode
- # Extensions for Custom Handlers API:
- # https://html.spec.whatwg.org/multipage/system-state.html#rph-automation
- experimental command setRPHRegistrationMode
- parameters
- AutoResponseMode mode
- # Generates a report for testing.
- experimental command generateTestReport
- parameters
- # Message to be displayed in the report.
- string message
- # Specifies the endpoint group to deliver the report to.
- optional string group
- # Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.
- experimental command waitForDebugger
- # Intercept file chooser requests and transfer control to protocol clients.
- # When file chooser interception is enabled, native file chooser dialog is not shown.
- # Instead, a protocol event `Page.fileChooserOpened` is emitted.
- experimental command setInterceptFileChooserDialog
- parameters
- boolean enabled
- event domContentEventFired
- parameters
- Network.MonotonicTime timestamp
- # Emitted only when `page.interceptFileChooser` is enabled.
- event fileChooserOpened
- parameters
- # Id of the frame containing input node.
- experimental FrameId frameId
- # Input mode.
- enum mode
- selectSingle
- selectMultiple
- # Input node id. Only present for file choosers opened via an <input type="file"> element.
- experimental optional DOM.BackendNodeId backendNodeId
- # Fired when frame has been attached to its parent.
- event frameAttached
- parameters
- # Id of the frame that has been attached.
- FrameId frameId
- # Parent frame identifier.
- FrameId parentFrameId
- # JavaScript stack trace of when frame was attached, only set if frame initiated from script.
- optional Runtime.StackTrace stack
- # Fired when frame no longer has a scheduled navigation.
- deprecated event frameClearedScheduledNavigation
- parameters
- # Id of the frame that has cleared its scheduled navigation.
- FrameId frameId
- # Fired when frame has been detached from its parent.
- event frameDetached
- parameters
- # Id of the frame that has been detached.
- FrameId frameId
- experimental enum reason
- # The frame is removed from the DOM.
- remove
- # The frame is being swapped out in favor of an out-of-process iframe.
- # A new frame target will be created (see Target.attachedToTarget).
- swap
- # The type of a frameNavigated event.
- experimental type NavigationType extends string
- enum
- Navigation
- BackForwardCacheRestore
- # Fired once navigation of the frame has completed. Frame is now associated with the new loader.
- event frameNavigated
- parameters
- # Frame object.
- Frame frame
- experimental NavigationType type
- # Fired when opening document to write to.
- experimental event documentOpened
- parameters
- # Frame object.
- Frame frame
- experimental event frameResized
- # Fired when a renderer-initiated navigation is requested.
- # Navigation may still be cancelled after the event is issued.
- experimental event frameRequestedNavigation
- parameters
- # Id of the frame that is being navigated.
- FrameId frameId
- # The reason for the navigation.
- ClientNavigationReason reason
- # The destination URL for the requested navigation.
- string url
- # The disposition for the navigation.
- ClientNavigationDisposition disposition
- # Fired when frame schedules a potential navigation.
- deprecated event frameScheduledNavigation
- parameters
- # Id of the frame that has scheduled a navigation.
- FrameId frameId
- # Delay (in seconds) until the navigation is scheduled to begin. The navigation is not
- # guaranteed to start.
- number delay
- # The reason for the navigation.
- ClientNavigationReason reason
- # The destination URL for the scheduled navigation.
- string url
- # Fired when frame has started loading.
- experimental event frameStartedLoading
- parameters
- # Id of the frame that has started loading.
- FrameId frameId
- # Fired when frame has stopped loading.
- experimental event frameStoppedLoading
- parameters
- # Id of the frame that has stopped loading.
- FrameId frameId
- # Fired when page is about to start a download.
- # Deprecated. Use Browser.downloadWillBegin instead.
- experimental deprecated event downloadWillBegin
- parameters
- # Id of the frame that caused download to begin.
- FrameId frameId
- # Global unique identifier of the download.
- string guid
- # URL of the resource being downloaded.
- string url
- # Suggested file name of the resource (the actual name of the file saved on disk may differ).
- string suggestedFilename
- # Fired when download makes progress. Last call has |done| == true.
- # Deprecated. Use Browser.downloadProgress instead.
- experimental deprecated event downloadProgress
- parameters
- # Global unique identifier of the download.
- string guid
- # Total expected bytes to download.
- number totalBytes
- # Total bytes received.
- number receivedBytes
- # Download status.
- enum state
- inProgress
- completed
- canceled
- # Fired when interstitial page was hidden
- event interstitialHidden
- # Fired when interstitial page was shown
- event interstitialShown
- # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
- # closed.
- event javascriptDialogClosed
- parameters
- # Whether dialog was confirmed.
- boolean result
- # User input in case of prompt.
- string userInput
- # Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
- # open.
- event javascriptDialogOpening
- parameters
- # Frame url.
- string url
- # Message that will be displayed by the dialog.
- string message
- # Dialog type.
- DialogType type
- # True iff browser is capable showing or acting on the given dialog. When browser has no
- # dialog handler for given target, calling alert while Page domain is engaged will stall
- # the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.
- boolean hasBrowserHandler
- # Default dialog prompt.
- optional string defaultPrompt
- # Fired for top level page lifecycle events such as navigation, load, paint, etc.
- event lifecycleEvent
- parameters
- # Id of the frame.
- FrameId frameId
- # Loader identifier. Empty string if the request is fetched from worker.
- Network.LoaderId loaderId
- string name
- Network.MonotonicTime timestamp
- # List of not restored reasons for back-forward cache.
- experimental type BackForwardCacheNotRestoredReason extends string
- enum
- NotPrimaryMainFrame
- BackForwardCacheDisabled
- RelatedActiveContentsExist
- HTTPStatusNotOK
- SchemeNotHTTPOrHTTPS
- Loading
- WasGrantedMediaAccess
- DisableForRenderFrameHostCalled
- DomainNotAllowed
- HTTPMethodNotGET
- SubframeIsNavigating
- Timeout
- CacheLimit
- JavaScriptExecution
- RendererProcessKilled
- RendererProcessCrashed
- SchedulerTrackedFeatureUsed
- ConflictingBrowsingInstance
- CacheFlushed
- ServiceWorkerVersionActivation
- SessionRestored
- ServiceWorkerPostMessage
- EnteredBackForwardCacheBeforeServiceWorkerHostAdded
- RenderFrameHostReused_SameSite
- RenderFrameHostReused_CrossSite
- ServiceWorkerClaim
- IgnoreEventAndEvict
- HaveInnerContents
- TimeoutPuttingInCache
- BackForwardCacheDisabledByLowMemory
- BackForwardCacheDisabledByCommandLine
- NetworkRequestDatapipeDrainedAsBytesConsumer
- NetworkRequestRedirected
- NetworkRequestTimeout
- NetworkExceedsBufferLimit
- NavigationCancelledWhileRestoring
- NotMostRecentNavigationEntry
- BackForwardCacheDisabledForPrerender
- UserAgentOverrideDiffers
- ForegroundCacheLimit
- BrowsingInstanceNotSwapped
- BackForwardCacheDisabledForDelegate
- UnloadHandlerExistsInMainFrame
- UnloadHandlerExistsInSubFrame
- ServiceWorkerUnregistration
- CacheControlNoStore
- CacheControlNoStoreCookieModified
- CacheControlNoStoreHTTPOnlyCookieModified
- NoResponseHead
- Unknown
- ActivationNavigationsDisallowedForBug1234857
- ErrorDocument
- FencedFramesEmbedder
- #Blocklisted features
- WebSocket
- WebTransport
- WebRTC
- MainResourceHasCacheControlNoStore
- MainResourceHasCacheControlNoCache
- SubresourceHasCacheControlNoStore
- SubresourceHasCacheControlNoCache
- ContainsPlugins
- DocumentLoaded
- DedicatedWorkerOrWorklet
- OutstandingNetworkRequestOthers
- OutstandingIndexedDBTransaction
- RequestedMIDIPermission
- RequestedAudioCapturePermission
- RequestedVideoCapturePermission
- RequestedBackForwardCacheBlockedSensors
- RequestedBackgroundWorkPermission
- BroadcastChannel
- IndexedDBConnection
- WebXR
- SharedWorker
- WebLocks
- WebHID
- WebShare
- RequestedStorageAccessGrant
- WebNfc
- OutstandingNetworkRequestFetch
- OutstandingNetworkRequestXHR
- AppBanner
- Printing
- WebDatabase
- PictureInPicture
- Portal
- SpeechRecognizer
- IdleManager
- PaymentManager
- SpeechSynthesis
- KeyboardLock
- WebOTPService
- OutstandingNetworkRequestDirectSocket
- InjectedJavascript
- InjectedStyleSheet
- KeepaliveRequest
- IndexedDBEvent
- Dummy
- AuthorizationHeader
- # Disabled for RenderFrameHost reasons
- # See content/browser/renderer_host/back_forward_cache_disable.h for explanations.
- ContentSecurityHandler
- ContentWebAuthenticationAPI
- ContentFileChooser
- ContentSerial
- ContentFileSystemAccess
- ContentMediaDevicesDispatcherHost
- ContentWebBluetooth
- ContentWebUSB
- ContentMediaSessionService
- ContentScreenReader
- # See components/back_forward_cache/back_forward_cache_disable.h for explanations.
- EmbedderPopupBlockerTabHelper
- EmbedderSafeBrowsingTriggeredPopupBlocker
- EmbedderSafeBrowsingThreatDetails
- EmbedderAppBannerManager
- EmbedderDomDistillerViewerSource
- EmbedderDomDistillerSelfDeletingRequestDelegate
- EmbedderOomInterventionTabHelper
- EmbedderOfflinePage
- EmbedderChromePasswordManagerClientBindCredentialManager
- EmbedderPermissionRequestManager
- EmbedderModalDialog
- EmbedderExtensions
- EmbedderExtensionMessaging
- EmbedderExtensionMessagingForOpenPort
- EmbedderExtensionSentMessageToCachedFrame
- # Types of not restored reasons for back-forward cache.
- experimental type BackForwardCacheNotRestoredReasonType extends string
- enum
- SupportPending
- PageSupportNeeded
- Circumstantial
- experimental type BackForwardCacheNotRestoredExplanation extends object
- properties
- # Type of the reason
- BackForwardCacheNotRestoredReasonType type
- # Not restored reason
- BackForwardCacheNotRestoredReason reason
- # Context associated with the reason. The meaning of this context is
- # dependent on the reason:
- # - EmbedderExtensionSentMessageToCachedFrame: the extension ID.
- #
- optional string context
- experimental type BackForwardCacheNotRestoredExplanationTree extends object
- properties
- # URL of each frame
- string url
- # Not restored reasons of each frame
- array of BackForwardCacheNotRestoredExplanation explanations
- # Array of children frame
- array of BackForwardCacheNotRestoredExplanationTree children
- # Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do
- # not assume any ordering with the Page.frameNavigated event. This event is fired only for
- # main-frame history navigation where the document changes (non-same-document navigations),
- # when bfcache navigation fails.
- experimental event backForwardCacheNotUsed
- parameters
- # The loader id for the associated navgation.
- Network.LoaderId loaderId
- # The frame id of the associated frame.
- FrameId frameId
- # Array of reasons why the page could not be cached. This must not be empty.
- array of BackForwardCacheNotRestoredExplanation notRestoredExplanations
- # Tree structure of reasons why the page could not be cached for each frame.
- optional BackForwardCacheNotRestoredExplanationTree notRestoredExplanationsTree
- event loadEventFired
- parameters
- Network.MonotonicTime timestamp
- # Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
- experimental event navigatedWithinDocument
- parameters
- # Id of the frame.
- FrameId frameId
- # Frame's new url.
- string url
- # Compressed image data requested by the `startScreencast`.
- experimental event screencastFrame
- parameters
- # Base64-encoded compressed image.
- binary data
- # Screencast frame metadata.
- ScreencastFrameMetadata metadata
- # Frame number.
- integer sessionId
- # Fired when the page with currently enabled screencast was shown or hidden `.
- experimental event screencastVisibilityChanged
- parameters
- # True if the page is visible.
- boolean visible
- # Fired when a new window is going to be opened, via window.open(), link click, form submission,
- # etc.
- event windowOpen
- parameters
- # The URL for the new window.
- string url
- # Window name.
- string windowName
- # An array of enabled window features.
- array of string windowFeatures
- # Whether or not it was triggered by user gesture.
- boolean userGesture
- # Issued for every compilation cache generated. Is only available
- # if Page.setGenerateCompilationCache is enabled.
- experimental event compilationCacheProduced
- parameters
- string url
- # Base64-encoded data
- binary data
- domain Performance
- # Run-time execution metric.
- type Metric extends object
- properties
- # Metric name.
- string name
- # Metric value.
- number value
- # Disable collecting and reporting metrics.
- command disable
- # Enable collecting and reporting metrics.
- command enable
- parameters
- # Time domain to use for collecting and reporting duration metrics.
- optional enum timeDomain
- # Use monotonically increasing abstract time (default).
- timeTicks
- # Use thread running time.
- threadTicks
- # Sets time domain to use for collecting and reporting duration metrics.
- # Note that this must be called before enabling metrics collection. Calling
- # this method while metrics collection is enabled returns an error.
- experimental deprecated command setTimeDomain
- parameters
- # Time domain
- enum timeDomain
- # Use monotonically increasing abstract time (default).
- timeTicks
- # Use thread running time.
- threadTicks
- # Retrieve current values of run-time metrics.
- command getMetrics
- returns
- # Current values for run-time metrics.
- array of Metric metrics
- # Current values of the metrics.
- event metrics
- parameters
- # Current values of the metrics.
- array of Metric metrics
- # Timestamp title.
- string title
- # Reporting of performance timeline events, as specified in
- # https://w3c.github.io/performance-timeline/#dom-performanceobserver.
- experimental domain PerformanceTimeline
- depends on DOM
- depends on Network
- # See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl
- type LargestContentfulPaint extends object
- properties
- Network.TimeSinceEpoch renderTime
- Network.TimeSinceEpoch loadTime
- # The number of pixels being painted.
- number size
- # The id attribute of the element, if available.
- optional string elementId
- # The URL of the image (may be trimmed).
- optional string url
- optional DOM.BackendNodeId nodeId
- type LayoutShiftAttribution extends object
- properties
- DOM.Rect previousRect
- DOM.Rect currentRect
- optional DOM.BackendNodeId nodeId
- # See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl
- type LayoutShift extends object
- properties
- # Score increment produced by this event.
- number value
- boolean hadRecentInput
- Network.TimeSinceEpoch lastInputTime
- array of LayoutShiftAttribution sources
- type TimelineEvent extends object
- properties
- # Identifies the frame that this event is related to. Empty for non-frame targets.
- Page.FrameId frameId
- # The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
- # This determines which of the optional "details" fiedls is present.
- string type
- # Name may be empty depending on the type.
- string name
- # Time in seconds since Epoch, monotonically increasing within document lifetime.
- Network.TimeSinceEpoch time
- # Event duration, if applicable.
- optional number duration
- optional LargestContentfulPaint lcpDetails
- optional LayoutShift layoutShiftDetails
- # Previously buffered events would be reported before method returns.
- # See also: timelineEventAdded
- command enable
- parameters
- # The types of event to report, as specified in
- # https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
- # The specified filter overrides any previous filters, passing empty
- # filter disables recording.
- # Note that not all types exposed to the web platform are currently supported.
- array of string eventTypes
- # Sent when a performance timeline event is added. See reportPerformanceTimeline method.
- event timelineEventAdded
- parameters
- TimelineEvent event
- # Security
- domain Security
- # An internal certificate ID value.
- type CertificateId extends integer
- # A description of mixed content (HTTP resources on HTTPS pages), as defined by
- # https://www.w3.org/TR/mixed-content/#categories
- type MixedContentType extends string
- enum
- blockable
- optionally-blockable
- none
- # The security level of a page or resource.
- type SecurityState extends string
- enum
- unknown
- neutral
- insecure
- secure
- info
- insecure-broken
- # Details about the security state of the page certificate.
- experimental type CertificateSecurityState extends object
- properties
- # Protocol name (e.g. "TLS 1.2" or "QUIC").
- string protocol
- # Key Exchange used by the connection, or the empty string if not applicable.
- string keyExchange
- # (EC)DH group used by the connection, if applicable.
- optional string keyExchangeGroup
- # Cipher name.
- string cipher
- # TLS MAC. Note that AEAD ciphers do not have separate MACs.
- optional string mac
- # Page certificate.
- array of string certificate
- # Certificate subject name.
- string subjectName
- # Name of the issuing CA.
- string issuer
- # Certificate valid from date.
- Network.TimeSinceEpoch validFrom
- # Certificate valid to (expiration) date
- Network.TimeSinceEpoch validTo
- # The highest priority network error code, if the certificate has an error.
- optional string certificateNetworkError
- # True if the certificate uses a weak signature aglorithm.
- boolean certificateHasWeakSignature
- # True if the certificate has a SHA1 signature in the chain.
- boolean certificateHasSha1Signature
- # True if modern SSL
- boolean modernSSL
- # True if the connection is using an obsolete SSL protocol.
- boolean obsoleteSslProtocol
- # True if the connection is using an obsolete SSL key exchange.
- boolean obsoleteSslKeyExchange
- # True if the connection is using an obsolete SSL cipher.
- boolean obsoleteSslCipher
- # True if the connection is using an obsolete SSL signature.
- boolean obsoleteSslSignature
- experimental type SafetyTipStatus extends string
- enum
- badReputation
- lookalike
- experimental type SafetyTipInfo extends object
- properties
- # Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
- SafetyTipStatus safetyTipStatus
- # The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
- optional string safeUrl
- # Security state information about the page.
- experimental type VisibleSecurityState extends object
- properties
- # The security level of the page.
- SecurityState securityState
- # Security state details about the page certificate.
- optional CertificateSecurityState certificateSecurityState
- # 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.
- optional SafetyTipInfo safetyTipInfo
- # Array of security state issues ids.
- array of string securityStateIssueIds
- # An explanation of an factor contributing to the security state.
- type SecurityStateExplanation extends object
- properties
- # Security state representing the severity of the factor being explained.
- SecurityState securityState
- # Title describing the type of factor.
- string title
- # Short phrase describing the type of factor.
- string summary
- # Full text explanation of the factor.
- string description
- # The type of mixed content described by the explanation.
- MixedContentType mixedContentType
- # Page certificate.
- array of string certificate
- # Recommendations to fix any issues.
- optional array of string recommendations
- # Information about insecure content on the page.
- deprecated type InsecureContentStatus extends object
- properties
- # Always false.
- boolean ranMixedContent
- # Always false.
- boolean displayedMixedContent
- # Always false.
- boolean containedMixedForm
- # Always false.
- boolean ranContentWithCertErrors
- # Always false.
- boolean displayedContentWithCertErrors
- # Always set to unknown.
- SecurityState ranInsecureContentStyle
- # Always set to unknown.
- SecurityState displayedInsecureContentStyle
- # The action to take when a certificate error occurs. continue will continue processing the
- # request and cancel will cancel the request.
- type CertificateErrorAction extends string
- enum
- continue
- cancel
- # Disables tracking security state changes.
- command disable
- # Enables tracking security state changes.
- command enable
- # Enable/disable whether all certificate errors should be ignored.
- experimental command setIgnoreCertificateErrors
- parameters
- # If true, all certificate errors will be ignored.
- boolean ignore
- # Handles a certificate error that fired a certificateError event.
- deprecated command handleCertificateError
- parameters
- # The ID of the event.
- integer eventId
- # The action to take on the certificate error.
- CertificateErrorAction action
- # Enable/disable overriding certificate errors. If enabled, all certificate error events need to
- # be handled by the DevTools client and should be answered with `handleCertificateError` commands.
- deprecated command setOverrideCertificateErrors
- parameters
- # If true, certificate errors will be overridden.
- boolean override
- # There is a certificate error. If overriding certificate errors is enabled, then it should be
- # handled with the `handleCertificateError` command. Note: this event does not fire if the
- # certificate error has been allowed internally. Only one client per target should override
- # certificate errors at the same time.
- deprecated event certificateError
- parameters
- # The ID of the event.
- integer eventId
- # The type of the error.
- string errorType
- # The url that was requested.
- string requestURL
- # The security state of the page changed.
- experimental event visibleSecurityStateChanged
- parameters
- # Security state information about the page.
- VisibleSecurityState visibleSecurityState
- # The security state of the page changed. No longer being sent.
- deprecated event securityStateChanged
- parameters
- # Security state.
- SecurityState securityState
- # True if the page was loaded over cryptographic transport such as HTTPS.
- deprecated boolean schemeIsCryptographic
- # Previously a list of explanations for the security state. Now always
- # empty.
- deprecated array of SecurityStateExplanation explanations
- # Information about insecure content on the page.
- deprecated InsecureContentStatus insecureContentStatus
- # Overrides user-visible description of the state. Always omitted.
- deprecated optional string summary
- experimental domain ServiceWorker
- depends on Target
- type RegistrationID extends string
- # ServiceWorker registration.
- type ServiceWorkerRegistration extends object
- properties
- RegistrationID registrationId
- string scopeURL
- boolean isDeleted
- type ServiceWorkerVersionRunningStatus extends string
- enum
- stopped
- starting
- running
- stopping
- type ServiceWorkerVersionStatus extends string
- enum
- new
- installing
- installed
- activating
- activated
- redundant
- # ServiceWorker version.
- type ServiceWorkerVersion extends object
- properties
- string versionId
- RegistrationID registrationId
- string scriptURL
- ServiceWorkerVersionRunningStatus runningStatus
- ServiceWorkerVersionStatus status
- # The Last-Modified header value of the main script.
- optional number scriptLastModified
- # The time at which the response headers of the main script were received from the server.
- # For cached script it is the last time the cache entry was validated.
- optional number scriptResponseTime
- optional array of Target.TargetID controlledClients
- optional Target.TargetID targetId
- # ServiceWorker error message.
- type ServiceWorkerErrorMessage extends object
- properties
- string errorMessage
- RegistrationID registrationId
- string versionId
- string sourceURL
- integer lineNumber
- integer columnNumber
- command deliverPushMessage
- parameters
- string origin
- RegistrationID registrationId
- string data
- command disable
- command dispatchSyncEvent
- parameters
- string origin
- RegistrationID registrationId
- string tag
- boolean lastChance
- command dispatchPeriodicSyncEvent
- parameters
- string origin
- RegistrationID registrationId
- string tag
- command enable
- command inspectWorker
- parameters
- string versionId
- command setForceUpdateOnPageLoad
- parameters
- boolean forceUpdateOnPageLoad
- command skipWaiting
- parameters
- string scopeURL
- command startWorker
- parameters
- string scopeURL
- command stopAllWorkers
- command stopWorker
- parameters
- string versionId
- command unregister
- parameters
- string scopeURL
- command updateRegistration
- parameters
- string scopeURL
- event workerErrorReported
- parameters
- ServiceWorkerErrorMessage errorMessage
- event workerRegistrationUpdated
- parameters
- array of ServiceWorkerRegistration registrations
- event workerVersionUpdated
- parameters
- array of ServiceWorkerVersion versions
- experimental domain Storage
- depends on Browser
- depends on Network
- type SerializedStorageKey extends string
- # Enum of possible storage types.
- type StorageType extends string
- enum
- appcache
- cookies
- file_systems
- indexeddb
- local_storage
- shader_cache
- websql
- service_workers
- cache_storage
- interest_groups
- shared_storage
- storage_buckets
- all
- other
- # Usage for a storage type.
- type UsageForType extends object
- properties
- # Name of storage type.
- StorageType storageType
- # Storage usage (bytes).
- number usage
- # Pair of issuer origin and number of available (signed, but not used) Trust
- # Tokens from that issuer.
- experimental type TrustTokens extends object
- properties
- string issuerOrigin
- number count
- # Enum of interest group access types.
- type InterestGroupAccessType extends string
- enum
- join
- leave
- update
- loaded
- bid
- win
- # Ad advertising element inside an interest group.
- type InterestGroupAd extends object
- properties
- string renderUrl
- optional string metadata
- # The full details of an interest group.
- type InterestGroupDetails extends object
- properties
- string ownerOrigin
- string name
- Network.TimeSinceEpoch expirationTime
- string joiningOrigin
- optional string biddingUrl
- optional string biddingWasmHelperUrl
- optional string updateUrl
- optional string trustedBiddingSignalsUrl
- array of string trustedBiddingSignalsKeys
- optional string userBiddingSignals
- array of InterestGroupAd ads
- array of InterestGroupAd adComponents
- # Enum of shared storage access types.
- type SharedStorageAccessType extends string
- enum
- documentAddModule
- documentSelectURL
- documentRun
- documentSet
- documentAppend
- documentDelete
- documentClear
- workletSet
- workletAppend
- workletDelete
- workletClear
- workletGet
- workletKeys
- workletEntries
- workletLength
- workletRemainingBudget
- # Struct for a single key-value pair in an origin's shared storage.
- type SharedStorageEntry extends object
- properties
- string key
- string value
- # Details for an origin's shared storage.
- type SharedStorageMetadata extends object
- properties
- Network.TimeSinceEpoch creationTime
- integer length
- number remainingBudget
- # Pair of reporting metadata details for a candidate URL for `selectURL()`.
- type SharedStorageReportingMetadata extends object
- properties
- string eventType
- string reportingUrl
- # Bundles a candidate URL with its reporting metadata.
- type SharedStorageUrlWithMetadata extends object
- properties
- # Spec of candidate URL.
- string url
- # Any associated reporting metadata.
- array of SharedStorageReportingMetadata reportingMetadata
- # Bundles the parameters for shared storage access events whose
- # presence/absence can vary according to SharedStorageAccessType.
- type SharedStorageAccessParams extends object
- properties
- # Spec of the module script URL.
- # Present only for SharedStorageAccessType.documentAddModule.
- optional string scriptSourceUrl
- # Name of the registered operation to be run.
- # Present only for SharedStorageAccessType.documentRun and
- # SharedStorageAccessType.documentSelectURL.
- optional string operationName
- # The operation's serialized data in bytes (converted to a string).
- # Present only for SharedStorageAccessType.documentRun and
- # SharedStorageAccessType.documentSelectURL.
- optional string serializedData
- # Array of candidate URLs' specs, along with any associated metadata.
- # Present only for SharedStorageAccessType.documentSelectURL.
- optional array of SharedStorageUrlWithMetadata urlsWithMetadata
- # Key for a specific entry in an origin's shared storage.
- # Present only for SharedStorageAccessType.documentSet,
- # SharedStorageAccessType.documentAppend,
- # SharedStorageAccessType.documentDelete,
- # SharedStorageAccessType.workletSet,
- # SharedStorageAccessType.workletAppend,
- # SharedStorageAccessType.workletDelete, and
- # SharedStorageAccessType.workletGet.
- optional string key
- # Value for a specific entry in an origin's shared storage.
- # Present only for SharedStorageAccessType.documentSet,
- # SharedStorageAccessType.documentAppend,
- # SharedStorageAccessType.workletSet, and
- # SharedStorageAccessType.workletAppend.
- optional string value
- # Whether or not to set an entry for a key if that key is already present.
- # Present only for SharedStorageAccessType.documentSet and
- # SharedStorageAccessType.workletSet.
- optional boolean ignoreIfPresent
- type StorageBucketsDurability extends string
- enum
- relaxed
- strict
- type StorageBucket extends object
- properties
- SerializedStorageKey storageKey
- # If not specified, it is the default bucket of the storageKey.
- optional string name
- type StorageBucketInfo extends object
- properties
- StorageBucket bucket
- string id
- Network.TimeSinceEpoch expiration
- # Storage quota (bytes).
- number quota
- boolean persistent
- StorageBucketsDurability durability
- # Returns a storage key given a frame id.
- command getStorageKeyForFrame
- parameters
- Page.FrameId frameId
- returns
- SerializedStorageKey storageKey
- # Clears storage for origin.
- command clearDataForOrigin
- parameters
- # Security origin.
- string origin
- # Comma separated list of StorageType to clear.
- string storageTypes
- # Clears storage for storage key.
- command clearDataForStorageKey
- parameters
- # Storage key.
- string storageKey
- # Comma separated list of StorageType to clear.
- string storageTypes
- # Returns all browser cookies.
- command getCookies
- parameters
- # Browser context to use when called on the browser endpoint.
- optional Browser.BrowserContextID browserContextId
- returns
- # Array of cookie objects.
- array of Network.Cookie cookies
- # Sets given cookies.
- command setCookies
- parameters
- # Cookies to be set.
- array of Network.CookieParam cookies
- # Browser context to use when called on the browser endpoint.
- optional Browser.BrowserContextID browserContextId
- # Clears cookies.
- command clearCookies
- parameters
- # Browser context to use when called on the browser endpoint.
- optional Browser.BrowserContextID browserContextId
- # Returns usage and quota in bytes.
- command getUsageAndQuota
- parameters
- # Security origin.
- string origin
- returns
- # Storage usage (bytes).
- number usage
- # Storage quota (bytes).
- number quota
- # Whether or not the origin has an active storage quota override
- boolean overrideActive
- # Storage usage per type (bytes).
- array of UsageForType usageBreakdown
- # Override quota for the specified origin
- experimental command overrideQuotaForOrigin
- parameters
- # Security origin.
- string origin
- # The quota size (in bytes) to override the original quota with.
- # If this is called multiple times, the overridden quota will be equal to
- # the quotaSize provided in the final call. If this is called without
- # specifying a quotaSize, the quota will be reset to the default value for
- # the specified origin. If this is called multiple times with different
- # origins, the override will be maintained for each origin until it is
- # disabled (called without a quotaSize).
- optional number quotaSize
- # Registers origin to be notified when an update occurs to its cache storage list.
- command trackCacheStorageForOrigin
- parameters
- # Security origin.
- string origin
- # Registers storage key to be notified when an update occurs to its cache storage list.
- command trackCacheStorageForStorageKey
- parameters
- # Storage key.
- string storageKey
- # Registers origin to be notified when an update occurs to its IndexedDB.
- command trackIndexedDBForOrigin
- parameters
- # Security origin.
- string origin
- # Registers storage key to be notified when an update occurs to its IndexedDB.
- command trackIndexedDBForStorageKey
- parameters
- # Storage key.
- string storageKey
- # Unregisters origin from receiving notifications for cache storage.
- command untrackCacheStorageForOrigin
- parameters
- # Security origin.
- string origin
- # Unregisters storage key from receiving notifications for cache storage.
- command untrackCacheStorageForStorageKey
- parameters
- # Storage key.
- string storageKey
- # Unregisters origin from receiving notifications for IndexedDB.
- command untrackIndexedDBForOrigin
- parameters
- # Security origin.
- string origin
- # Unregisters storage key from receiving notifications for IndexedDB.
- command untrackIndexedDBForStorageKey
- parameters
- # Storage key.
- string storageKey
- # Returns the number of stored Trust Tokens per issuer for the
- # current browsing context.
- experimental command getTrustTokens
- returns
- array of TrustTokens tokens
- # Removes all Trust Tokens issued by the provided issuerOrigin.
- # Leaves other stored data, including the issuer's Redemption Records, intact.
- experimental command clearTrustTokens
- parameters
- string issuerOrigin
- returns
- # True if any tokens were deleted, false otherwise.
- boolean didDeleteTokens
- # Gets details for a named interest group.
- experimental command getInterestGroupDetails
- parameters
- string ownerOrigin
- string name
- returns
- InterestGroupDetails details
- # Enables/Disables issuing of interestGroupAccessed events.
- experimental command setInterestGroupTracking
- parameters
- boolean enable
- # Gets metadata for an origin's shared storage.
- experimental command getSharedStorageMetadata
- parameters
- string ownerOrigin
- returns
- SharedStorageMetadata metadata
- # Gets the entries in an given origin's shared storage.
- experimental command getSharedStorageEntries
- parameters
- string ownerOrigin
- returns
- array of SharedStorageEntry entries
- # Sets entry with `key` and `value` for a given origin's shared storage.
- experimental command setSharedStorageEntry
- parameters
- string ownerOrigin
- string key
- string value
- # If `ignoreIfPresent` is included and true, then only sets the entry if
- # `key` doesn't already exist.
- optional boolean ignoreIfPresent
- # Deletes entry for `key` (if it exists) for a given origin's shared storage.
- experimental command deleteSharedStorageEntry
- parameters
- string ownerOrigin
- string key
- # Clears all entries for a given origin's shared storage.
- experimental command clearSharedStorageEntries
- parameters
- string ownerOrigin
- # Resets the budget for `ownerOrigin` by clearing all budget withdrawals.
- experimental command resetSharedStorageBudget
- parameters
- string ownerOrigin
- # Enables/disables issuing of sharedStorageAccessed events.
- experimental command setSharedStorageTracking
- parameters
- boolean enable
- # Set tracking for a storage key's buckets.
- experimental command setStorageBucketTracking
- parameters
- string storageKey
- boolean enable
- # Deletes the Storage Bucket with the given storage key and bucket name.
- experimental command deleteStorageBucket
- parameters
- StorageBucket bucket
- # Deletes state for sites identified as potential bounce trackers, immediately.
- experimental command runBounceTrackingMitigations
- returns
- array of string deletedSites
- # A cache's contents have been modified.
- event cacheStorageContentUpdated
- parameters
- # Origin to update.
- string origin
- # Storage key to update.
- string storageKey
- # Storage bucket to update.
- string bucketId
- # Name of cache in origin.
- string cacheName
- # A cache has been added/deleted.
- event cacheStorageListUpdated
- parameters
- # Origin to update.
- string origin
- # Storage key to update.
- string storageKey
- # Storage bucket to update.
- string bucketId
- # The origin's IndexedDB object store has been modified.
- event indexedDBContentUpdated
- parameters
- # Origin to update.
- string origin
- # Storage key to update.
- string storageKey
- # Storage bucket to update.
- string bucketId
- # Database to update.
- string databaseName
- # ObjectStore to update.
- string objectStoreName
- # The origin's IndexedDB database list has been modified.
- event indexedDBListUpdated
- parameters
- # Origin to update.
- string origin
- # Storage key to update.
- string storageKey
- # Storage bucket to update.
- string bucketId
- # One of the interest groups was accessed by the associated page.
- event interestGroupAccessed
- parameters
- Network.TimeSinceEpoch accessTime
- InterestGroupAccessType type
- string ownerOrigin
- string name
- # Shared storage was accessed by the associated page.
- # The following parameters are included in all events.
- event sharedStorageAccessed
- parameters
- # Time of the access.
- Network.TimeSinceEpoch accessTime
- # Enum value indicating the Shared Storage API method invoked.
- SharedStorageAccessType type
- # DevTools Frame Token for the primary frame tree's root.
- Page.FrameId mainFrameId
- # Serialized origin for the context that invoked the Shared Storage API.
- string ownerOrigin
- # The sub-parameters warapped by `params` are all optional and their
- # presence/absence depends on `type`.
- SharedStorageAccessParams params
- event storageBucketCreatedOrUpdated
- parameters
- StorageBucketInfo bucketInfo
- event storageBucketDeleted
- parameters
- string bucketId
- # The SystemInfo domain defines methods and events for querying low-level system information.
- experimental domain SystemInfo
- # Describes a single graphics processor (GPU).
- type GPUDevice extends object
- properties
- # PCI ID of the GPU vendor, if available; 0 otherwise.
- number vendorId
- # PCI ID of the GPU device, if available; 0 otherwise.
- number deviceId
- # Sub sys ID of the GPU, only available on Windows.
- optional number subSysId
- # Revision of the GPU, only available on Windows.
- optional number revision
- # String description of the GPU vendor, if the PCI ID is not available.
- string vendorString
- # String description of the GPU device, if the PCI ID is not available.
- string deviceString
- # String description of the GPU driver vendor.
- string driverVendor
- # String description of the GPU driver version.
- string driverVersion
- # Describes the width and height dimensions of an entity.
- type Size extends object
- properties
- # Width in pixels.
- integer width
- # Height in pixels.
- integer height
- # Describes a supported video decoding profile with its associated minimum and
- # maximum resolutions.
- type VideoDecodeAcceleratorCapability extends object
- properties
- # Video codec profile that is supported, e.g. VP9 Profile 2.
- string profile
- # Maximum video dimensions in pixels supported for this |profile|.
- Size maxResolution
- # Minimum video dimensions in pixels supported for this |profile|.
- Size minResolution
- # Describes a supported video encoding profile with its associated maximum
- # resolution and maximum framerate.
- type VideoEncodeAcceleratorCapability extends object
- properties
- # Video codec profile that is supported, e.g H264 Main.
- string profile
- # Maximum video dimensions in pixels supported for this |profile|.
- Size maxResolution
- # Maximum encoding framerate in frames per second supported for this
- # |profile|, as fraction's numerator and denominator, e.g. 24/1 fps,
- # 24000/1001 fps, etc.
- integer maxFramerateNumerator
- integer maxFramerateDenominator
- # YUV subsampling type of the pixels of a given image.
- type SubsamplingFormat extends string
- enum
- yuv420
- yuv422
- yuv444
- # Image format of a given image.
- type ImageType extends string
- enum
- jpeg
- webp
- unknown
- # Describes a supported image decoding profile with its associated minimum and
- # maximum resolutions and subsampling.
- type ImageDecodeAcceleratorCapability extends object
- properties
- # Image coded, e.g. Jpeg.
- ImageType imageType
- # Maximum supported dimensions of the image in pixels.
- Size maxDimensions
- # Minimum supported dimensions of the image in pixels.
- Size minDimensions
- # Optional array of supported subsampling formats, e.g. 4:2:0, if known.
- array of SubsamplingFormat subsamplings
- # Provides information about the GPU(s) on the system.
- type GPUInfo extends object
- properties
- # The graphics devices on the system. Element 0 is the primary GPU.
- array of GPUDevice devices
- # An optional dictionary of additional GPU related attributes.
- optional object auxAttributes
- # An optional dictionary of graphics features and their status.
- optional object featureStatus
- # An optional array of GPU driver bug workarounds.
- array of string driverBugWorkarounds
- # Supported accelerated video decoding capabilities.
- array of VideoDecodeAcceleratorCapability videoDecoding
- # Supported accelerated video encoding capabilities.
- array of VideoEncodeAcceleratorCapability videoEncoding
- # Supported accelerated image decoding capabilities.
- array of ImageDecodeAcceleratorCapability imageDecoding
- # Represents process info.
- type ProcessInfo extends object
- properties
- # Specifies process type.
- string type
- # Specifies process id.
- integer id
- # Specifies cumulative CPU usage in seconds across all threads of the
- # process since the process start.
- number cpuTime
- # Returns information about the system.
- command getInfo
- returns
- # Information about the GPUs on the system.
- GPUInfo gpu
- # A platform-dependent description of the model of the machine. On Mac OS, this is, for
- # example, 'MacBookPro'. Will be the empty string if not supported.
- string modelName
- # A platform-dependent description of the version of the machine. On Mac OS, this is, for
- # example, '10.1'. Will be the empty string if not supported.
- string modelVersion
- # The command line string used to launch the browser. Will be the empty string if not
- # supported.
- string commandLine
- # Returns information about the feature state.
- command getFeatureState
- parameters
- string featureState
- returns
- boolean featureEnabled
- # Returns information about all running processes.
- command getProcessInfo
- returns
- # An array of process info blocks.
- array of ProcessInfo processInfo
- # Supports additional targets discovery and allows to attach to them.
- domain Target
- type TargetID extends string
- # Unique identifier of attached debugging session.
- type SessionID extends string
- type TargetInfo extends object
- properties
- TargetID targetId
- string type
- string title
- string url
- # Whether the target has an attached client.
- boolean attached
- # Opener target Id
- optional TargetID openerId
- # Whether the target has access to the originating window.
- experimental boolean canAccessOpener
- # Frame id of originating window (is only set if target has an opener).
- experimental optional Page.FrameId openerFrameId
- experimental optional Browser.BrowserContextID browserContextId
- # Provides additional details for specific target types. For example, for
- # the type of "page", this may be set to "portal" or "prerender".
- experimental optional string subtype
- # A filter used by target query/discovery/auto-attach operations.
- experimental type FilterEntry extends object
- properties
- # If set, causes exclusion of mathcing targets from the list.
- optional boolean exclude
- # If not present, matches any type.
- optional string type
- # The entries in TargetFilter are matched sequentially against targets and
- # the first entry that matches determines if the target is included or not,
- # depending on the value of `exclude` field in the entry.
- # If filter is not specified, the one assumed is
- # [{type: "browser", exclude: true}, {type: "tab", exclude: true}, {}]
- # (i.e. include everything but `browser` and `tab`).
- experimental type TargetFilter extends array of FilterEntry
- experimental type RemoteLocation extends object
- properties
- string host
- integer port
- # Activates (focuses) the target.
- command activateTarget
- parameters
- TargetID targetId
- # Attaches to the target with given id.
- command attachToTarget
- parameters
- TargetID targetId
- # Enables "flat" access to the session via specifying sessionId attribute in the commands.
- # We plan to make this the default, deprecate non-flattened mode,
- # and eventually retire it. See crbug.com/991325.
- optional boolean flatten
- returns
- # Id assigned to the session.
- SessionID sessionId
- # Attaches to the browser target, only uses flat sessionId mode.
- experimental command attachToBrowserTarget
- returns
- # Id assigned to the session.
- SessionID sessionId
- # Closes the target. If the target is a page that gets closed too.
- command closeTarget
- parameters
- TargetID targetId
- returns
- # Always set to true. If an error occurs, the response indicates protocol error.
- deprecated boolean success
- # Inject object to the target's main frame that provides a communication
- # channel with browser target.
- #
- # Injected object will be available as `window[bindingName]`.
- #
- # The object has the follwing API:
- # - `binding.send(json)` - a method to send messages over the remote debugging protocol
- # - `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.
- experimental command exposeDevToolsProtocol
- parameters
- TargetID targetId
- # Binding name, 'cdp' if not specified.
- optional string bindingName
- # Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than
- # one.
- experimental command createBrowserContext
- parameters
- # If specified, disposes this context when debugging session disconnects.
- optional boolean disposeOnDetach
- # Proxy server, similar to the one passed to --proxy-server
- optional string proxyServer
- # Proxy bypass list, similar to the one passed to --proxy-bypass-list
- optional string proxyBypassList
- # An optional list of origins to grant unlimited cross-origin access to.
- # Parts of the URL other than those constituting origin are ignored.
- optional array of string originsWithUniversalNetworkAccess
- returns
- # The id of the context created.
- Browser.BrowserContextID browserContextId
- # Returns all browser contexts created with `Target.createBrowserContext` method.
- experimental command getBrowserContexts
- returns
- # An array of browser context ids.
- array of Browser.BrowserContextID browserContextIds
- # Creates a new page.
- command createTarget
- parameters
- # The initial URL the page will be navigated to. An empty string indicates about:blank.
- string url
- # Frame width in DIP (headless chrome only).
- optional integer width
- # Frame height in DIP (headless chrome only).
- optional integer height
- # The browser context to create the page in.
- experimental optional Browser.BrowserContextID browserContextId
- # Whether BeginFrames for this target will be controlled via DevTools (headless chrome only,
- # not supported on MacOS yet, false by default).
- experimental optional boolean enableBeginFrameControl
- # Whether to create a new Window or Tab (chrome-only, false by default).
- optional boolean newWindow
- # Whether to create the target in background or foreground (chrome-only,
- # false by default).
- optional boolean background
- # Whether to create the target of type "tab".
- experimental optional boolean forTab
- returns
- # The id of the page opened.
- TargetID targetId
- # Detaches session with given id.
- command detachFromTarget
- parameters
- # Session to detach.
- optional SessionID sessionId
- # Deprecated.
- deprecated optional TargetID targetId
- # Deletes a BrowserContext. All the belonging pages will be closed without calling their
- # beforeunload hooks.
- experimental command disposeBrowserContext
- parameters
- Browser.BrowserContextID browserContextId
- # Returns information about a target.
- experimental command getTargetInfo
- parameters
- optional TargetID targetId
- returns
- TargetInfo targetInfo
- # Retrieves a list of available targets.
- command getTargets
- parameters
- # Only targets matching filter will be reported. If filter is not specified
- # and target discovery is currently enabled, a filter used for target discovery
- # is used for consistency.
- experimental optional TargetFilter filter
- returns
- # The list of targets.
- array of TargetInfo targetInfos
- # Sends protocol message over session with given id.
- # Consider using flat mode instead; see commands attachToTarget, setAutoAttach,
- # and crbug.com/991325.
- deprecated command sendMessageToTarget
- parameters
- string message
- # Identifier of the session.
- optional SessionID sessionId
- # Deprecated.
- deprecated optional TargetID targetId
- # Controls whether to automatically attach to new targets which are considered to be related to
- # this one. When turned on, attaches to all existing related targets as well. When turned off,
- # automatically detaches from all currently attached targets.
- # This also clears all targets added by `autoAttachRelated` from the list of targets to watch
- # for creation of related targets.
- experimental command setAutoAttach
- parameters
- # Whether to auto-attach to related targets.
- boolean autoAttach
- # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
- # to run paused targets.
- boolean waitForDebuggerOnStart
- # Enables "flat" access to the session via specifying sessionId attribute in the commands.
- # We plan to make this the default, deprecate non-flattened mode,
- # and eventually retire it. See crbug.com/991325.
- optional boolean flatten
- # Only targets matching filter will be attached.
- experimental optional TargetFilter filter
- # Adds the specified target to the list of targets that will be monitored for any related target
- # creation (such as child frames, child workers and new versions of service worker) and reported
- # through `attachedToTarget`. The specified target is also auto-attached.
- # This cancels the effect of any previous `setAutoAttach` and is also cancelled by subsequent
- # `setAutoAttach`. Only available at the Browser target.
- experimental command autoAttachRelated
- parameters
- TargetID targetId
- # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
- # to run paused targets.
- boolean waitForDebuggerOnStart
- # Only targets matching filter will be attached.
- experimental optional TargetFilter filter
- # Controls whether to discover available targets and notify via
- # `targetCreated/targetInfoChanged/targetDestroyed` events.
- command setDiscoverTargets
- parameters
- # Whether to discover available targets.
- boolean discover
- # Only targets matching filter will be attached. If `discover` is false,
- # `filter` must be omitted or empty.
- experimental optional TargetFilter filter
- # Enables target discovery for the specified locations, when `setDiscoverTargets` was set to
- # `true`.
- experimental command setRemoteLocations
- parameters
- # List of remote locations.
- array of RemoteLocation locations
- # Issued when attached to target because of auto-attach or `attachToTarget` command.
- experimental event attachedToTarget
- parameters
- # Identifier assigned to the session used to send/receive messages.
- SessionID sessionId
- TargetInfo targetInfo
- boolean waitingForDebugger
- # Issued when detached from target for any reason (including `detachFromTarget` command). Can be
- # issued multiple times per target if multiple sessions have been attached to it.
- experimental event detachedFromTarget
- parameters
- # Detached session identifier.
- SessionID sessionId
- # Deprecated.
- deprecated optional TargetID targetId
- # Notifies about a new protocol message received from the session (as reported in
- # `attachedToTarget` event).
- event receivedMessageFromTarget
- parameters
- # Identifier of a session which sends a message.
- SessionID sessionId
- string message
- # Deprecated.
- deprecated optional TargetID targetId
- # Issued when a possible inspection target is created.
- event targetCreated
- parameters
- TargetInfo targetInfo
- # Issued when a target is destroyed.
- event targetDestroyed
- parameters
- TargetID targetId
- # Issued when a target has crashed.
- event targetCrashed
- parameters
- TargetID targetId
- # Termination status type.
- string status
- # Termination error code.
- integer errorCode
- # Issued when some information about a target has changed. This only happens between
- # `targetCreated` and `targetDestroyed`.
- event targetInfoChanged
- parameters
- TargetInfo targetInfo
- # The Tethering domain defines methods and events for browser port binding.
- experimental domain Tethering
- # Request browser port binding.
- command bind
- parameters
- # Port number to bind.
- integer port
- # Request browser port unbinding.
- command unbind
- parameters
- # Port number to unbind.
- integer port
- # Informs that port was successfully bound and got a specified connection id.
- event accepted
- parameters
- # Port number that was successfully bound.
- integer port
- # Connection id to be used.
- string connectionId
- experimental domain Tracing
- depends on IO
- # Configuration for memory dump. Used only when "memory-infra" category is enabled.
- type MemoryDumpConfig extends object
- type TraceConfig extends object
- properties
- # Controls how the trace buffer stores data.
- optional enum recordMode
- recordUntilFull
- recordContinuously
- recordAsMuchAsPossible
- echoToConsole
- # Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value
- # of 200 MB would be used.
- optional number traceBufferSizeInKb
- # Turns on JavaScript stack sampling.
- optional boolean enableSampling
- # Turns on system tracing.
- optional boolean enableSystrace
- # Turns on argument filter.
- optional boolean enableArgumentFilter
- # Included category filters.
- optional array of string includedCategories
- # Excluded category filters.
- optional array of string excludedCategories
- # Configuration to synthesize the delays in tracing.
- optional array of string syntheticDelays
- # Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.
- optional MemoryDumpConfig memoryDumpConfig
- # Data format of a trace. Can be either the legacy JSON format or the
- # protocol buffer format. Note that the JSON format will be deprecated soon.
- type StreamFormat extends string
- enum
- json
- proto
- # Compression type to use for traces returned via streams.
- type StreamCompression extends string
- enum
- none
- gzip
- # Details exposed when memory request explicitly declared.
- # Keep consistent with memory_dump_request_args.h and
- # memory_instrumentation.mojom
- type MemoryDumpLevelOfDetail extends string
- enum
- background
- light
- detailed
- # Backend type to use for tracing. `chrome` uses the Chrome-integrated
- # tracing service and is supported on all platforms. `system` is only
- # supported on Chrome OS and uses the Perfetto system tracing service.
- # `auto` chooses `system` when the perfettoConfig provided to Tracing.start
- # specifies at least one non-Chrome data source; otherwise uses `chrome`.
- type TracingBackend extends string
- enum
- auto
- chrome
- system
- # Stop trace events collection.
- command end
- # Gets supported tracing categories.
- command getCategories
- returns
- # A list of supported tracing categories.
- array of string categories
- # Record a clock sync marker in the trace.
- command recordClockSyncMarker
- parameters
- # The ID of this clock sync marker
- string syncId
- # Request a global memory dump.
- command requestMemoryDump
- parameters
- # Enables more deterministic results by forcing garbage collection
- optional boolean deterministic
- # Specifies level of details in memory dump. Defaults to "detailed".
- optional MemoryDumpLevelOfDetail levelOfDetail
- returns
- # GUID of the resulting global memory dump.
- string dumpGuid
- # True iff the global memory dump succeeded.
- boolean success
- # Start trace events collection.
- command start
- parameters
- # Category/tag filter
- deprecated optional string categories
- # Tracing options
- deprecated optional string options
- # If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
- optional number bufferUsageReportingInterval
- # Whether to report trace events as series of dataCollected events or to save trace to a
- # stream (defaults to `ReportEvents`).
- optional enum transferMode
- ReportEvents
- ReturnAsStream
- # Trace data format to use. This only applies when using `ReturnAsStream`
- # transfer mode (defaults to `json`).
- optional StreamFormat streamFormat
- # Compression format to use. This only applies when using `ReturnAsStream`
- # transfer mode (defaults to `none`)
- optional StreamCompression streamCompression
- optional TraceConfig traceConfig
- # Base64-encoded serialized perfetto.protos.TraceConfig protobuf message
- # When specified, the parameters `categories`, `options`, `traceConfig`
- # are ignored.
- optional binary perfettoConfig
- # Backend type (defaults to `auto`)
- optional TracingBackend tracingBackend
- event bufferUsage
- parameters
- # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
- # total size.
- optional number percentFull
- # An approximate number of events in the trace log.
- optional number eventCount
- # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
- # total size.
- optional number value
- # Contains a bucket of collected trace events. When tracing is stopped collected events will be
- # sent as a sequence of dataCollected events followed by tracingComplete event.
- event dataCollected
- parameters
- array of object value
- # Signals that tracing is stopped and there is no trace buffers pending flush, all data were
- # delivered via dataCollected events.
- event tracingComplete
- parameters
- # Indicates whether some trace data is known to have been lost, e.g. because the trace ring
- # buffer wrapped around.
- boolean dataLossOccurred
- # A handle of the stream that holds resulting trace data.
- optional IO.StreamHandle stream
- # Trace data format of returned stream.
- optional StreamFormat traceFormat
- # Compression format of returned stream.
- optional StreamCompression streamCompression
- # A domain for letting clients substitute browser's network layer with client code.
- domain Fetch
- depends on Network
- depends on IO
- depends on Page
- # Unique request identifier.
- type RequestId extends string
- # Stages of the request to handle. Request will intercept before the request is
- # sent. Response will intercept after the response is received (but before response
- # body is received).
- type RequestStage extends string
- enum
- Request
- Response
- type RequestPattern extends object
- properties
- # Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
- # backslash. Omitting is equivalent to `"*"`.
- optional string urlPattern
- # If set, only requests for matching resource types will be intercepted.
- optional Network.ResourceType resourceType
- # Stage at which to begin intercepting requests. Default is Request.
- optional RequestStage requestStage
- # Response HTTP header entry
- type HeaderEntry extends object
- properties
- string name
- string value
- # Authorization challenge for HTTP status code 401 or 407.
- type AuthChallenge extends object
- properties
- # Source of the authentication challenge.
- optional enum source
- Server
- Proxy
- # Origin of the challenger.
- string origin
- # The authentication scheme used, such as basic or digest
- string scheme
- # The realm of the challenge. May be empty.
- string realm
- # Response to an AuthChallenge.
- type AuthChallengeResponse extends object
- properties
- # The decision on what to do in response to the authorization challenge. Default means
- # deferring to the default behavior of the net stack, which will likely either the Cancel
- # authentication or display a popup dialog box.
- enum response
- Default
- CancelAuth
- ProvideCredentials
- # The username to provide, possibly empty. Should only be set if response is
- # ProvideCredentials.
- optional string username
- # The password to provide, possibly empty. Should only be set if response is
- # ProvideCredentials.
- optional string password
- # Disables the fetch domain.
- command disable
- # Enables issuing of requestPaused events. A request will be paused until client
- # calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
- command enable
- parameters
- # If specified, only requests matching any of these patterns will produce
- # fetchRequested event and will be paused until clients response. If not set,
- # all requests will be affected.
- optional array of RequestPattern patterns
- # If true, authRequired events will be issued and requests will be paused
- # expecting a call to continueWithAuth.
- optional boolean handleAuthRequests
- # Causes the request to fail with specified reason.
- command failRequest
- parameters
- # An id the client received in requestPaused event.
- RequestId requestId
- # Causes the request to fail with the given reason.
- Network.ErrorReason errorReason
- # Provides response to the request.
- command fulfillRequest
- parameters
- # An id the client received in requestPaused event.
- RequestId requestId
- # An HTTP response code.
- integer responseCode
- # Response headers.
- optional array of HeaderEntry responseHeaders
- # Alternative way of specifying response headers as a \0-separated
- # series of name: value pairs. Prefer the above method unless you
- # need to represent some non-UTF8 values that can't be transmitted
- # over the protocol as text.
- optional binary binaryResponseHeaders
- # A response body. If absent, original response body will be used if
- # the request is intercepted at the response stage and empty body
- # will be used if the request is intercepted at the request stage.
- optional binary body
- # A textual representation of responseCode.
- # If absent, a standard phrase matching responseCode is used.
- optional string responsePhrase
- # Continues the request, optionally modifying some of its parameters.
- command continueRequest
- parameters
- # An id the client received in requestPaused event.
- RequestId requestId
- # If set, the request url will be modified in a way that's not observable by page.
- optional string url
- # If set, the request method is overridden.
- optional string method
- # If set, overrides the post data in the request.
- optional binary postData
- # If set, overrides the request headers. Note that the overrides do not
- # extend to subsequent redirect hops, if a redirect happens. Another override
- # may be applied to a different request produced by a redirect.
- optional array of HeaderEntry headers
- # If set, overrides response interception behavior for this request.
- experimental optional boolean interceptResponse
- # Continues a request supplying authChallengeResponse following authRequired event.
- command continueWithAuth
- parameters
- # An id the client received in authRequired event.
- RequestId requestId
- # Response to with an authChallenge.
- AuthChallengeResponse authChallengeResponse
- # Continues loading of the paused response, optionally modifying the
- # response headers. If either responseCode or headers are modified, all of them
- # must be present.
- experimental command continueResponse
- parameters
- # An id the client received in requestPaused event.
- RequestId requestId
- # An HTTP response code. If absent, original response code will be used.
- optional integer responseCode
- # A textual representation of responseCode.
- # If absent, a standard phrase matching responseCode is used.
- optional string responsePhrase
- # Response headers. If absent, original response headers will be used.
- optional array of HeaderEntry responseHeaders
- # Alternative way of specifying response headers as a \0-separated
- # series of name: value pairs. Prefer the above method unless you
- # need to represent some non-UTF8 values that can't be transmitted
- # over the protocol as text.
- optional binary binaryResponseHeaders
- # Causes the body of the response to be received from the server and
- # returned as a single string. May only be issued for a request that
- # is paused in the Response stage and is mutually exclusive with
- # takeResponseBodyForInterceptionAsStream. Calling other methods that
- # affect the request or disabling fetch domain before body is received
- # results in an undefined behavior.
- command getResponseBody
- parameters
- # Identifier for the intercepted request to get body for.
- RequestId requestId
- returns
- # Response body.
- string body
- # True, if content was sent as base64.
- boolean base64Encoded
- # Returns a handle to the stream representing the response body.
- # The request must be paused in the HeadersReceived stage.
- # Note that after this command the request can't be continued
- # as is -- client either needs to cancel it or to provide the
- # response body.
- # The stream only supports sequential read, IO.read will fail if the position
- # is specified.
- # This method is mutually exclusive with getResponseBody.
- # Calling other methods that affect the request or disabling fetch
- # domain before body is received results in an undefined behavior.
- command takeResponseBodyAsStream
- parameters
- RequestId requestId
- returns
- IO.StreamHandle stream
- # Issued when the domain is enabled and the request URL matches the
- # specified filter. The request is paused until the client responds
- # with one of continueRequest, failRequest or fulfillRequest.
- # The stage of the request can be determined by presence of responseErrorReason
- # and responseStatusCode -- the request is at the response stage if either
- # of these fields is present and in the request stage otherwise.
- event requestPaused
- parameters
- # Each request the page makes will have a unique id.
- RequestId requestId
- # The details of the request.
- Network.Request request
- # The id of the frame that initiated the request.
- Page.FrameId frameId
- # How the requested resource will be used.
- Network.ResourceType resourceType
- # Response error if intercepted at response stage.
- optional Network.ErrorReason responseErrorReason
- # Response code if intercepted at response stage.
- optional integer responseStatusCode
- # Response status text if intercepted at response stage.
- optional string responseStatusText
- # Response headers if intercepted at the response stage.
- optional array of HeaderEntry responseHeaders
- # If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
- # then this networkId will be the same as the requestId present in the requestWillBeSent event.
- optional Network.RequestId networkId
- # If the request is due to a redirect response from the server, the id of the request that
- # has caused the redirect.
- experimental optional RequestId redirectedRequestId
- # Issued when the domain is enabled with handleAuthRequests set to true.
- # The request is paused until client responds with continueWithAuth.
- event authRequired
- parameters
- # Each request the page makes will have a unique id.
- RequestId requestId
- # The details of the request.
- Network.Request request
- # The id of the frame that initiated the request.
- Page.FrameId frameId
- # How the requested resource will be used.
- Network.ResourceType resourceType
- # Details of the Authorization Challenge encountered.
- # If this is set, client should respond with continueRequest that
- # contains AuthChallengeResponse.
- AuthChallenge authChallenge
- # This domain allows inspection of Web Audio API.
- # https://webaudio.github.io/web-audio-api/
- experimental domain WebAudio
- # An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
- type GraphObjectId extends string
- # Enum of BaseAudioContext types
- type ContextType extends string
- enum
- realtime
- offline
- # Enum of AudioContextState from the spec
- type ContextState extends string
- enum
- suspended
- running
- closed
- # Enum of AudioNode types
- type NodeType extends string
- # Enum of AudioNode::ChannelCountMode from the spec
- type ChannelCountMode extends string
- enum
- clamped-max
- explicit
- max
- # Enum of AudioNode::ChannelInterpretation from the spec
- type ChannelInterpretation extends string
- enum
- discrete
- speakers
- # Enum of AudioParam types
- type ParamType extends string
- # Enum of AudioParam::AutomationRate from the spec
- type AutomationRate extends string
- enum
- a-rate
- k-rate
- # Fields in AudioContext that change in real-time.
- type ContextRealtimeData extends object
- properties
- # The current context time in second in BaseAudioContext.
- number currentTime
- # The time spent on rendering graph divided by render quantum duration,
- # and multiplied by 100. 100 means the audio renderer reached the full
- # capacity and glitch may occur.
- number renderCapacity
- # A running mean of callback interval.
- number callbackIntervalMean
- # A running variance of callback interval.
- number callbackIntervalVariance
- # Protocol object for BaseAudioContext
- type BaseAudioContext extends object
- properties
- GraphObjectId contextId
- ContextType contextType
- ContextState contextState
- optional ContextRealtimeData realtimeData
- # Platform-dependent callback buffer size.
- number callbackBufferSize
- # Number of output channels supported by audio hardware in use.
- number maxOutputChannelCount
- # Context sample rate.
- number sampleRate
- # Protocol object for AudioListener
- type AudioListener extends object
- properties
- GraphObjectId listenerId
- GraphObjectId contextId
- # Protocol object for AudioNode
- type AudioNode extends object
- properties
- GraphObjectId nodeId
- GraphObjectId contextId
- NodeType nodeType
- number numberOfInputs
- number numberOfOutputs
- number channelCount
- ChannelCountMode channelCountMode
- ChannelInterpretation channelInterpretation
- # Protocol object for AudioParam
- type AudioParam extends object
- properties
- GraphObjectId paramId
- GraphObjectId nodeId
- GraphObjectId contextId
- ParamType paramType
- AutomationRate rate
- number defaultValue
- number minValue
- number maxValue
- # Enables the WebAudio domain and starts sending context lifetime events.
- command enable
- # Disables the WebAudio domain.
- command disable
- # Fetch the realtime data from the registered contexts.
- command getRealtimeData
- parameters
- GraphObjectId contextId
- returns
- ContextRealtimeData realtimeData
- # Notifies that a new BaseAudioContext has been created.
- event contextCreated
- parameters
- BaseAudioContext context
- # Notifies that an existing BaseAudioContext will be destroyed.
- event contextWillBeDestroyed
- parameters
- GraphObjectId contextId
- # Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
- event contextChanged
- parameters
- BaseAudioContext context
- # Notifies that the construction of an AudioListener has finished.
- event audioListenerCreated
- parameters
- AudioListener listener
- # Notifies that a new AudioListener has been created.
- event audioListenerWillBeDestroyed
- parameters
- GraphObjectId contextId
- GraphObjectId listenerId
- # Notifies that a new AudioNode has been created.
- event audioNodeCreated
- parameters
- AudioNode node
- # Notifies that an existing AudioNode has been destroyed.
- event audioNodeWillBeDestroyed
- parameters
- GraphObjectId contextId
- GraphObjectId nodeId
- # Notifies that a new AudioParam has been created.
- event audioParamCreated
- parameters
- AudioParam param
- # Notifies that an existing AudioParam has been destroyed.
- event audioParamWillBeDestroyed
- parameters
- GraphObjectId contextId
- GraphObjectId nodeId
- GraphObjectId paramId
- # Notifies that two AudioNodes are connected.
- event nodesConnected
- parameters
- GraphObjectId contextId
- GraphObjectId sourceId
- GraphObjectId destinationId
- optional number sourceOutputIndex
- optional number destinationInputIndex
- # Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
- event nodesDisconnected
- parameters
- GraphObjectId contextId
- GraphObjectId sourceId
- GraphObjectId destinationId
- optional number sourceOutputIndex
- optional number destinationInputIndex
- # Notifies that an AudioNode is connected to an AudioParam.
- event nodeParamConnected
- parameters
- GraphObjectId contextId
- GraphObjectId sourceId
- GraphObjectId destinationId
- optional number sourceOutputIndex
- # Notifies that an AudioNode is disconnected to an AudioParam.
- event nodeParamDisconnected
- parameters
- GraphObjectId contextId
- GraphObjectId sourceId
- GraphObjectId destinationId
- optional number sourceOutputIndex
- # This domain allows configuring virtual authenticators to test the WebAuthn
- # API.
- experimental domain WebAuthn
- type AuthenticatorId extends string
- type AuthenticatorProtocol extends string
- enum
- # Universal 2nd Factor.
- u2f
- # Client To Authenticator Protocol 2.
- ctap2
- type Ctap2Version extends string
- enum
- ctap2_0
- ctap2_1
- type AuthenticatorTransport extends string
- enum
- # Cross-Platform authenticator attachments:
- usb
- nfc
- ble
- cable
- # Platform authenticator attachment:
- internal
- type VirtualAuthenticatorOptions extends object
- properties
- AuthenticatorProtocol protocol
- # Defaults to ctap2_0. Ignored if |protocol| == u2f.
- optional Ctap2Version ctap2Version
- AuthenticatorTransport transport
- # Defaults to false.
- optional boolean hasResidentKey
- # Defaults to false.
- optional boolean hasUserVerification
- # If set to true, the authenticator will support the largeBlob extension.
- # https://w3c.github.io/webauthn#largeBlob
- # Defaults to false.
- optional boolean hasLargeBlob
- # If set to true, the authenticator will support the credBlob extension.
- # https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
- # Defaults to false.
- optional boolean hasCredBlob
- # If set to true, the authenticator will support the minPinLength extension.
- # https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension
- # Defaults to false.
- optional boolean hasMinPinLength
- # If set to true, the authenticator will support the prf extension.
- # https://w3c.github.io/webauthn/#prf-extension
- # Defaults to false.
- optional boolean hasPrf
- # If set to true, tests of user presence will succeed immediately.
- # Otherwise, they will not be resolved. Defaults to true.
- optional boolean automaticPresenceSimulation
- # Sets whether User Verification succeeds or fails for an authenticator.
- # Defaults to false.
- optional boolean isUserVerified
- type Credential extends object
- properties
- binary credentialId
- boolean isResidentCredential
- # Relying Party ID the credential is scoped to. Must be set when adding a
- # credential.
- optional string rpId
- # The ECDSA P-256 private key in PKCS#8 format.
- binary privateKey
- # An opaque byte sequence with a maximum size of 64 bytes mapping the
- # credential to a specific user.
- optional binary userHandle
- # Signature counter. This is incremented by one for each successful
- # assertion.
- # See https://w3c.github.io/webauthn/#signature-counter
- integer signCount
- # The large blob associated with the credential.
- # See https://w3c.github.io/webauthn/#sctn-large-blob-extension
- optional binary largeBlob
- # Enable the WebAuthn domain and start intercepting credential storage and
- # retrieval with a virtual authenticator.
- command enable
- parameters
- # Whether to enable the WebAuthn user interface. Enabling the UI is
- # recommended for debugging and demo purposes, as it is closer to the real
- # experience. Disabling the UI is recommended for automated testing.
- # Supported at the embedder's discretion if UI is available.
- # Defaults to false.
- optional boolean enableUI
- # Disable the WebAuthn domain.
- command disable
- # Creates and adds a virtual authenticator.
- command addVirtualAuthenticator
- parameters
- VirtualAuthenticatorOptions options
- returns
- AuthenticatorId authenticatorId
- # Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
- command setResponseOverrideBits
- parameters
- AuthenticatorId authenticatorId
- # If isBogusSignature is set, overrides the signature in the authenticator response to be zero.
- # Defaults to false.
- optional boolean isBogusSignature
- # If isBadUV is set, overrides the UV bit in the flags in the authenticator response to
- # be zero. Defaults to false.
- optional boolean isBadUV
- # If isBadUP is set, overrides the UP bit in the flags in the authenticator response to
- # be zero. Defaults to false.
- optional boolean isBadUP
- # Removes the given authenticator.
- command removeVirtualAuthenticator
- parameters
- AuthenticatorId authenticatorId
- # Adds the credential to the specified authenticator.
- command addCredential
- parameters
- AuthenticatorId authenticatorId
- Credential credential
- # Returns a single credential stored in the given virtual authenticator that
- # matches the credential ID.
- command getCredential
- parameters
- AuthenticatorId authenticatorId
- binary credentialId
- returns
- Credential credential
- # Returns all the credentials stored in the given virtual authenticator.
- command getCredentials
- parameters
- AuthenticatorId authenticatorId
- returns
- array of Credential credentials
- # Removes a credential from the authenticator.
- command removeCredential
- parameters
- AuthenticatorId authenticatorId
- binary credentialId
- # Clears all the credentials from the specified device.
- command clearCredentials
- parameters
- AuthenticatorId authenticatorId
- # Sets whether User Verification succeeds or fails for an authenticator.
- # The default is true.
- command setUserVerified
- parameters
- AuthenticatorId authenticatorId
- boolean isUserVerified
- # Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
- # The default is true.
- command setAutomaticPresenceSimulation
- parameters
- AuthenticatorId authenticatorId
- boolean enabled
- # Triggered when a credential is added to an authenticator.
- event credentialAdded
- parameters
- AuthenticatorId authenticatorId
- Credential credential
- # Triggered when a credential is used in a webauthn assertion.
- event credentialAsserted
- parameters
- AuthenticatorId authenticatorId
- Credential credential
- # This domain allows detailed inspection of media elements
- experimental domain Media
- # Players will get an ID that is unique within the agent context.
- type PlayerId extends string
- type Timestamp extends number
- # Have one type per entry in MediaLogRecord::Type
- # Corresponds to kMessage
- type PlayerMessage extends object
- properties
- # Keep in sync with MediaLogMessageLevel
- # We are currently keeping the message level 'error' separate from the
- # PlayerError type because right now they represent different things,
- # this one being a DVLOG(ERROR) style log message that gets printed
- # based on what log level is selected in the UI, and the other is a
- # representation of a media::PipelineStatus object. Soon however we're
- # going to be moving away from using PipelineStatus for errors and
- # introducing a new error type which should hopefully let us integrate
- # the error log level into the PlayerError type.
- enum level
- error
- warning
- info
- debug
- string message
- # Corresponds to kMediaPropertyChange
- type PlayerProperty extends object
- properties
- string name
- string value
- # Corresponds to kMediaEventTriggered
- type PlayerEvent extends object
- properties
- Timestamp timestamp
- string value
- # Represents logged source line numbers reported in an error.
- # NOTE: file and line are from chromium c++ implementation code, not js.
- type PlayerErrorSourceLocation extends object
- properties
- string file
- integer line
- # Corresponds to kMediaError
- type PlayerError extends object
- properties
- string errorType
- # Code is the numeric enum entry for a specific set of error codes, such
- # as PipelineStatusCodes in media/base/pipeline_status.h
- integer code
- # A trace of where this error was caused / where it passed through.
- array of PlayerErrorSourceLocation stack
- # Errors potentially have a root cause error, ie, a DecoderError might be
- # caused by an WindowsError
- array of PlayerError cause
- # Extra data attached to an error, such as an HRESULT, Video Codec, etc.
- object data
- # This can be called multiple times, and can be used to set / override /
- # remove player properties. A null propValue indicates removal.
- event playerPropertiesChanged
- parameters
- PlayerId playerId
- array of PlayerProperty properties
- # Send events as a list, allowing them to be batched on the browser for less
- # congestion. If batched, events must ALWAYS be in chronological order.
- event playerEventsAdded
- parameters
- PlayerId playerId
- array of PlayerEvent events
- # Send a list of any messages that need to be delivered.
- event playerMessagesLogged
- parameters
- PlayerId playerId
- array of PlayerMessage messages
- # Send a list of any errors that need to be delivered.
- event playerErrorsRaised
- parameters
- PlayerId playerId
- array of PlayerError errors
- # Called whenever a player is created, or when a new agent joins and receives
- # a list of active players. If an agent is restored, it will receive the full
- # list of player ids and all events again.
- event playersCreated
- parameters
- array of PlayerId players
- # Enables the Media domain
- command enable
- # Disables the Media domain.
- command disable
- experimental domain DeviceAccess
- # Device request id.
- type RequestId extends string
- # A device id.
- type DeviceId extends string
- # Device information displayed in a user prompt to select a device.
- type PromptDevice extends object
- properties
- DeviceId id
- # Display name as it appears in a device request user prompt.
- string name
- # Enable events in this domain.
- command enable
- # Disable events in this domain.
- command disable
- # Select a device in response to a DeviceAccess.deviceRequestPrompted event.
- command selectPrompt
- parameters
- RequestId id
- DeviceId deviceId
- # Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
- command cancelPrompt
- parameters
- RequestId id
- # A device request opened a user prompt to select a device. Respond with the
- # selectPrompt or cancelPrompt command.
- event deviceRequestPrompted
- parameters
- RequestId id
- array of PromptDevice devices
- experimental domain Preload
- # Unique id
- type RuleSetId extends string
- # Corresponds to SpeculationRuleSet
- type RuleSet extends object
- properties
- RuleSetId id
- # Identifies a document which the rule set is associated with.
- Network.LoaderId loaderId
- # Source text of JSON representing the rule set. If it comes from
- # <script> tag, it is the textContent of the node. Note that it is
- # a JSON for valid case.
- #
- # See also:
- # - https://wicg.github.io/nav-speculation/speculation-rules.html
- # - https://github.com/WICG/nav-speculation/blob/main/triggers.md
- string sourceText
- # A speculation rule set is either added through an inline
- # <script> tag or through an external resource via the
- # 'Speculation-Rules' HTTP header. For the first case, we include
- # the BackendNodeId of the relevant <script> tag. For the second
- # case, we include the external URL where the rule set was loaded
- # from, and also RequestId if Network domain is enabled.
- #
- # See also:
- # - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
- # - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
- optional DOM.BackendNodeId backendNodeId
- optional string url
- optional Network.RequestId requestId
- # Error information
- # `errorMessage` is null iff `errorType` is null.
- optional RuleSetErrorType errorType
- # TODO(https://crbug.com/1425354): Replace this property with structured error.
- deprecated optional string errorMessage
- type RuleSetErrorType extends string
- enum
- SourceIsNotJsonObject
- InvalidRulesSkipped
- # The type of preloading attempted. It corresponds to
- # mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
- # isn't being used by clients).
- type SpeculationAction extends string
- enum
- Prefetch
- Prerender
- # Corresponds to mojom::SpeculationTargetHint.
- # See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
- type SpeculationTargetHint extends string
- enum
- Blank
- Self
- # A key that identifies a preloading attempt.
- #
- # The url used is the url specified by the trigger (i.e. the initial URL), and
- # not the final url that is navigated to. For example, prerendering allows
- # same-origin main frame navigations during the attempt, but the attempt is
- # still keyed with the initial URL.
- type PreloadingAttemptKey extends object
- properties
- Network.LoaderId loaderId
- SpeculationAction action
- string url
- optional SpeculationTargetHint targetHint
- # Lists sources for a preloading attempt, specifically the ids of rule sets
- # that had a speculation rule that triggered the attempt, and the
- # BackendNodeIds of <a href> or <area href> elements that triggered the
- # attempt (in the case of attempts triggered by a document rule). It is
- # possible for mulitple rule sets and links to trigger a single attempt.
- type PreloadingAttemptSource extends object
- properties
- PreloadingAttemptKey key
- array of RuleSetId ruleSetIds
- array of DOM.BackendNodeId nodeIds
- command enable
- command disable
- # Upsert. Currently, it is only emitted when a rule set added.
- event ruleSetUpdated
- parameters
- RuleSet ruleSet
- event ruleSetRemoved
- parameters
- RuleSetId id
- # List of FinalStatus reasons for Prerender2.
- type PrerenderFinalStatus extends string
- enum
- Activated
- Destroyed
- LowEndDevice
- InvalidSchemeRedirect
- InvalidSchemeNavigation
- InProgressNavigation
- NavigationRequestBlockedByCsp
- MainFrameNavigation
- MojoBinderPolicy
- RendererProcessCrashed
- RendererProcessKilled
- Download
- TriggerDestroyed
- NavigationNotCommitted
- NavigationBadHttpStatus
- ClientCertRequested
- NavigationRequestNetworkError
- MaxNumOfRunningPrerendersExceeded
- CancelAllHostsForTesting
- DidFailLoad
- Stop
- SslCertificateError
- LoginAuthRequested
- UaChangeRequiresReload
- BlockedByClient
- AudioOutputDeviceRequested
- MixedContent
- TriggerBackgrounded
- EmbedderTriggeredAndCrossOriginRedirected
- MemoryLimitExceeded
- # Prerenders can be cancelled when Chrome uses excessive memory. This is
- # recorded when it fails to get the memory usage.
- FailToGetMemoryUsage
- DataSaverEnabled
- HasEffectiveUrl
- ActivatedBeforeStarted
- InactivePageRestriction
- StartFailed
- TimeoutBackgrounded
- CrossSiteRedirectInInitialNavigation
- CrossSiteNavigationInInitialNavigation
- SameSiteCrossOriginRedirectNotOptInInInitialNavigation
- SameSiteCrossOriginNavigationNotOptInInInitialNavigation
- ActivationNavigationParameterMismatch
- ActivatedInBackground
- EmbedderHostDisallowed
- ActivationNavigationDestroyedBeforeSuccess
- TabClosedByUserGesture
- TabClosedWithoutUserGesture
- PrimaryMainFrameRendererProcessCrashed
- PrimaryMainFrameRendererProcessKilled
- ActivationFramePolicyNotCompatible
- PreloadingDisabled
- BatterySaverEnabled
- ActivatedDuringMainFrameNavigation
- PreloadingUnsupportedByWebContents
- CrossSiteRedirectInMainFrameNavigation
- CrossSiteNavigationInMainFrameNavigation
- SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation
- SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation
- MemoryPressureOnTrigger
- MemoryPressureAfterTriggered
- # Fired when a prerender attempt is completed.
- event prerenderAttemptCompleted
- parameters
- PreloadingAttemptKey key
- # The frame id of the frame initiating prerendering.
- Page.FrameId initiatingFrameId
- string prerenderingUrl
- PrerenderFinalStatus finalStatus
- # This is used to give users more information about the name of the API call
- # that is incompatible with prerender and has caused the cancellation of the attempt
- optional string disallowedApiMethod
- # Fired when a preload enabled state is updated.
- event preloadEnabledStateUpdated
- parameters
- boolean disabledByPreference
- boolean disabledByDataSaver
- boolean disabledByBatterySaver
- # Preloading status values, see also PreloadingTriggeringOutcome. This
- # status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
- type PreloadingStatus extends string
- enum
- Pending
- Running
- Ready
- Success
- Failure
- # PreloadingTriggeringOutcome which not used by prefetch nor prerender.
- NotSupported
- # TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
- # filter out the ones that aren't necessary to the developers.
- type PrefetchStatus extends string
- enum
- # Prefetch is not disabled by PrefetchHeldback.
- PrefetchAllowed
- PrefetchFailedIneligibleRedirect
- PrefetchFailedInvalidRedirect
- PrefetchFailedMIMENotSupported
- PrefetchFailedNetError
- PrefetchFailedNon2XX
- PrefetchFailedPerPageLimitExceeded
- PrefetchEvicted
- PrefetchHeldback
- # A previous prefetch to the origin got a HTTP 503 response with an
- # Retry-After header that has no elapsed yet.
- PrefetchIneligibleRetryAfter
- PrefetchIsPrivacyDecoy
- PrefetchIsStale
- PrefetchNotEligibleBrowserContextOffTheRecord
- PrefetchNotEligibleDataSaverEnabled
- PrefetchNotEligibleExistingProxy
- PrefetchNotEligibleHostIsNonUnique
- PrefetchNotEligibleNonDefaultStoragePartition
- PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy
- PrefetchNotEligibleSchemeIsNotHttps
- PrefetchNotEligibleUserHasCookies
- PrefetchNotEligibleUserHasServiceWorker
- PrefetchNotEligibleBatterySaverEnabled
- PrefetchNotEligiblePreloadingDisabled
- PrefetchNotFinishedInTime
- PrefetchNotStarted
- PrefetchNotUsedCookiesChanged
- PrefetchProxyNotAvailable
- # The response of the prefetch is used for the next navigation. This is
- # the final successful state.
- PrefetchResponseUsed
- # The prefetch finished successfully but was never used.
- PrefetchSuccessfulButNotUsed
- PrefetchNotUsedProbeFailed
- # Fired when a prefetch attempt is updated.
- event prefetchStatusUpdated
- parameters
- PreloadingAttemptKey key
- # The frame id of the frame initiating prefetch.
- Page.FrameId initiatingFrameId
- string prefetchUrl
- PreloadingStatus status
- PrefetchStatus prefetchStatus
- # Fired when a prerender attempt is updated.
- event prerenderStatusUpdated
- parameters
- PreloadingAttemptKey key
- PreloadingStatus status
- optional PrerenderFinalStatus prerenderStatus
- # Send a list of sources for all preloading attempts in a document.
- event preloadingAttemptSourcesUpdated
- parameters
- Network.LoaderId loaderId
- array of PreloadingAttemptSource preloadingAttemptSources
- # This domain allows interacting with the FedCM dialog.
- experimental domain FedCm
- # Whether this is a sign-up or sign-in action for this account, i.e.
- # whether this account has ever been used to sign in to this RP before.
- type LoginState extends string
- enum
- SignIn
- SignUp
- # Whether the dialog shown is an account chooser or an auto re-authentication dialog.
- type DialogType extends string
- enum
- AccountChooser
- AutoReauthn
- # Corresponds to IdentityRequestAccount
- type Account extends object
- properties
- string accountId
- string email
- string name
- string givenName
- string pictureUrl
- string idpConfigUrl
- string idpSigninUrl
- LoginState loginState
- # These two are only set if the loginState is signUp
- optional string termsOfServiceUrl
- optional string privacyPolicyUrl
- event dialogShown
- parameters
- string dialogId
- DialogType dialogType
- array of Account accounts
- # These exist primarily so that the caller can verify the
- # RP context was used appropriately.
- string title
- optional string subtitle
- command enable
- parameters
- # Allows callers to disable the promise rejection delay that would
- # normally happen, if this is unimportant to what's being tested.
- # (step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
- optional boolean disableRejectionDelay
- command disable
- command selectAccount
- parameters
- string dialogId
- integer accountIndex
- command dismissDialog
- parameters
- string dialogId
- optional boolean triggerCooldown
- # Resets the cooldown time, if any, to allow the next FedCM call to show
- # a dialog even if one was recently dismissed by the user.
- command resetCooldown
|