browser_protocol.pdl 359 KB

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