browser_protocol.pdl 417 KB

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