lib.wx.api.d.ts 782 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221
  1. /*! *****************************************************************************
  2. Copyright (c) 2022 Tencent, Inc. All rights reserved.
  3. Permission is hereby granted, free of charge, to any person obtaining a copy of
  4. this software and associated documentation files (the "Software"), to deal in
  5. the Software without restriction, including without limitation the rights to
  6. use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  7. of the Software, and to permit persons to whom the Software is furnished to do
  8. so, subject to the following conditions:
  9. The above copyright notice and this permission notice shall be included in all
  10. copies or substantial portions of the Software.
  11. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  12. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  13. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  14. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  15. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  17. SOFTWARE.
  18. ***************************************************************************** */
  19. declare namespace WechatMinigame {
  20. interface AccessFailCallbackResult {
  21. /** 错误信息
  22. *
  23. * 可选值:
  24. * - 'fail no such file or directory ${path}': 文件/目录不存在;
  25. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  26. errMsg: string
  27. }
  28. interface AccessOption {
  29. /** 要判断是否存在的文件/目录路径 (本地路径) */
  30. path: string
  31. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  32. complete?: AccessCompleteCallback
  33. /** 接口调用失败的回调函数 */
  34. fail?: AccessFailCallback
  35. /** 接口调用成功的回调函数 */
  36. success?: AccessSuccessCallback
  37. }
  38. /** 帐号信息 */
  39. interface AccountInfo {
  40. /** 小程序帐号信息 */
  41. miniProgram: MiniProgram
  42. /** 插件帐号信息(仅在插件中调用时包含这一项) */
  43. plugin: Plugin
  44. }
  45. interface AddCardOption {
  46. /** 需要添加的卡券列表 */
  47. cardList: AddCardRequestInfo[]
  48. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  49. complete?: AddCardCompleteCallback
  50. /** 接口调用失败的回调函数 */
  51. fail?: AddCardFailCallback
  52. /** 接口调用成功的回调函数 */
  53. success?: AddCardSuccessCallback
  54. }
  55. /** 需要添加的卡券列表 */
  56. interface AddCardRequestInfo {
  57. /** 卡券的扩展参数。需将 CardExt 对象 JSON 序列化为**字符串**传入 */
  58. cardExt: string
  59. /** 卡券 ID */
  60. cardId: string
  61. }
  62. /** 卡券添加结果列表 */
  63. interface AddCardResponseInfo {
  64. /** 卡券的扩展参数,结构请参考下文 */
  65. cardExt: string
  66. /** 用户领取到卡券的 ID */
  67. cardId: string
  68. /** 加密 code,为用户领取到卡券的code加密后的字符串,解密请参照:[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) */
  69. code: string
  70. /** 是否成功 */
  71. isSuccess: boolean
  72. }
  73. interface AddCardSuccessCallbackResult {
  74. /** 卡券添加结果列表 */
  75. cardList: AddCardResponseInfo[]
  76. errMsg: string
  77. }
  78. interface AddServiceOption {
  79. /** 描述service的Object */
  80. service: BLEPeripheralService
  81. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  82. complete?: AddServiceCompleteCallback
  83. /** 接口调用失败的回调函数 */
  84. fail?: AddServiceFailCallback
  85. /** 接口调用成功的回调函数 */
  86. success?: AddServiceSuccessCallback
  87. }
  88. /** 广播自定义参数 */
  89. interface AdvertiseReqObj {
  90. /** 需要基础库: `2.20.1`
  91. *
  92. * 以 beacon 设备形式广播的参数。 */
  93. beacon?: BeaconInfoObj
  94. /** 当前设备是否可连接 */
  95. connectable?: boolean
  96. /** 广播中 deviceName 字段,默认为空 */
  97. deviceName?: string
  98. /** 广播的制造商信息。仅安卓支持,iOS 因系统限制无法定制。 */
  99. manufacturerData?: ManufacturerData[]
  100. /** 要广播的服务 UUID 列表。使用 16/32 位 UUID 时请参考注意事项。 */
  101. serviceUuids?: string[]
  102. }
  103. interface AppendFileFailCallbackResult {
  104. /** 错误信息
  105. *
  106. * 可选值:
  107. * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 文件不存在;
  108. * - 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;
  109. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
  110. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  111. errMsg: string
  112. }
  113. interface AppendFileOption {
  114. /** 要追加的文本或二进制数据 */
  115. data: string | ArrayBuffer
  116. /** 要追加内容的文件路径 (本地路径) */
  117. filePath: string
  118. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  119. complete?: AppendFileCompleteCallback
  120. /** 指定写入文件的字符编码
  121. *
  122. * 可选值:
  123. * - 'ascii': ;
  124. * - 'base64': ;
  125. * - 'binary': ;
  126. * - 'hex': ;
  127. * - 'ucs2': 以小端序读取;
  128. * - 'ucs-2': 以小端序读取;
  129. * - 'utf16le': 以小端序读取;
  130. * - 'utf-16le': 以小端序读取;
  131. * - 'utf-8': ;
  132. * - 'utf8': ;
  133. * - 'latin1': ; */
  134. encoding?:
  135. | 'ascii'
  136. | 'base64'
  137. | 'binary'
  138. | 'hex'
  139. | 'ucs2'
  140. | 'ucs-2'
  141. | 'utf16le'
  142. | 'utf-16le'
  143. | 'utf-8'
  144. | 'utf8'
  145. | 'latin1'
  146. /** 接口调用失败的回调函数 */
  147. fail?: AppendFileFailCallback
  148. /** 接口调用成功的回调函数 */
  149. success?: AppendFileSuccessCallback
  150. }
  151. /** 需要基础库: `2.19.0`
  152. *
  153. * AudioBuffer接口表示存在内存里的一段短小的音频资源,利用[WebAudioContext.decodeAudioData](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.decodeAudioData.html)方法从一个音频文件构建,或者利用 [AudioContext.createBuffer](#)从原始数据构建。把音频放入AudioBuffer后,可以传入到一个 AudioBufferSourceNode进行播放。 */
  154. interface AudioBuffer {
  155. /** 返回存储在缓存区的PCM数据的时长(单位为秒) */
  156. duration: number
  157. /** 返回存储在缓存区的PCM数据的采样帧率 */
  158. length: number
  159. /** 储存在缓存区的PCM数据的通道数 */
  160. numberOfChannels: number
  161. /** 存储在缓存区的PCM数据的采样率(单位为sample/s) */
  162. sampleRate: number
  163. }
  164. interface AuthPrivateMessageOption {
  165. /** shareTicket。可以从 wx.onShow 中获取。详情 [shareTicket](#) */
  166. shareTicket: string
  167. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  168. complete?: AuthPrivateMessageCompleteCallback
  169. /** 接口调用失败的回调函数 */
  170. fail?: AuthPrivateMessageFailCallback
  171. /** 接口调用成功的回调函数 */
  172. success?: AuthPrivateMessageSuccessCallback
  173. }
  174. interface AuthPrivateMessageSuccessCallbackResult {
  175. /** 经过加密的activityId,解密后可得到原始的activityId。若解密后得到的activityId可以与开发者后台的活动id对应上则验证通过,否则表明valid字段不可靠(被篡改) 详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) */
  176. encryptedData: string
  177. /** 错误信息 */
  178. errMsg: string
  179. /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  180. iv: string
  181. /** 验证是否通过 */
  182. valid: boolean
  183. }
  184. /** 用户授权设置信息,详情参考[权限](#) */
  185. interface AuthSetting {
  186. /** 是否授权使用你的微信朋友信息,对应开放数据域内的 [wx.getFriendCloudStorage](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getFriendCloudStorage.html) 、[wx.getGroupCloudStorage](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupCloudStorage.html) 、[wx.getGroupInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupInfo.html) 、[wx.getPotentialFriendList](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getPotentialFriendList.html) 、[wx.getUserCloudStorageKeys](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserCloudStorageKeys.html) 、[wx.getUserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/OpenDataContext-wx.getUserInfo.html) 、[GameServerManager.getFriendsStateData](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getFriendsStateData.html) 接口,以及主域内的 [wx.getUserInteractiveStorage](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserInteractiveStorage.html) 接口。 */
  187. 'scope.WxFriendInteraction'?: boolean
  188. /** 是否授权用户信息,对应接口 [wx.getUserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.getUserInfo.html) */
  189. 'scope.userInfo'?: boolean
  190. /** 是否授权地理位置,对应接口 [wx.getLocation](https://developers.weixin.qq.com/minigame/dev/api/location/wx.getLocation.html) */
  191. 'scope.userLocation'?: boolean
  192. /** 是否授权微信运动步数,对应接口 [wx.getWeRunData](https://developers.weixin.qq.com/minigame/dev/api/open-api/werun/wx.getWeRunData.html) */
  193. 'scope.werun'?: boolean
  194. /** 是否授权保存到相册,对应接口 [wx.saveImageToPhotosAlbum](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.saveImageToPhotosAlbum.html) */
  195. 'scope.writePhotosAlbum'?: boolean
  196. }
  197. interface AuthorizeOption {
  198. /** 需要获取权限的 scope,详见 [scope 列表](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html#scope-列表) */
  199. scope: string
  200. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  201. complete?: AuthorizeCompleteCallback
  202. /** 接口调用失败的回调函数 */
  203. fail?: AuthorizeFailCallback
  204. /** 接口调用成功的回调函数 */
  205. success?: AuthorizeSuccessCallback
  206. }
  207. /** 设备特征列表 */
  208. interface BLECharacteristic {
  209. /** 该特征支持的操作类型 */
  210. properties: BLECharacteristicProperties
  211. /** 蓝牙设备特征的 UUID */
  212. uuid: string
  213. }
  214. /** 该特征支持的操作类型 */
  215. interface BLECharacteristicProperties {
  216. /** 该特征是否支持 indicate 操作 */
  217. indicate: boolean
  218. /** 该特征是否支持 notify 操作 */
  219. notify: boolean
  220. /** 该特征是否支持 read 操作 */
  221. read: boolean
  222. /** 该特征是否支持 write 操作 */
  223. write: boolean
  224. }
  225. /** 描述service的Object */
  226. interface BLEPeripheralService {
  227. /** characteristics列表 */
  228. characteristics: Characteristic[]
  229. /** 蓝牙服务的 UUID */
  230. uuid: string
  231. }
  232. /** 设备服务列表 */
  233. interface BLEService {
  234. /** 该服务是否为主服务 */
  235. isPrimary: boolean
  236. /** 蓝牙设备服务的 UUID */
  237. uuid: string
  238. }
  239. /** banner 广告组件。banner 广告组件是一个原生组件,层级比普通组件高。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。 */
  240. interface BannerAd {
  241. /** banner 广告组件的样式。style 上的属性的值仅为开发者设置的值,banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。 */
  242. style: BannerAdStyle
  243. }
  244. interface BannerAdOnErrorCallbackResult {
  245. /** 需要基础库: `2.2.2`
  246. *
  247. * 错误码
  248. *
  249. * 可选值:
  250. * - 1000: 后端接口调用失败;
  251. * - 1001: 参数错误;
  252. * - 1002: 广告单元无效;
  253. * - 1003: 内部错误;
  254. * - 1004: 无合适的广告;
  255. * - 1005: 广告组件审核中;
  256. * - 1006: 广告组件被驳回;
  257. * - 1007: 广告组件被封禁;
  258. * - 1008: 广告单元已关闭; */
  259. errCode: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008
  260. /** 错误信息 */
  261. errMsg: string
  262. }
  263. /** banner 广告组件的样式。style 上的属性的值仅为开发者设置的值,banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。 */
  264. interface BannerAdStyle {
  265. /** banner 广告组件的高度 */
  266. height: number
  267. /** banner 广告组件的左上角横坐标 */
  268. left: number
  269. /** banner 广告组件经过缩放后真实的高度 */
  270. realHeight: number
  271. /** banner 广告组件经过缩放后真实的宽度 */
  272. realWidth: number
  273. /** banner 广告组件的左上角纵坐标 */
  274. top: number
  275. /** banner 广告组件的宽度。最小 300,最大至 `屏幕宽度`(屏幕宽度可以通过 wx.getSystemInfoSync() 获取)。 */
  276. width: number
  277. }
  278. /** Beacon 设备 */
  279. interface BeaconInfo {
  280. /** Beacon 设备的距离,单位 m。iOS 上,proximity 为 0 时,accuracy 为 -1。 */
  281. accuracy: number
  282. /** Beacon 设备的主 ID */
  283. major: number
  284. /** Beacon 设备的次 ID */
  285. minor: number
  286. /** 表示设备距离的枚举值(仅iOS)
  287. *
  288. * 可选值:
  289. * - 0: 信号太弱不足以计算距离,或非 iOS 设备;
  290. * - 1: 十分近;
  291. * - 2: 比较近;
  292. * - 3: 远; */
  293. proximity: 0 | 1 | 2 | 3
  294. /** 表示设备的信号强度,单位 dBm */
  295. rssi: number
  296. /** Beacon 设备广播的 UUID */
  297. uuid: string
  298. }
  299. /** 需要基础库: `2.20.1`
  300. *
  301. * 以 beacon 设备形式广播的参数。 */
  302. interface BeaconInfoObj {
  303. /** Beacon 设备的主 ID */
  304. major: number
  305. /** Beacon 设备的次 ID */
  306. minor: number
  307. /** Beacon 设备广播的 UUID */
  308. uuid: string
  309. /** 用于判断距离设备 1 米时 RSSI 大小的参考值 */
  310. measuredPower?: number
  311. }
  312. interface BlueToothDevice {
  313. /** 当前蓝牙设备的信号强度,单位 dBm */
  314. RSSI: number
  315. /** 当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。 */
  316. advertisData: ArrayBuffer
  317. /** 当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段 */
  318. advertisServiceUUIDs: string[]
  319. /** 蓝牙设备 id */
  320. deviceId: string
  321. /** 当前蓝牙设备的广播数据段中的 LocalName 数据段 */
  322. localName: string
  323. /** 蓝牙设备名称,某些设备可能没有 */
  324. name: string
  325. /** 当前蓝牙设备的广播数据段中的 ServiceData 数据段 */
  326. serviceData: IAnyObject
  327. }
  328. /** 搜索到的设备列表 */
  329. interface BluetoothDeviceInfo {
  330. /** 用于区分设备的 id */
  331. deviceId: string
  332. /** 蓝牙设备名称,某些设备可能没有 */
  333. name: string
  334. }
  335. interface BroadcastInRoomOption {
  336. /** 广播内容 */
  337. msg: string
  338. /** 给座位号为哪些的玩家发送信息,不填代表给房间所有人发送 */
  339. toPosNumList: number[]
  340. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  341. complete?: BroadcastInRoomCompleteCallback
  342. /** 接口调用失败的回调函数 */
  343. fail?: BroadcastInRoomFailCallback
  344. /** 接口调用成功的回调函数 */
  345. success?: BroadcastInRoomSuccessCallback
  346. }
  347. /** 对局回放的按钮的配置。对局回放按钮的文案不能随意设置,只能选择预设的文案模版。 */
  348. interface ButtonShare {
  349. /** 对局回放的按钮的模版。
  350. *
  351. * 可选值:
  352. * - 'enter': 马上玩;
  353. * - 'challenge': 去挑战;
  354. * - 'play': 去挑战; */
  355. template?: 'enter' | 'challenge' | 'play'
  356. }
  357. /** 对局回放的按钮。只能选择预设的文案模版。 */
  358. interface ButtonShareOption {
  359. /** 对局回放的按钮的模版。
  360. *
  361. * 可选值:
  362. * - 'enter': 马上玩;
  363. * - 'challenge': 去挑战;
  364. * - 'play': 玩一把; */
  365. template?: 'enter' | 'challenge' | 'play'
  366. }
  367. /** 相机对象 */
  368. interface Camera {
  369. /** 摄像头朝向 */
  370. devicePosition: string
  371. /** 闪光灯,值为 auto, on, off */
  372. flash: string
  373. /** 相机的高度 */
  374. height: number
  375. /** 帧数据图像尺寸,值为 small, medium, large */
  376. size: string
  377. /** 相机的宽度 */
  378. width: number
  379. /** 相机的左上角横坐标 */
  380. x: number
  381. /** 相机的左上角纵坐标 */
  382. y: number
  383. }
  384. interface CancelMatchOption {
  385. /** 需要取消匹配的matchId */
  386. matchId: string
  387. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  388. complete?: CancelMatchCompleteCallback
  389. /** 接口调用失败的回调函数 */
  390. fail?: CancelMatchFailCallback
  391. /** 接口调用成功的回调函数 */
  392. success?: CancelMatchSuccessCallback
  393. }
  394. /** 画布对象 */
  395. interface Canvas {
  396. /** 画布的高度 */
  397. height: number
  398. /** 画布的宽度 */
  399. width: number
  400. }
  401. interface ChangeSeatOption {
  402. /** 座位号,从 0 开始 */
  403. posNum: number
  404. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  405. complete?: ChangeSeatCompleteCallback
  406. /** 接口调用失败的回调函数 */
  407. fail?: ChangeSeatFailCallback
  408. /** 接口调用成功的回调函数 */
  409. success?: ChangeSeatSuccessCallback
  410. }
  411. /** characteristics列表 */
  412. interface Characteristic {
  413. /** characteristic 的 UUID */
  414. uuid: string
  415. /** 描述符数据 */
  416. descriptors?: Descriptor[]
  417. /** 特征权限 */
  418. permission?: CharacteristicPermission
  419. /** 特征支持的操作 */
  420. properties?: CharacteristicProperties
  421. /** 特征对应的二进制值 */
  422. value?: ArrayBuffer
  423. }
  424. /** 特征权限 */
  425. interface CharacteristicPermission {
  426. /** 加密读请求 */
  427. readEncryptionRequired?: boolean
  428. /** 可读 */
  429. readable?: boolean
  430. /** 加密写请求 */
  431. writeEncryptionRequired?: boolean
  432. /** 可写 */
  433. writeable?: boolean
  434. }
  435. /** 特征支持的操作 */
  436. interface CharacteristicProperties {
  437. /** 回包 */
  438. indicate?: boolean
  439. /** 订阅 */
  440. notify?: boolean
  441. /** 读 */
  442. read?: boolean
  443. /** 写 */
  444. write?: boolean
  445. /** 无回复写 */
  446. writeNoResponse?: boolean
  447. }
  448. interface CheckHandoffEnabledOption {
  449. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  450. complete?: CheckHandoffEnabledCompleteCallback
  451. /** 接口调用失败的回调函数 */
  452. fail?: CheckHandoffEnabledFailCallback
  453. /** 接口调用成功的回调函数 */
  454. success?: CheckHandoffEnabledSuccessCallback
  455. }
  456. interface CheckHandoffEnabledSuccessCallbackResult {
  457. /** 错误码,0未知,1用户取消,2电脑未登录,3电脑版本过低,4暂未支持 */
  458. errCode: number
  459. /** 是否可以进行接力 */
  460. isEnabled: boolean
  461. errMsg: string
  462. }
  463. interface CheckIsUserAdvisedToRestOption {
  464. /** 今天已经玩游戏的时间,单位:秒 */
  465. todayPlayedTime: number
  466. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  467. complete?: CheckIsUserAdvisedToRestCompleteCallback
  468. /** 接口调用失败的回调函数 */
  469. fail?: CheckIsUserAdvisedToRestFailCallback
  470. /** 接口调用成功的回调函数 */
  471. success?: CheckIsUserAdvisedToRestSuccessCallback
  472. }
  473. interface CheckIsUserAdvisedToRestSuccessCallbackResult {
  474. /** 是否建议用户休息 */
  475. result: boolean
  476. errMsg: string
  477. }
  478. interface CheckSessionOption {
  479. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  480. complete?: CheckSessionCompleteCallback
  481. /** 接口调用失败的回调函数 */
  482. fail?: CheckSessionFailCallback
  483. /** 接口调用成功的回调函数 */
  484. success?: CheckSessionSuccessCallback
  485. }
  486. interface ChooseImageOption {
  487. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  488. complete?: ChooseImageCompleteCallback
  489. /** 最多可以选择的图片张数 */
  490. count?: number
  491. /** 接口调用失败的回调函数 */
  492. fail?: ChooseImageFailCallback
  493. /** 所选的图片的尺寸
  494. *
  495. * 可选值:
  496. * - 'original': 原图;
  497. * - 'compressed': 压缩图; */
  498. sizeType?: Array<'original' | 'compressed'>
  499. /** 选择图片的来源
  500. *
  501. * 可选值:
  502. * - 'album': 从相册选图;
  503. * - 'camera': 使用相机; */
  504. sourceType?: Array<'album' | 'camera'>
  505. /** 接口调用成功的回调函数 */
  506. success?: ChooseImageSuccessCallback
  507. }
  508. interface ChooseImageSuccessCallbackResult {
  509. /** 图片的本地临时文件路径列表 (本地路径) */
  510. tempFilePaths: string[]
  511. /** 需要基础库: `1.2.0`
  512. *
  513. * 图片的本地临时文件列表 */
  514. tempFiles: ImageFile[]
  515. errMsg: string
  516. }
  517. interface ClearStorageOption {
  518. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  519. complete?: ClearStorageCompleteCallback
  520. /** 接口调用失败的回调函数 */
  521. fail?: ClearStorageFailCallback
  522. /** 接口调用成功的回调函数 */
  523. success?: ClearStorageSuccessCallback
  524. }
  525. /** 菜单按钮的布局位置信息 */
  526. interface ClientRect {
  527. /** 下边界坐标,单位:px */
  528. bottom: number
  529. /** 高度,单位:px */
  530. height: number
  531. /** 左边界坐标,单位:px */
  532. left: number
  533. /** 右边界坐标,单位:px */
  534. right: number
  535. /** 上边界坐标,单位:px */
  536. top: number
  537. /** 宽度,单位:px */
  538. width: number
  539. }
  540. interface CloseBLEConnectionOption {
  541. /** 蓝牙设备 id */
  542. deviceId: string
  543. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  544. complete?: CloseBLEConnectionCompleteCallback
  545. /** 接口调用失败的回调函数 */
  546. fail?: CloseBLEConnectionFailCallback
  547. /** 接口调用成功的回调函数 */
  548. success?: CloseBLEConnectionSuccessCallback
  549. }
  550. interface CloseBluetoothAdapterOption {
  551. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  552. complete?: CloseBluetoothAdapterCompleteCallback
  553. /** 接口调用失败的回调函数 */
  554. fail?: CloseBluetoothAdapterFailCallback
  555. /** 接口调用成功的回调函数 */
  556. success?: CloseBluetoothAdapterSuccessCallback
  557. }
  558. interface CloseFailCallbackResult {
  559. /** 错误信息
  560. *
  561. * 可选值:
  562. * - 'bad file descriptor': 无效的文件描述符; */
  563. errMsg: string
  564. }
  565. interface CloseSocketOption {
  566. /** 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 */
  567. code?: number
  568. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  569. complete?: CloseSocketCompleteCallback
  570. /** 接口调用失败的回调函数 */
  571. fail?: CloseSocketFailCallback
  572. /** 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。 */
  573. reason?: string
  574. /** 接口调用成功的回调函数 */
  575. success?: CloseSocketSuccessCallback
  576. }
  577. interface CloseSyncOption {
  578. /** 需要被关闭的文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  579. fd: string
  580. }
  581. interface ConnectOption {
  582. /** 要发消息的地址 */
  583. address: string
  584. /** 要发送消息的端口号 */
  585. port: number
  586. }
  587. interface ConnectSocketOption {
  588. /** 开发者服务器 wss 接口地址 */
  589. url: string
  590. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  591. complete?: ConnectSocketCompleteCallback
  592. /** 接口调用失败的回调函数 */
  593. fail?: ConnectSocketFailCallback
  594. /** HTTP Header,Header 中不能设置 Referer */
  595. header?: IAnyObject
  596. /** 需要基础库: `2.8.0`
  597. *
  598. * 是否开启压缩扩展 */
  599. perMessageDeflate?: boolean
  600. /** 需要基础库: `1.4.0`
  601. *
  602. * 子协议数组 */
  603. protocols?: string[]
  604. /** 接口调用成功的回调函数 */
  605. success?: ConnectSocketSuccessCallback
  606. /** 需要基础库: `2.4.0`
  607. *
  608. * 建立 TCP 连接的时候的 TCP_NODELAY 设置 */
  609. tcpNoDelay?: boolean
  610. /** 需要基础库: `2.10.0`
  611. *
  612. * 超时时间,单位为毫秒 */
  613. timeout?: number
  614. }
  615. /** 一个字典对象,它指定是否应该禁用规范化(默认启用规范化) */
  616. interface Constraints {
  617. /** 如果指定为true则禁用标准化,默认为false */
  618. disableNormalization?: boolean
  619. }
  620. /** webgl 上下文属性,仅当 contextType 为 webgl 时有效 */
  621. interface ContextAttributes {
  622. /** 需要基础库: `2.11.0`
  623. *
  624. * 是否开启透明通道,仅当 contextType 为 webgl 时有效。(开启后,配合wx.createVideo({underGameView: true}) 即可在video组件之上渲染主屏画布) */
  625. alpha?: number
  626. /** 表示是否抗锯齿 */
  627. antialias?: boolean
  628. /** 抗锯齿样本数。最小值为 2,最大不超过系统限制数量,仅 iOS 支持 */
  629. antialiasSamples?: number
  630. /** 表示是否绘图完成后是否保留绘图缓冲区 */
  631. preserveDrawingBuffer?: boolean
  632. }
  633. interface CopyFileFailCallbackResult {
  634. /** 错误信息
  635. *
  636. * 可选值:
  637. * - 'fail permission denied, copyFile ${srcPath} -> ${destPath}': 指定目标文件路径没有写权限;
  638. * - 'fail no such file or directory, copyFile ${srcPath} -> ${destPath}': 源文件不存在,或目标文件路径的上层目录不存在;
  639. * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
  640. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  641. errMsg: string
  642. }
  643. interface CopyFileOption {
  644. /** 目标文件路径,支持本地路径 */
  645. destPath: string
  646. /** 源文件路径,支持本地路径 */
  647. srcPath: string
  648. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  649. complete?: CopyFileCompleteCallback
  650. /** 接口调用失败的回调函数 */
  651. fail?: CopyFileFailCallback
  652. /** 接口调用成功的回调函数 */
  653. success?: CopyFileSuccessCallback
  654. }
  655. interface CreateBLEConnectionOption {
  656. /** 蓝牙设备 id */
  657. deviceId: string
  658. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  659. complete?: CreateBLEConnectionCompleteCallback
  660. /** 接口调用失败的回调函数 */
  661. fail?: CreateBLEConnectionFailCallback
  662. /** 接口调用成功的回调函数 */
  663. success?: CreateBLEConnectionSuccessCallback
  664. /** 超时时间,单位 ms,不填表示不会超时 */
  665. timeout?: number
  666. }
  667. interface CreateBLEPeripheralServerOption {
  668. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  669. complete?: CreateBLEPeripheralServerCompleteCallback
  670. /** 接口调用失败的回调函数 */
  671. fail?: CreateBLEPeripheralServerFailCallback
  672. /** 接口调用成功的回调函数 */
  673. success?: CreateBLEPeripheralServerSuccessCallback
  674. }
  675. interface CreateBLEPeripheralServerSuccessCallbackResult {
  676. /** [BLEPeripheralServer](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.html)
  677. *
  678. * 外围设备的服务端。 */
  679. server: BLEPeripheralServer
  680. errMsg: string
  681. }
  682. interface CreateBannerAdOption {
  683. /** 广告单元 id */
  684. adUnitId: string
  685. /** banner 广告组件的样式 */
  686. style: CreateBannerAdStyleOption
  687. /** 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(该参数不传入时 Banner 广告不会自动刷新) */
  688. adIntervals?: number
  689. }
  690. /** banner 广告组件的样式 */
  691. interface CreateBannerAdStyleOption {
  692. /** banner 广告组件的高度 */
  693. height: number
  694. /** banner 广告组件的左上角横坐标 */
  695. left: number
  696. /** banner 广告组件的左上角纵坐标 */
  697. top: number
  698. /** banner 广告组件的宽度 */
  699. width: number
  700. }
  701. interface CreateCameraOption {
  702. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  703. complete?: CreateCameraCompleteCallback
  704. /** 摄像头朝向,值为 front, back */
  705. devicePosition?: string
  706. /** 接口调用失败的回调函数 */
  707. fail?: CreateCameraFailCallback
  708. /** 闪光灯,值为 auto, on, off */
  709. flash?: string
  710. /** 相机的高度 */
  711. height?: number
  712. /** 帧数据图像尺寸,值为 small, medium, large */
  713. size?: string
  714. /** 接口调用成功的回调函数 */
  715. success?: CreateCameraSuccessCallback
  716. /** 相机的宽度 */
  717. width?: number
  718. /** 相机的左上角横坐标 */
  719. x?: number
  720. /** 相机的左上角纵坐标 */
  721. y?: number
  722. }
  723. interface CreateCustomAdOption {
  724. /** 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(仅对支持自动刷新的模板生效) */
  725. adIntervals: number
  726. /** 广告单元 id */
  727. adUnitId: string
  728. /** 原生模板广告组件的样式 */
  729. style: CreateCustomAdStyleOption
  730. }
  731. /** 原生模板广告组件的样式 */
  732. interface CreateCustomAdStyleOption {
  733. /** (只对小程序适用) 原生模板广告组件是否固定屏幕位置(不跟随屏幕滚动) */
  734. fixed: boolean
  735. /** 原生模板广告组件的左上角横坐标 */
  736. left: number
  737. /** 原生模板广告组件的左上角纵坐标 */
  738. top: number
  739. }
  740. interface CreateGameBannerOption {
  741. /** 推荐单元 id */
  742. adUnitId: string
  743. /** 小游戏推荐banner组件样式 */
  744. style: CreateGameBannerStyleOption
  745. }
  746. /** 小游戏推荐banner组件样式 */
  747. interface CreateGameBannerStyleOption {
  748. /** 小游戏推荐banner组件左上角横坐标 */
  749. left: number
  750. /** 小游戏推荐banner组件左上角纵坐标 */
  751. top: number
  752. }
  753. interface CreateGameClubButtonOption {
  754. /** 游戏圈按钮的图标,仅当 object.type 参数为 image 时有效。
  755. *
  756. * 可选值:
  757. * - 'green': 绿色的图标;
  758. * - 'white': 白色的图标;
  759. * - 'dark': 有黑色圆角背景的白色图标;
  760. * - 'light': 有白色圆角背景的绿色图标; */
  761. icon: 'green' | 'white' | 'dark' | 'light'
  762. /** 按钮的样式 */
  763. style: OptionStyle
  764. /** 按钮的类型。
  765. *
  766. * 可选值:
  767. * - 'text': 可以设置背景色和文本的按钮;
  768. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  769. type: 'text' | 'image'
  770. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  771. image?: string
  772. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  773. text?: string
  774. }
  775. interface CreateGameIconOption {
  776. /** 推荐单元 id */
  777. adUnitId: string
  778. /** 游戏icon的数量,请注意,正式版下面渲染出来的icon数量会小于等于count,请注册做好样式兼容 */
  779. count: number
  780. /** 数组的每一项可以针对对应的icon设置位置和样式等信息,style的每一项称为styleItem */
  781. style: any[]
  782. }
  783. interface CreateGamePortalOption {
  784. /** 推荐单元 id。 */
  785. adUnitId: string
  786. }
  787. interface CreateGameRecorderShareButtonOption {
  788. /** 对局回放的分享参数。 */
  789. share: ShareOption
  790. /** 按钮的样式 */
  791. style: CreateGameRecorderShareButtonStyleOption
  792. /** 图标的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。 */
  793. icon?: string
  794. /** 按钮的背景图片的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。 */
  795. image?: string
  796. /** 按钮的文本。 */
  797. text?: string
  798. }
  799. /** 按钮的样式 */
  800. interface CreateGameRecorderShareButtonStyleOption {
  801. /** 文本的颜色。 */
  802. color?: string
  803. /** 文本的字体大小。最小 17,最大 22。 */
  804. fontSize?: number
  805. /** 按钮的高度,最小 40 逻辑像素 */
  806. height?: number
  807. /** 图标和文本之间的距离,最小 8 逻辑像素 */
  808. iconMarginRight?: number
  809. /** 左上角横坐标,单位 逻辑像素 */
  810. left?: number
  811. /** 按钮的左内边距,最小 16 逻辑像素。 */
  812. paddingLeft?: number
  813. /** 按钮的右内边距,最小 16 逻辑像素。 */
  814. paddingRight?: number
  815. /** 左上角纵坐标,单位 逻辑像素 */
  816. top?: number
  817. }
  818. interface CreateGridAdOption {
  819. /** grid(格子) 广告广告组件的主题,提供 `white` `black` 两种主题选择。 */
  820. adTheme: string
  821. /** 广告单元 id */
  822. adUnitId: string
  823. /** grid(格子) 广告组件的格子个数,可设置爱5,8两种格子个数样式,默认值为5 */
  824. gridCount: number
  825. /** grid(格子) 广告组件的样式 */
  826. style: CreateGridAdStyleOption
  827. /** 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(该参数不传入时 grid(格子) 广告不会自动刷新) */
  828. adIntervals?: number
  829. }
  830. /** grid(格子) 广告组件的样式 */
  831. interface CreateGridAdStyleOption {
  832. /** grid(格子) 广告组件的高度 */
  833. height: number
  834. /** grid(格子) 广告组件的左上角横坐标 */
  835. left: number
  836. /** grid(格子) 广告组件的左上角纵坐标 */
  837. top: number
  838. /** grid(格子) 广告组件的宽度 */
  839. width: number
  840. }
  841. interface CreateInnerAudioContextOption {
  842. /** 需要基础库: `2.19.0`
  843. *
  844. * 是否使用 WebAudio 作为底层音频驱动,默认关闭。对于短音频、播放频繁的音频建议开启此选项,开启后将获得更优的性能表现。由于开启此选项后也会带来一定的内存增长,因此对于长音频建议关闭此选项。 */
  845. useWebAudioImplement?: boolean
  846. }
  847. interface CreateInterstitialAdOption {
  848. /** 广告单元 id */
  849. adUnitId: string
  850. }
  851. interface CreateOpenSettingButtonOption {
  852. /** 按钮的样式 */
  853. style: OptionStyle
  854. /** 按钮的类型。
  855. *
  856. * 可选值:
  857. * - 'text': 可以设置背景色和文本的按钮;
  858. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  859. type: 'text' | 'image'
  860. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  861. image?: string
  862. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  863. text?: string
  864. }
  865. interface CreateRewardedVideoAdOption {
  866. /** 广告单元 id */
  867. adUnitId: string
  868. /** 需要基础库: `2.8.0`
  869. *
  870. * 是否启用多例模式,默认为false */
  871. multiton?: boolean
  872. }
  873. interface CreateRoomOption {
  874. /** 房间最大人数 */
  875. maxMemberNum: number
  876. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  877. complete?: CreateRoomCompleteCallback
  878. /** 接口调用失败的回调函数 */
  879. fail?: CreateRoomFailCallback
  880. /** 游戏对局时长,到达指定时长时游戏会结束,最大值 3600。 */
  881. gameLastTime?: number
  882. /** 游戏自定义的关于个人的扩展信息,其他人可在 `MemberInfo` 中读取到,最多 32 个字节 */
  883. memberExtInfo?: string
  884. /** 是否需要生成游戏随机种子,设置为 true,房间信息会携带 gameSeed 属性 */
  885. needGameSeed?: boolean
  886. /** 是否需要用户头像和昵称
  887. *
  888. * 可选值:
  889. * - 'true': 需要用户头像和昵称,则每个加入房间的人必须授权过用户信息,MemberInfo 中会有 headimage 和 nickname;
  890. * - 'false': 不需要用户头像和昵称,MemberInfo 中不会有 headimage 和 nickname; */
  891. needUserInfo?: 'true' | 'false'
  892. /** 游戏自定义的关于房间扩展信息,其他人可在 `RoomInfo` 中读取到最多 32 个字节 */
  893. roomExtInfo?: string
  894. /** 需要满足百分比的玩家都发送了开始指令才能启动游戏。有效范围 0~100,0 表示只要有一个人调用开始就启动,100 表示要求所有人都开始才能启动。 */
  895. startPercent?: number
  896. /** 接口调用成功的回调函数 */
  897. success?: CreateRoomSuccessCallback
  898. }
  899. interface CreateRoomSuccessCallbackDataResult {
  900. /** 房间唯一标识 */
  901. accessInfo: string
  902. /** 用户在房间内的唯一标识 */
  903. clientId: number
  904. }
  905. interface CreateRoomSuccessCallbackResult {
  906. data: CreateRoomSuccessCallbackDataResult
  907. errMsg: string
  908. }
  909. interface CreateUserInfoButtonOption {
  910. /** 是否带上登录态信息。当 withCredentials 为 true 时,要求此前有调用过 wx.login 且登录态尚未过期,此时返回的数据会包含 encryptedData, iv 等敏感信息;当 withCredentials 为 false 时,不要求有登录态,返回的数据不包含 encryptedData, iv 等敏感信息。 */
  911. withCredentials: boolean
  912. /** 按钮的样式 */
  913. style: OptionStyle
  914. /** 按钮的类型。
  915. *
  916. * 可选值:
  917. * - 'text': 可以设置背景色和文本的按钮;
  918. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  919. type: 'text' | 'image'
  920. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  921. image?: string
  922. /** 描述用户信息的语言
  923. *
  924. * 可选值:
  925. * - 'en': 英文;
  926. * - 'zh_CN': 简体中文;
  927. * - 'zh_TW': 繁体中文; */
  928. lang?: 'en' | 'zh_CN' | 'zh_TW'
  929. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  930. text?: string
  931. }
  932. interface CreateVideoOption {
  933. /** 视频的资源地址 */
  934. src: string
  935. /** 视频跳转后自动暂停播放 */
  936. autoPauseIfNavigate?: boolean
  937. /** 视频跳转原生页后自动暂停播放 */
  938. autoPauseIfOpenNative?: boolean
  939. /** 视频是否自动播放 */
  940. autoplay?: boolean
  941. /** 需要基础库: `2.12.0`
  942. *
  943. * 视频背景颜色 */
  944. backgroundColor?: string
  945. /** 视频是否显示控件 */
  946. controls?: boolean
  947. /** 是否开启双击播放的手势 */
  948. enablePlayGesture?: boolean
  949. /** 是否启用手势控制播放进度 */
  950. enableProgressGesture?: boolean
  951. /** 视频的高度 */
  952. height?: number
  953. /** 视频的初始播放位置,单位为 s 秒 */
  954. initialTime?: number
  955. /** 视频是否为直播 */
  956. live?: boolean
  957. /** 视频是否是否循环播放 */
  958. loop?: boolean
  959. /** 视频是否禁音播放 */
  960. muted?: boolean
  961. /** 需要基础库: `2.4.0`
  962. *
  963. * 视频是否遵循系统静音开关设置(仅iOS) */
  964. obeyMuteSwitch?: boolean
  965. /** 视频的缩放模式
  966. *
  967. * 可选值:
  968. * - 'fill': 填充,视频拉伸填满整个容器,不保证保持原有长宽比例;
  969. * - 'contain': 包含,保持原有长宽比例。保证视频尺寸一定可以在容器里面放得下。因此,可能会有部分空白;
  970. * - 'cover': 覆盖,保持原有长宽比例。保证视频尺寸一定大于容器尺寸,宽度和高度至少有一个和容器一致。因此,视频有部分会看不见; */
  971. objectFit?: 'fill' | 'contain' | 'cover'
  972. /** 视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5 */
  973. playbackRate?: number
  974. /** 视频的封面 */
  975. poster?: string
  976. /** 是否显示视频中央的播放按钮 */
  977. showCenterPlayBtn?: boolean
  978. /** 需要基础库: `2.12.0`
  979. *
  980. * 是否显示视频底部进度条 */
  981. showProgress?: boolean
  982. /** 需要基础库: `2.12.0`
  983. *
  984. * 是否显示控制栏的进度条 */
  985. showProgressInControlMode?: boolean
  986. /** 需要基础库: `2.11.0`
  987. *
  988. * 视频是否显示在游戏画布之下(配合 Canvas.getContext('webgl', {alpha: true}) 使主屏canvas实现透明效果) */
  989. underGameView?: boolean
  990. /** 视频的宽度 */
  991. width?: number
  992. /** 视频的左上角横坐标 */
  993. x?: number
  994. /** 视频的左上角纵坐标 */
  995. y?: number
  996. }
  997. /** 可选参数 */
  998. interface CreateWorkerOption {
  999. /** 需要基础库: `2.13.0`
  1000. *
  1001. * 是否使用实验worker。在iOS下,实验worker的JS运行效率比非实验worker提升近十倍,如需在worker内进行重度计算的建议开启此选项。同时,实验worker存在极小概率会在系统资源紧张时被系统回收,因此建议配合 worker.onProcessKilled 事件使用,在worker被回收后可重新创建一个。 */
  1002. useExperimentalWorker?: boolean
  1003. }
  1004. /** 原生模板广告组件。原生模板广告组件是一个原生组件,层级比普通组件高。原生模板广告组件默认是隐藏的,需要调用 CustomAd.show() 将其显示。如果宽度可配置,原生模板广告会根据开发者设置的宽度进行等比缩放。 */
  1005. interface CustomAd {
  1006. /** 原生模板广告组件的样式 */
  1007. style: CustomAdStyle
  1008. }
  1009. interface CustomAdOnErrorCallbackResult {
  1010. /** 需要基础库: `2.2.2`
  1011. *
  1012. * 错误码
  1013. *
  1014. * 可选值:
  1015. * - 1000: 后端接口调用失败;
  1016. * - 1001: 参数错误;
  1017. * - 1002: 广告单元无效;
  1018. * - 1003: 内部错误;
  1019. * - 1004: 无合适的广告;
  1020. * - 1005: 广告组件审核中;
  1021. * - 1006: 广告组件被驳回;
  1022. * - 1007: 广告组件被封禁;
  1023. * - 1008: 广告单元已关闭;
  1024. * - 2001: 模板渲染错误;
  1025. * - 2002: 模板为空;
  1026. * - 2003: 模板解析失败;
  1027. * - 2004: 触发频率限制;
  1028. * - 2005: 触发频率限制; */
  1029. errCode:
  1030. | 1000
  1031. | 1001
  1032. | 1002
  1033. | 1003
  1034. | 1004
  1035. | 1005
  1036. | 1006
  1037. | 1007
  1038. | 1008
  1039. | 2001
  1040. | 2002
  1041. | 2003
  1042. | 2004
  1043. | 2005
  1044. /** 错误信息 */
  1045. errMsg: string
  1046. }
  1047. /** 原生模板广告组件的样式 */
  1048. interface CustomAdStyle {
  1049. /** (只对小程序适用) 原生模板广告组件是否固定屏幕位置(不跟随屏幕滚动) */
  1050. fixed: boolean
  1051. /** 原生模板广告组件的左上角横坐标 */
  1052. left: number
  1053. /** 原生模板广告组件的左上角纵坐标 */
  1054. top: number
  1055. }
  1056. interface DecodeOption {
  1057. /** 要解码的 ArrayBuffer */
  1058. data: ArrayBuffer
  1059. /** 编码的格式 */
  1060. format: string
  1061. }
  1062. /** 描述符数据 */
  1063. interface Descriptor {
  1064. /** Descriptor 的 UUID */
  1065. uuid: string
  1066. /** 描述符的权限 */
  1067. permission?: DescriptorPermission
  1068. /** 描述符数据 */
  1069. value?: ArrayBuffer
  1070. }
  1071. /** 描述符的权限 */
  1072. interface DescriptorPermission {
  1073. /** 读 */
  1074. read?: boolean
  1075. /** 写 */
  1076. write?: boolean
  1077. }
  1078. interface DownloadFileOption {
  1079. /** 下载资源的 url */
  1080. url: string
  1081. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1082. complete?: DownloadFileCompleteCallback
  1083. /** 接口调用失败的回调函数 */
  1084. fail?: DownloadFileFailCallback
  1085. /** 需要基础库: `1.8.0`
  1086. *
  1087. * 指定文件下载后存储的路径 (本地路径) */
  1088. filePath?: string
  1089. /** HTTP 请求的 Header,Header 中不能设置 Referer */
  1090. header?: IAnyObject
  1091. /** 接口调用成功的回调函数 */
  1092. success?: DownloadFileSuccessCallback
  1093. /** 需要基础库: `2.10.0`
  1094. *
  1095. * 超时时间,单位为毫秒 */
  1096. timeout?: number
  1097. }
  1098. interface DownloadFileSuccessCallbackResult {
  1099. /** 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 */
  1100. filePath: string
  1101. /** 需要基础库: `2.10.4`
  1102. *
  1103. * 网络请求过程中一些调试信息,[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html) */
  1104. profile: RequestProfile
  1105. /** 开发者服务器返回的 HTTP 状态码 */
  1106. statusCode: number
  1107. /** 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件 */
  1108. tempFilePath: string
  1109. errMsg: string
  1110. }
  1111. interface DownloadTaskOnProgressUpdateCallbackResult {
  1112. /** 下载进度百分比 */
  1113. progress: number
  1114. /** 预期需要下载的数据总长度,单位 Bytes */
  1115. totalBytesExpectedToWrite: number
  1116. /** 已经下载的数据长度,单位 Bytes */
  1117. totalBytesWritten: number
  1118. }
  1119. interface EncodeOption {
  1120. /** 要编码的字符串 */
  1121. data: string
  1122. /** 编码的格式 */
  1123. format: string
  1124. }
  1125. interface EndGameOption {
  1126. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1127. complete?: EndGameCompleteCallback
  1128. /** 接口调用失败的回调函数 */
  1129. fail?: EndGameFailCallback
  1130. /** 接口调用成功的回调函数 */
  1131. success?: EndGameSuccessCallback
  1132. }
  1133. interface EndStateServiceOption {
  1134. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1135. complete?: EndStateServiceCompleteCallback
  1136. /** 接口调用失败的回调函数 */
  1137. fail?: EndStateServiceFailCallback
  1138. /** 接口调用成功的回调函数 */
  1139. success?: EndStateServiceSuccessCallback
  1140. }
  1141. /** 启动参数 */
  1142. interface EnterOptionsGame {
  1143. /** 启动小游戏的 query 参数 */
  1144. query: IAnyObject
  1145. /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
  1146. referrerInfo: EnterOptionsGameReferrerInfo
  1147. /** 启动小游戏的[场景值](https://developers.weixin.qq.com/minigame/dev/guide/framework/scene.html) */
  1148. scene: number
  1149. /** 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
  1150. *
  1151. * 可选值:
  1152. * - 1: 微信联系人单聊;
  1153. * - 2: 企业微信联系人单聊;
  1154. * - 3: 普通微信群聊;
  1155. * - 4: 企业微信互通群聊; */
  1156. chatType?: 1 | 2 | 3 | 4
  1157. /** shareTicket,详见[获取更多转发信息](#) */
  1158. shareTicket?: string
  1159. }
  1160. /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
  1161. interface EnterOptionsGameReferrerInfo {
  1162. /** 来源小程序、公众号或 App 的 appId */
  1163. appId: string
  1164. /** 来源小程序传过来的数据,scene=1037或1038时支持 */
  1165. extraData: IAnyObject
  1166. }
  1167. /** 文件读取结果。res.entries 是一个对象,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。 */
  1168. interface EntriesResult {
  1169. /** 文件路径 */
  1170. [path: string]: ZipFileItem
  1171. }
  1172. /** 要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件) */
  1173. interface EntryItem {
  1174. /** 压缩包内文件路径 */
  1175. path: string
  1176. /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
  1177. *
  1178. * 可选值:
  1179. * - 'ascii': ;
  1180. * - 'base64': ;
  1181. * - 'binary': ;
  1182. * - 'hex': ;
  1183. * - 'ucs2': 以小端序读取;
  1184. * - 'ucs-2': 以小端序读取;
  1185. * - 'utf16le': 以小端序读取;
  1186. * - 'utf-16le': 以小端序读取;
  1187. * - 'utf-8': ;
  1188. * - 'utf8': ;
  1189. * - 'latin1': ; */
  1190. encoding?:
  1191. | 'ascii'
  1192. | 'base64'
  1193. | 'binary'
  1194. | 'hex'
  1195. | 'ucs2'
  1196. | 'ucs-2'
  1197. | 'utf16le'
  1198. | 'utf-16le'
  1199. | 'utf-8'
  1200. | 'utf8'
  1201. | 'latin1'
  1202. /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
  1203. length?: number
  1204. /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
  1205. position?: number
  1206. }
  1207. interface ExitMiniProgramOption {
  1208. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1209. complete?: ExitMiniProgramCompleteCallback
  1210. /** 接口调用失败的回调函数 */
  1211. fail?: ExitMiniProgramFailCallback
  1212. /** 接口调用成功的回调函数 */
  1213. success?: ExitMiniProgramSuccessCallback
  1214. }
  1215. interface ExitVoIPChatOption {
  1216. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1217. complete?: ExitVoIPChatCompleteCallback
  1218. /** 接口调用失败的回调函数 */
  1219. fail?: ExitVoIPChatFailCallback
  1220. /** 接口调用成功的回调函数 */
  1221. success?: ExitVoIPChatSuccessCallback
  1222. }
  1223. /** 人脸角度信息,取值范围 [-1, 1],数值越接近 0 表示越正对摄像头 */
  1224. interface FaceAngel {
  1225. /** 仰俯角(点头) */
  1226. pitch: number
  1227. /** 翻滚角(左右倾) */
  1228. roll: number
  1229. /** 偏航角(摇头) */
  1230. yaw: number
  1231. }
  1232. /** 人脸置信度,取值范围 [0, 1],数值越大置信度越高(遮挡越少) */
  1233. interface FaceConf {
  1234. /** 整体可信度 */
  1235. global: number
  1236. /** 左眼可信度 */
  1237. leftEye: number
  1238. /** 嘴巴可信度 */
  1239. mouth: number
  1240. /** 鼻子可信度 */
  1241. nose: number
  1242. /** 右眼可信度 */
  1243. rightEye: number
  1244. }
  1245. interface FaceDetectOption {
  1246. /** 图像像素点数据,每四项表示一个像素点的 RGBA */
  1247. frameBuffer: ArrayBuffer
  1248. /** 图像高度 */
  1249. height: number
  1250. /** 图像宽度 */
  1251. width: number
  1252. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1253. complete?: FaceDetectCompleteCallback
  1254. /** 是否返回当前图像的人脸角度信息 */
  1255. enableAngle?: boolean
  1256. /** 是否返回当前图像的人脸的置信度(可表示器官遮挡情况) */
  1257. enableConf?: boolean
  1258. /** 是否返回多张人脸的信息 */
  1259. enableMultiFace?: boolean
  1260. /** 是否返回当前图像的人脸(106 个点) */
  1261. enablePoint?: boolean
  1262. /** 接口调用失败的回调函数 */
  1263. fail?: FaceDetectFailCallback
  1264. /** 接口调用成功的回调函数 */
  1265. success?: FaceDetectSuccessCallback
  1266. }
  1267. interface FaceDetectSuccessCallbackResult {
  1268. /** 人脸角度信息,取值范围 [-1, 1],数值越接近 0 表示越正对摄像头 */
  1269. angleArray: FaceAngel
  1270. /** 人脸置信度,取值范围 [0, 1],数值越大置信度越高(遮挡越少) */
  1271. confArray: FaceConf
  1272. /** 脸部正方框数值,对象包含 height, weight, originX, originY 四个属性 */
  1273. detectRect: IAnyObject
  1274. /** 多人模式(enableMultiFace)下的人脸信息,每个对象包含上述其它属性 */
  1275. faceInfo: IAnyObject[]
  1276. /** 人脸 106 个点位置数组,数组每个对象包含 x 和 y */
  1277. pointArray: IAnyObject[]
  1278. /** 脸部中心点横坐标,检测不到人脸则为 -1 */
  1279. x: number
  1280. /** 脸部中心点纵坐标,检测不到人脸则为 -1 */
  1281. y: number
  1282. errMsg: string
  1283. }
  1284. /** 用户点击后打开意见反馈页面的按钮 */
  1285. interface FeedbackButton {
  1286. /** 按钮的样式 */
  1287. style: OptionStyle
  1288. /** 按钮的类型。
  1289. *
  1290. * 可选值:
  1291. * - 'text': 可以设置背景色和文本的按钮;
  1292. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  1293. type: 'text' | 'image'
  1294. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  1295. image?: string
  1296. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  1297. text?: string
  1298. }
  1299. /** 文件数组 */
  1300. interface FileItem {
  1301. /** 文件保存时的时间戳,从1970/01/01 08:00:00 到当前时间的秒数 */
  1302. createTime: number
  1303. /** 文件路径 (本地路径) */
  1304. filePath: string
  1305. /** 本地文件大小,以字节为单位 */
  1306. size: number
  1307. }
  1308. interface FileSystemManagerCloseOption {
  1309. /** 需要被关闭的文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  1310. fd: string
  1311. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1312. complete?: CloseCompleteCallback
  1313. /** 接口调用失败的回调函数 */
  1314. fail?: FileSystemManagerCloseFailCallback
  1315. /** 接口调用成功的回调函数 */
  1316. success?: CloseSuccessCallback
  1317. }
  1318. interface FileSystemManagerGetFileInfoOption {
  1319. /** 要读取的文件路径 (本地路径) */
  1320. filePath: string
  1321. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1322. complete?: GetFileInfoCompleteCallback
  1323. /** 接口调用失败的回调函数 */
  1324. fail?: FileSystemManagerGetFileInfoFailCallback
  1325. /** 接口调用成功的回调函数 */
  1326. success?: FileSystemManagerGetFileInfoSuccessCallback
  1327. }
  1328. interface FileSystemManagerGetFileInfoSuccessCallbackResult {
  1329. /** 文件大小,以字节为单位 */
  1330. size: number
  1331. errMsg: string
  1332. }
  1333. /** 视频帧数据,若取不到则返回 null。当缓冲区为空的时候可能暂停取不到数据。 */
  1334. interface FrameDataOptions {
  1335. /** 帧数据 */
  1336. data: ArrayBuffer
  1337. /** 帧数据高度 */
  1338. height: number
  1339. /** 帧原始 dts */
  1340. pkDts: number
  1341. /** 帧原始 pts */
  1342. pkPts: number
  1343. /** 帧数据宽度 */
  1344. width: number
  1345. }
  1346. /** 用户信息 */
  1347. interface FriendInfo {
  1348. /** 用户的微信头像 url */
  1349. avatarUrl: string
  1350. /** 用户的微信昵称 */
  1351. nickname: string
  1352. /** 用户 openid */
  1353. openid: string
  1354. }
  1355. interface FstatFailCallbackResult {
  1356. /** 错误信息
  1357. *
  1358. * 可选值:
  1359. * - 'bad file descriptor': 无效的文件描述符;
  1360. * - 'fail permission denied': 指定的 fd 路径没有读权限; */
  1361. errMsg: string
  1362. }
  1363. interface FstatOption {
  1364. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  1365. fd: string
  1366. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1367. complete?: FstatCompleteCallback
  1368. /** 接口调用失败的回调函数 */
  1369. fail?: FstatFailCallback
  1370. /** 接口调用成功的回调函数 */
  1371. success?: FstatSuccessCallback
  1372. }
  1373. interface FstatSuccessCallbackResult {
  1374. /** [Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)
  1375. *
  1376. * Stats 对象,包含了文件的状态信息 */
  1377. stats: Stats
  1378. errMsg: string
  1379. }
  1380. interface FstatSyncOption {
  1381. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  1382. fd: string
  1383. }
  1384. interface FtruncateFailCallbackResult {
  1385. /** 错误信息
  1386. *
  1387. * 可选值:
  1388. * - 'bad file descriptor': 无效的文件描述符;
  1389. * - 'fail permission denied': 指定的 fd 没有写权限;
  1390. * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
  1391. * - 'fail sdcard not mounted': android sdcard 挂载失败; */
  1392. errMsg: string
  1393. }
  1394. interface FtruncateOption {
  1395. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  1396. fd: string
  1397. /** 截断位置,默认0。如果 length 小于文件长度(单位:字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
  1398. length: number
  1399. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1400. complete?: FtruncateCompleteCallback
  1401. /** 接口调用失败的回调函数 */
  1402. fail?: FtruncateFailCallback
  1403. /** 接口调用成功的回调函数 */
  1404. success?: FtruncateSuccessCallback
  1405. }
  1406. interface FtruncateSyncOption {
  1407. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  1408. fd: string
  1409. /** 截断位置,默认0。如果 length 小于文件长度(单位:字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
  1410. length: number
  1411. }
  1412. /** 小游戏推荐banner组件。小游戏推荐banner组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。小游戏推荐banner组件默认是隐藏的,需要调用 GameBanner.show() 将其显示。 */
  1413. interface GameBanner {
  1414. /** 是否已销毁的标记位 */
  1415. isDestroyed: boolean
  1416. /** 小游戏推荐banner组件的样式。style 上的属性的值仅为开发者设置的值,开发者设置的异常值会被忽略,最终的尺寸和位置信息通过GameBanner.onResize() 事件获得。 */
  1417. style: GameBannerStyle
  1418. }
  1419. interface GameBannerOnErrorCallbackResult {
  1420. /** 错误码
  1421. *
  1422. * 可选值:
  1423. * - 1000: 内部错误;
  1424. * - 1001: 参数错误;
  1425. * - 1002: 无效的推荐位,请检查推荐id是否正确;
  1426. * - 1004: 无合适的推荐;
  1427. * - 1008: 推荐单元已关闭; */
  1428. errCode: 1000 | 1001 | 1002 | 1004 | 1008
  1429. /** 需要基础库: `2.7.7`
  1430. *
  1431. * 错误信息 */
  1432. errMsg: string
  1433. }
  1434. /** 小游戏推荐banner组件的样式。style 上的属性的值仅为开发者设置的值,开发者设置的异常值会被忽略,最终的尺寸和位置信息通过GameBanner.onResize() 事件获得。 */
  1435. interface GameBannerStyle {
  1436. /** 小游戏推荐banner组件的左上角横坐标 */
  1437. left: number
  1438. /** 小游戏推荐banner组件的左上角纵坐标 */
  1439. top: number
  1440. }
  1441. /** 游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈。更多关于游戏圈的信息见 [游戏圈使用指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/game-club.html) */
  1442. interface GameClubButton {
  1443. /** 游戏圈按钮的图标,仅当 type 参数为 image 时有效。
  1444. *
  1445. * 可选值:
  1446. * - 'green': 绿色的图标;
  1447. * - 'white': 白色的图标;
  1448. * - 'dark': 有黑色圆角背景的白色图标;
  1449. * - 'light': 有白色圆角背景的绿色图标; */
  1450. icon: 'green' | 'white' | 'dark' | 'light'
  1451. /** 按钮的样式 */
  1452. style: OptionStyle
  1453. /** 按钮的类型。
  1454. *
  1455. * 可选值:
  1456. * - 'text': 可以设置背景色和文本的按钮;
  1457. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  1458. type: 'text' | 'image'
  1459. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  1460. image?: string
  1461. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  1462. text?: string
  1463. }
  1464. /** 小游戏推荐icon组件。小游戏推荐icon组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。小游戏推荐icon组件默认是隐藏的,需要调用 GameIcon.show() 将其显示。 */
  1465. interface GameIcon {
  1466. /** 单个游戏icon的位置和样式等信息 */
  1467. iconItem: IconItem
  1468. /** 每个icon渲染出来之后都有位置、尺寸和样式等信息,统一由icons数组维护,数组的每一项称为iconItem */
  1469. icons: any[]
  1470. /** 是否已销毁的标记位 */
  1471. isDestroyed: boolean
  1472. }
  1473. /** 小游戏推荐弹窗组件。小游戏推荐弹窗组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。小游戏推荐弹窗组件默认是隐藏的,需要调用 GamePortal.show() 将其显示。 */
  1474. interface GamePortal {
  1475. /** 组件是否已销毁的标记位。 */
  1476. isDestroyed: boolean
  1477. }
  1478. interface GamePortalOnErrorCallbackResult {
  1479. /** 错误码
  1480. *
  1481. * 可选值:
  1482. * - 1000: 内部错误;
  1483. * - 1001: 参数错误;
  1484. * - 1002: 无效的推荐位,请检查推荐位id是否正确;
  1485. * - 1004: 无合适的推荐;
  1486. * - 1008: 推荐位已关闭; */
  1487. errCode: 1000 | 1001 | 1002 | 1004 | 1008
  1488. /** 需要基础库: `2.7.7`
  1489. *
  1490. * 错误信息 */
  1491. errMsg: string
  1492. }
  1493. /** 需要基础库: `2.8.0`
  1494. *
  1495. * 游戏对局回放分享按钮。按钮在被用户点击后会发起对最近一次录制完成的游戏对局回放的分享。 */
  1496. interface GameRecorderShareButton {
  1497. /** 对局回放的分享参数。 */
  1498. share: Share
  1499. /** 按钮的样式 */
  1500. style: GameRecorderShareButtonStyle
  1501. /** 图标的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。icon尺寸固定,高16px,宽24px。 */
  1502. icon?: string
  1503. /** 按钮的背景图片的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。 */
  1504. image?: string
  1505. /** 按钮的文本。 */
  1506. text?: string
  1507. }
  1508. /** 按钮的样式 */
  1509. interface GameRecorderShareButtonStyle {
  1510. /** 按钮背景颜色,十六进制颜色值,'transparent'为透明背景。 */
  1511. backgroundColor?: string
  1512. /** 按钮圆角大小,单位为逻辑像素。 */
  1513. borderRadius?: number
  1514. /** 文本的颜色。 */
  1515. color?: string
  1516. /** 文本的字体大小。最小 17,最大 22。 */
  1517. fontSize?: number
  1518. /** 按钮的高度,最小 40 逻辑像素 */
  1519. height?: number
  1520. /** 图标和文本之间的距离,最小 8 逻辑像素 */
  1521. iconMarginRight?: number
  1522. /** 左上角横坐标,单位 逻辑像素 */
  1523. left?: number
  1524. /** 按钮的左内边距,最小 16 逻辑像素。 */
  1525. paddingLeft?: number
  1526. /** 按钮的右内边距,最小 16 逻辑像素。 */
  1527. paddingRight?: number
  1528. /** 左上角纵坐标,单位 逻辑像素 */
  1529. top?: number
  1530. }
  1531. interface GameRecorderStartOption {
  1532. /** 视频比特率(kbps),默认值1000,最大值 3000,最小值 600 */
  1533. bitrate?: number
  1534. /** 视频的时长限制,单位为秒(s)。最大值 7200,最小值 5,到达指定时长后不会再录入。但还需要手动调用 [GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html) 来结束录制。 */
  1535. duration?: number
  1536. /** 视频 fps */
  1537. fps?: number
  1538. /** 视频关键帧间隔 */
  1539. gop?: number
  1540. /** 需要基础库: `2.10.0`
  1541. *
  1542. * 是否录制游戏音效(仅iOS支持) */
  1543. hookBgm?: boolean
  1544. }
  1545. interface GameServerManagerOnDisconnectCallbackResult {
  1546. res: OnDisconnectCallbackResult
  1547. }
  1548. interface GameServerManagerOnMatchCallbackResult {
  1549. res: OnMatchCallbackResult
  1550. }
  1551. interface GameServerManagerOnRoomInfoChangeCallbackResult {
  1552. res: OnRoomInfoChangeCallbackResult
  1553. }
  1554. interface GameServerManagerOnStateUpdateCallbackResult {
  1555. res: OnStateUpdateCallbackResult
  1556. }
  1557. interface GeneralCallbackResult {
  1558. /** 错误信息 */
  1559. errMsg: string
  1560. }
  1561. interface GetAvailableAudioSourcesOption {
  1562. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1563. complete?: GetAvailableAudioSourcesCompleteCallback
  1564. /** 接口调用失败的回调函数 */
  1565. fail?: GetAvailableAudioSourcesFailCallback
  1566. /** 接口调用成功的回调函数 */
  1567. success?: GetAvailableAudioSourcesSuccessCallback
  1568. }
  1569. interface GetAvailableAudioSourcesSuccessCallbackResult {
  1570. /** 支持的音频输入源列表,可在 [RecorderManager.start()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.start.html) 接口中使用。返回值定义参考 https://developer.android.com/reference/kotlin/android/media/MediaRecorder.AudioSource
  1571. *
  1572. * 可选值:
  1573. * - 'auto': 自动设置,默认使用手机麦克风,插上耳麦后自动切换使用耳机麦克风,所有平台适用;
  1574. * - 'buildInMic': 手机麦克风,仅限 iOS;
  1575. * - 'headsetMic': 耳机麦克风,仅限 iOS;
  1576. * - 'mic': 麦克风(没插耳麦时是手机麦克风,插耳麦时是耳机麦克风),仅限 Android;
  1577. * - 'camcorder': 同 mic,适用于录制音视频内容,仅限 Android;
  1578. * - 'voice_communication': 同 mic,适用于实时沟通,仅限 Android;
  1579. * - 'voice_recognition': 同 mic,适用于语音识别,仅限 Android; */
  1580. audioSources: Array<
  1581. | 'auto'
  1582. | 'buildInMic'
  1583. | 'headsetMic'
  1584. | 'mic'
  1585. | 'camcorder'
  1586. | 'voice_communication'
  1587. | 'voice_recognition'
  1588. >
  1589. errMsg: string
  1590. }
  1591. interface GetBLEDeviceCharacteristicsOption {
  1592. /** 蓝牙设备 id。需要已经通过 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 建立连接 */
  1593. deviceId: string
  1594. /** 蓝牙服务 UUID。需要先调用 [wx.getBLEDeviceServices](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceServices.html) 获取 */
  1595. serviceId: string
  1596. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1597. complete?: GetBLEDeviceCharacteristicsCompleteCallback
  1598. /** 接口调用失败的回调函数 */
  1599. fail?: GetBLEDeviceCharacteristicsFailCallback
  1600. /** 接口调用成功的回调函数 */
  1601. success?: GetBLEDeviceCharacteristicsSuccessCallback
  1602. }
  1603. interface GetBLEDeviceCharacteristicsSuccessCallbackResult {
  1604. /** 设备特征列表 */
  1605. characteristics: BLECharacteristic[]
  1606. errMsg: string
  1607. }
  1608. interface GetBLEDeviceRSSIOption {
  1609. /** 蓝牙设备 id */
  1610. deviceId: string
  1611. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1612. complete?: GetBLEDeviceRSSICompleteCallback
  1613. /** 接口调用失败的回调函数 */
  1614. fail?: GetBLEDeviceRSSIFailCallback
  1615. /** 接口调用成功的回调函数 */
  1616. success?: GetBLEDeviceRSSISuccessCallback
  1617. }
  1618. interface GetBLEDeviceRSSISuccessCallbackResult {
  1619. /** 信号强度,单位 dBm */
  1620. RSSI: number
  1621. errMsg: string
  1622. }
  1623. interface GetBLEDeviceServicesOption {
  1624. /** 蓝牙设备 id。需要已经通过 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 建立连接 */
  1625. deviceId: string
  1626. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1627. complete?: GetBLEDeviceServicesCompleteCallback
  1628. /** 接口调用失败的回调函数 */
  1629. fail?: GetBLEDeviceServicesFailCallback
  1630. /** 接口调用成功的回调函数 */
  1631. success?: GetBLEDeviceServicesSuccessCallback
  1632. }
  1633. interface GetBLEDeviceServicesSuccessCallbackResult {
  1634. /** 设备服务列表 */
  1635. services: BLEService[]
  1636. errMsg: string
  1637. }
  1638. interface GetBLEMTUOption {
  1639. /** 蓝牙设备 id */
  1640. deviceId: string
  1641. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1642. complete?: GetBLEMTUCompleteCallback
  1643. /** 接口调用失败的回调函数 */
  1644. fail?: GetBLEMTUFailCallback
  1645. /** 接口调用成功的回调函数 */
  1646. success?: GetBLEMTUSuccessCallback
  1647. /** 写模式 (iOS 特有参数)
  1648. *
  1649. * 可选值:
  1650. * - 'write': 有回复写;
  1651. * - 'writeNoResponse': 无回复写; */
  1652. writeType?: 'write' | 'writeNoResponse'
  1653. }
  1654. interface GetBLEMTUSuccessCallbackResult {
  1655. /** 最大传输单元 */
  1656. mtu: number
  1657. errMsg: string
  1658. }
  1659. interface GetBatteryInfoOption {
  1660. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1661. complete?: GetBatteryInfoCompleteCallback
  1662. /** 接口调用失败的回调函数 */
  1663. fail?: GetBatteryInfoFailCallback
  1664. /** 接口调用成功的回调函数 */
  1665. success?: GetBatteryInfoSuccessCallback
  1666. }
  1667. interface GetBatteryInfoSuccessCallbackResult {
  1668. /** 是否正在充电中 */
  1669. isCharging: boolean
  1670. /** 设备电量,范围 1 - 100 */
  1671. level: number
  1672. errMsg: string
  1673. }
  1674. interface GetBatteryInfoSyncResult {
  1675. /** 是否正在充电中 */
  1676. isCharging: boolean
  1677. /** 设备电量,范围 1 - 100 */
  1678. level: number
  1679. }
  1680. interface GetBeaconsOption {
  1681. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1682. complete?: GetBeaconsCompleteCallback
  1683. /** 接口调用失败的回调函数 */
  1684. fail?: GetBeaconsFailCallback
  1685. /** 接口调用成功的回调函数 */
  1686. success?: GetBeaconsSuccessCallback
  1687. }
  1688. interface GetBeaconsSuccessCallbackResult {
  1689. /** Beacon 设备列表 */
  1690. beacons: BeaconInfo[]
  1691. errMsg: string
  1692. }
  1693. interface GetBluetoothAdapterStateOption {
  1694. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1695. complete?: GetBluetoothAdapterStateCompleteCallback
  1696. /** 接口调用失败的回调函数 */
  1697. fail?: GetBluetoothAdapterStateFailCallback
  1698. /** 接口调用成功的回调函数 */
  1699. success?: GetBluetoothAdapterStateSuccessCallback
  1700. }
  1701. interface GetBluetoothAdapterStateSuccessCallbackResult {
  1702. /** 蓝牙适配器是否可用 */
  1703. available: boolean
  1704. /** 是否正在搜索设备 */
  1705. discovering: boolean
  1706. errMsg: string
  1707. }
  1708. interface GetBluetoothDevicesOption {
  1709. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1710. complete?: GetBluetoothDevicesCompleteCallback
  1711. /** 接口调用失败的回调函数 */
  1712. fail?: GetBluetoothDevicesFailCallback
  1713. /** 接口调用成功的回调函数 */
  1714. success?: GetBluetoothDevicesSuccessCallback
  1715. }
  1716. interface GetBluetoothDevicesSuccessCallbackResult {
  1717. /** UUID 对应的已连接设备列表 */
  1718. devices: BlueToothDevice[]
  1719. errMsg: string
  1720. }
  1721. interface GetChannelsLiveInfoOption {
  1722. /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
  1723. finderUserName: string
  1724. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1725. complete?: GetChannelsLiveInfoCompleteCallback
  1726. /** 接口调用失败的回调函数 */
  1727. fail?: GetChannelsLiveInfoFailCallback
  1728. /** 接口调用成功的回调函数 */
  1729. success?: GetChannelsLiveInfoSuccessCallback
  1730. }
  1731. interface GetChannelsLiveInfoSuccessCallbackResult {
  1732. /** 直播主题 */
  1733. description: string
  1734. /** 直播 feedId */
  1735. feedId: string
  1736. /** 视频号头像 */
  1737. headUrl: string
  1738. /** 视频号昵称 */
  1739. nickname: string
  1740. /** 直播 nonceId */
  1741. nonceId: string
  1742. /** 直播状态,2直播中,3直播结束 */
  1743. status: number
  1744. errMsg: string
  1745. }
  1746. interface GetChannelsLiveNoticeInfoOption {
  1747. /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
  1748. finderUserName: string
  1749. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1750. complete?: GetChannelsLiveNoticeInfoCompleteCallback
  1751. /** 接口调用失败的回调函数 */
  1752. fail?: GetChannelsLiveNoticeInfoFailCallback
  1753. /** 接口调用成功的回调函数 */
  1754. success?: GetChannelsLiveNoticeInfoSuccessCallback
  1755. }
  1756. interface GetChannelsLiveNoticeInfoSuccessCallbackResult {
  1757. /** 直播封面 */
  1758. headUrl: string
  1759. /** 视频号昵称 */
  1760. nickname: string
  1761. /** 预告 id */
  1762. noticeId: string
  1763. /** 是否可预约 */
  1764. reservable: boolean
  1765. /** 开始时间 */
  1766. startTime: string
  1767. /** 预告状态:0可用 1取消 2已用 */
  1768. status: number
  1769. errMsg: string
  1770. }
  1771. interface GetClipboardDataOption {
  1772. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1773. complete?: GetClipboardDataCompleteCallback
  1774. /** 接口调用失败的回调函数 */
  1775. fail?: GetClipboardDataFailCallback
  1776. /** 接口调用成功的回调函数 */
  1777. success?: GetClipboardDataSuccessCallback
  1778. }
  1779. interface GetClipboardDataSuccessCallbackOption {
  1780. /** 剪贴板的内容 */
  1781. data: string
  1782. }
  1783. interface GetConnectedBluetoothDevicesOption {
  1784. /** 蓝牙设备主服务的 UUID 列表(支持 16/32/128 位 UUID) */
  1785. services: string[]
  1786. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1787. complete?: GetConnectedBluetoothDevicesCompleteCallback
  1788. /** 接口调用失败的回调函数 */
  1789. fail?: GetConnectedBluetoothDevicesFailCallback
  1790. /** 接口调用成功的回调函数 */
  1791. success?: GetConnectedBluetoothDevicesSuccessCallback
  1792. }
  1793. interface GetConnectedBluetoothDevicesSuccessCallbackResult {
  1794. /** 搜索到的设备列表 */
  1795. devices: BluetoothDeviceInfo[]
  1796. errMsg: string
  1797. }
  1798. interface GetExtConfigOption {
  1799. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1800. complete?: GetExtConfigCompleteCallback
  1801. /** 接口调用失败的回调函数 */
  1802. fail?: GetExtConfigFailCallback
  1803. /** 接口调用成功的回调函数 */
  1804. success?: GetExtConfigSuccessCallback
  1805. }
  1806. interface GetExtConfigSuccessCallbackResult {
  1807. /** 第三方平台自定义的数据 */
  1808. extConfig: IAnyObject
  1809. errMsg: string
  1810. }
  1811. interface GetFileInfoFailCallbackResult {
  1812. /** 错误信息
  1813. *
  1814. * 可选值:
  1815. * - 'fail file not exist': 指定的 filePath 找不到文件; */
  1816. errMsg: string
  1817. }
  1818. interface GetFriendCloudStorageOption {
  1819. /** 要拉取的 key 列表 */
  1820. keyList: string[]
  1821. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1822. complete?: GetFriendCloudStorageCompleteCallback
  1823. /** 接口调用失败的回调函数 */
  1824. fail?: GetFriendCloudStorageFailCallback
  1825. /** 接口调用成功的回调函数 */
  1826. success?: GetFriendCloudStorageSuccessCallback
  1827. }
  1828. interface GetFriendCloudStorageSuccessCallbackResult {
  1829. /** 同玩好友的托管数据 */
  1830. data: UserGameData[]
  1831. errMsg: string
  1832. }
  1833. interface GetFriendsStateDataOption {
  1834. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1835. complete?: GetFriendsStateDataCompleteCallback
  1836. /** 接口调用失败的回调函数 */
  1837. fail?: GetFriendsStateDataFailCallback
  1838. /** 接口调用成功的回调函数 */
  1839. success?: GetFriendsStateDataSuccessCallback
  1840. }
  1841. interface GetGroupCloudStorageOption {
  1842. /** 要拉取的 key 列表 */
  1843. keyList: string[]
  1844. /** 群分享对应的 shareTicket */
  1845. shareTicket: string
  1846. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1847. complete?: GetGroupCloudStorageCompleteCallback
  1848. /** 接口调用失败的回调函数 */
  1849. fail?: GetGroupCloudStorageFailCallback
  1850. /** 接口调用成功的回调函数 */
  1851. success?: GetGroupCloudStorageSuccessCallback
  1852. }
  1853. interface GetGroupCloudStorageSuccessCallbackResult {
  1854. /** 群同玩成员的托管数据 */
  1855. data: UserGameData[]
  1856. errMsg: string
  1857. }
  1858. interface GetGroupEnterInfoOption {
  1859. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1860. complete?: GetGroupEnterInfoCompleteCallback
  1861. /** 接口调用失败的回调函数 */
  1862. fail?: GetGroupEnterInfoFailCallback
  1863. /** 接口调用成功的回调函数 */
  1864. success?: GetGroupEnterInfoSuccessCallback
  1865. }
  1866. interface GetGroupEnterInfoSuccessCallbackResult {
  1867. /** 需要基础库: `2.7.0`
  1868. *
  1869. * 敏感数据对应的云 ID,开通[云开发](https://developers.weixin.qq.com/minigame/dev/wxcloud/basis/getting-started.html)的小程序才会返回,可通过云调用直接获取开放数据,详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#method-cloud) */
  1870. cloudID: string
  1871. /** 包括敏感数据在内的完整转发信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  1872. encryptedData: string
  1873. /** 错误信息 */
  1874. errMsg: string
  1875. /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  1876. iv: string
  1877. }
  1878. interface GetGroupInfoOption {
  1879. /** 群 openGId,可通过 `wx.getShareInfo` 获取 */
  1880. openGId: string
  1881. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1882. complete?: GetGroupInfoCompleteCallback
  1883. /** 接口调用失败的回调函数 */
  1884. fail?: GetGroupInfoFailCallback
  1885. /** 接口调用成功的回调函数 */
  1886. success?: GetGroupInfoSuccessCallback
  1887. }
  1888. interface GetGroupInfoSuccessCallbackResult {
  1889. /** 群名称 */
  1890. name: string
  1891. errMsg: string
  1892. }
  1893. interface GetLastRoomInfoOption {
  1894. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1895. complete?: GetLastRoomInfoCompleteCallback
  1896. /** 接口调用失败的回调函数 */
  1897. fail?: GetLastRoomInfoFailCallback
  1898. /** 接口调用成功的回调函数 */
  1899. success?: GetLastRoomInfoSuccessCallback
  1900. }
  1901. interface GetLastRoomInfoSuccessCallbackDataResult {
  1902. /** 最近参与房间的 accessInfo */
  1903. accessInfo: string
  1904. /** 最近参与房间的详细信息 */
  1905. roomInfo: RoomInfo
  1906. }
  1907. interface GetLastRoomInfoSuccessCallbackResult {
  1908. data: GetLastRoomInfoSuccessCallbackDataResult
  1909. errMsg: string
  1910. }
  1911. interface GetLatestUserKeyOption {
  1912. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1913. complete?: GetLatestUserKeyCompleteCallback
  1914. /** 接口调用失败的回调函数 */
  1915. fail?: GetLatestUserKeyFailCallback
  1916. /** 接口调用成功的回调函数 */
  1917. success?: GetLatestUserKeySuccessCallback
  1918. }
  1919. interface GetLatestUserKeySuccessCallbackResult {
  1920. /** 用户加密密钥 */
  1921. encryptKey: string
  1922. /** 密钥过期时间 */
  1923. expireTime: number
  1924. /** 密钥初始向量 */
  1925. iv: string
  1926. /** 密钥版本 */
  1927. version: number
  1928. errMsg: string
  1929. }
  1930. interface GetLocalIPAddressOption {
  1931. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1932. complete?: GetLocalIPAddressCompleteCallback
  1933. /** 接口调用失败的回调函数 */
  1934. fail?: GetLocalIPAddressFailCallback
  1935. /** 接口调用成功的回调函数 */
  1936. success?: GetLocalIPAddressSuccessCallback
  1937. }
  1938. interface GetLocalIPAddressSuccessCallbackResult {
  1939. /** 错误信息 */
  1940. errMsg: string
  1941. /** 本机局域网IP地址 */
  1942. localip: string
  1943. }
  1944. interface GetLocationOption {
  1945. /** 需要基础库: `1.6.0`
  1946. *
  1947. * 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 */
  1948. altitude?: boolean
  1949. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  1950. complete?: GetLocationCompleteCallback
  1951. /** 接口调用失败的回调函数 */
  1952. fail?: GetLocationFailCallback
  1953. /** 需要基础库: `2.9.0`
  1954. *
  1955. * 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 */
  1956. highAccuracyExpireTime?: number
  1957. /** 需要基础库: `2.9.0`
  1958. *
  1959. * 开启高精度定位 */
  1960. isHighAccuracy?: boolean
  1961. /** 接口调用成功的回调函数 */
  1962. success?: GetLocationSuccessCallback
  1963. /** wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标 */
  1964. type?: string
  1965. }
  1966. interface GetLocationSuccessCallbackResult {
  1967. /** 位置的精确度,反应与真实位置之间的接近程度,可以理解成10即与真实位置相差10m,越小越精确 */
  1968. accuracy: number
  1969. /** 需要基础库: `1.2.0`
  1970. *
  1971. * 高度,单位 m */
  1972. altitude: number
  1973. /** 需要基础库: `1.2.0`
  1974. *
  1975. * 水平精度,单位 m */
  1976. horizontalAccuracy: number
  1977. /** 纬度,范围为 -90~90,负数表示南纬 */
  1978. latitude: number
  1979. /** 经度,范围为 -180~180,负数表示西经 */
  1980. longitude: number
  1981. /** 速度,单位 m/s */
  1982. speed: number
  1983. /** 需要基础库: `1.2.0`
  1984. *
  1985. * 垂直精度,单位 m(Android 无法获取,返回 0) */
  1986. verticalAccuracy: number
  1987. errMsg: string
  1988. }
  1989. interface GetLogManagerOption {
  1990. /** 需要基础库: `2.3.2`
  1991. *
  1992. * 取值为0/1,取值为0表示会把 `App`、`Page` 的生命周期函数和 `wx` 命名空间下的函数调用写入日志,取值为1则不会。默认值是 0 */
  1993. level?: number
  1994. }
  1995. interface GetLostFramesOption {
  1996. /** 起始帧号。不填或非法值默认从第 1 帧开始补 */
  1997. beginFrameId: number
  1998. /** 结尾帧号。不填或非法值默认补到当前最新帧 */
  1999. endFrameId: number
  2000. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2001. complete?: GetLostFramesCompleteCallback
  2002. /** 接口调用失败的回调函数 */
  2003. fail?: GetLostFramesFailCallback
  2004. /** 接口调用成功的回调函数 */
  2005. success?: GetLostFramesSuccessCallback
  2006. }
  2007. interface GetLostFramesSuccessCallbackDataResult {
  2008. /** 丢失的帧数组 */
  2009. frameList: any[]
  2010. }
  2011. interface GetLostFramesSuccessCallbackResult {
  2012. data: GetLostFramesSuccessCallbackDataResult
  2013. errMsg: string
  2014. }
  2015. interface GetNetworkTypeOption {
  2016. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2017. complete?: GetNetworkTypeCompleteCallback
  2018. /** 接口调用失败的回调函数 */
  2019. fail?: GetNetworkTypeFailCallback
  2020. /** 接口调用成功的回调函数 */
  2021. success?: GetNetworkTypeSuccessCallback
  2022. }
  2023. interface GetNetworkTypeSuccessCallbackResult {
  2024. /** 网络类型
  2025. *
  2026. * 可选值:
  2027. * - 'wifi': wifi 网络;
  2028. * - '2g': 2g 网络;
  2029. * - '3g': 3g 网络;
  2030. * - '4g': 4g 网络;
  2031. * - '5g': 5g 网络;
  2032. * - 'unknown': Android 下不常见的网络类型;
  2033. * - 'none': 无网络; */
  2034. networkType: 'wifi' | '2g' | '3g' | '4g' | '5g' | 'unknown' | 'none'
  2035. /** 信号强弱,单位 dbm */
  2036. signalStrength: number
  2037. errMsg: string
  2038. }
  2039. interface GetPotentialFriendListOption {
  2040. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2041. complete?: GetPotentialFriendListCompleteCallback
  2042. /** 接口调用失败的回调函数 */
  2043. fail?: GetPotentialFriendListFailCallback
  2044. /** 接口调用成功的回调函数 */
  2045. success?: GetPotentialFriendListSuccessCallback
  2046. }
  2047. interface GetPotentialFriendListSuccessCallbackResult {
  2048. /** 可能对游戏感兴趣的未注册好友名单 */
  2049. list: FriendInfo[]
  2050. errMsg: string
  2051. }
  2052. interface GetRandomValuesOption {
  2053. /** 整数,生成随机数的字节数,最大 1048576 */
  2054. length: number
  2055. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2056. complete?: GetRandomValuesCompleteCallback
  2057. /** 接口调用失败的回调函数 */
  2058. fail?: GetRandomValuesFailCallback
  2059. /** 接口调用成功的回调函数 */
  2060. success?: GetRandomValuesSuccessCallback
  2061. }
  2062. interface GetRandomValuesSuccessCallbackResult {
  2063. /** 随机数内容,长度为传入的字节数 */
  2064. randomValues: ArrayBuffer
  2065. errMsg: string
  2066. }
  2067. interface GetRoomInfoOption {
  2068. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2069. complete?: GetRoomInfoCompleteCallback
  2070. /** 接口调用失败的回调函数 */
  2071. fail?: GetRoomInfoFailCallback
  2072. /** 接口调用成功的回调函数 */
  2073. success?: GetRoomInfoSuccessCallback
  2074. }
  2075. interface GetRoomInfoSuccessCallbackDataResult {
  2076. roomInfo: RoomInfo
  2077. }
  2078. interface GetRoomInfoSuccessCallbackResult {
  2079. data: GetRoomInfoSuccessCallbackDataResult
  2080. errMsg: string
  2081. }
  2082. interface GetSavedFileListOption {
  2083. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2084. complete?: GetSavedFileListCompleteCallback
  2085. /** 接口调用失败的回调函数 */
  2086. fail?: GetSavedFileListFailCallback
  2087. /** 接口调用成功的回调函数 */
  2088. success?: GetSavedFileListSuccessCallback
  2089. }
  2090. interface GetSavedFileListSuccessCallbackResult {
  2091. /** 文件数组 */
  2092. fileList: FileItem[]
  2093. errMsg: string
  2094. }
  2095. interface GetScreenBrightnessOption {
  2096. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2097. complete?: GetScreenBrightnessCompleteCallback
  2098. /** 接口调用失败的回调函数 */
  2099. fail?: GetScreenBrightnessFailCallback
  2100. /** 接口调用成功的回调函数 */
  2101. success?: GetScreenBrightnessSuccessCallback
  2102. }
  2103. interface GetScreenBrightnessSuccessCallbackOption {
  2104. /** 屏幕亮度值,范围 0 ~ 1,0 最暗,1 最亮 */
  2105. value: number
  2106. }
  2107. interface GetSettingOption {
  2108. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2109. complete?: GetSettingCompleteCallback
  2110. /** 接口调用失败的回调函数 */
  2111. fail?: GetSettingFailCallback
  2112. /** 接口调用成功的回调函数 */
  2113. success?: GetSettingSuccessCallback
  2114. /** 需要基础库: `2.10.1`
  2115. *
  2116. * 是否同时获取用户订阅消息的订阅状态,默认不获取。注意:withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择,不再询问”的订阅消息。 */
  2117. withSubscriptions?: boolean
  2118. }
  2119. interface GetSettingSuccessCallbackResult {
  2120. /** [AuthSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/AuthSetting.html)
  2121. *
  2122. * 用户授权结果 */
  2123. authSetting: AuthSetting
  2124. /** [SubscriptionsSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/SubscriptionsSetting.html)
  2125. *
  2126. * 需要基础库: `2.10.1`
  2127. *
  2128. * 用户订阅消息设置,接口参数`withSubscriptions`值为`true`时才会返回。 */
  2129. subscriptionsSetting: SubscriptionsSetting
  2130. /** [AuthSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/AuthSetting.html)
  2131. *
  2132. * 在插件中调用时,当前宿主小程序的用户授权结果 */
  2133. miniprogramAuthSetting?: AuthSetting
  2134. errMsg: string
  2135. }
  2136. interface GetShareInfoOption {
  2137. /** shareTicket */
  2138. shareTicket: string
  2139. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2140. complete?: GetShareInfoCompleteCallback
  2141. /** 接口调用失败的回调函数 */
  2142. fail?: GetShareInfoFailCallback
  2143. /** 接口调用成功的回调函数 */
  2144. success?: GetShareInfoSuccessCallback
  2145. /** 需要基础库: `1.9.90`
  2146. *
  2147. * 超时时间,单位 ms */
  2148. timeout?: number
  2149. }
  2150. interface GetStorageInfoOption {
  2151. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2152. complete?: GetStorageInfoCompleteCallback
  2153. /** 接口调用失败的回调函数 */
  2154. fail?: GetStorageInfoFailCallback
  2155. /** 接口调用成功的回调函数 */
  2156. success?: GetStorageInfoSuccessCallback
  2157. }
  2158. interface GetStorageInfoSuccessCallbackOption {
  2159. /** 当前占用的空间大小, 单位 KB */
  2160. currentSize: number
  2161. /** 当前 storage 中所有的 key */
  2162. keys: string[]
  2163. /** 限制的空间大小,单位 KB */
  2164. limitSize: number
  2165. }
  2166. interface GetStorageInfoSyncOption {
  2167. /** 当前占用的空间大小, 单位 KB */
  2168. currentSize: number
  2169. /** 当前 storage 中所有的 key */
  2170. keys: string[]
  2171. /** 限制的空间大小,单位 KB */
  2172. limitSize: number
  2173. }
  2174. interface GetStorageOption<T = any> {
  2175. /** 本地缓存中指定的 key */
  2176. key: string
  2177. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2178. complete?: GetStorageCompleteCallback
  2179. /** 需要基础库: `2.21.3`
  2180. *
  2181. * 是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true */
  2182. encrypt?: boolean
  2183. /** 接口调用失败的回调函数 */
  2184. fail?: GetStorageFailCallback
  2185. /** 接口调用成功的回调函数 */
  2186. success?: GetStorageSuccessCallback<T>
  2187. }
  2188. interface GetStorageSuccessCallbackResult<T = any> {
  2189. /** key对应的内容 */
  2190. data: T
  2191. errMsg: string
  2192. }
  2193. interface GetSystemInfoAsyncOption {
  2194. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2195. complete?: GetSystemInfoAsyncCompleteCallback
  2196. /** 接口调用失败的回调函数 */
  2197. fail?: GetSystemInfoAsyncFailCallback
  2198. /** 接口调用成功的回调函数 */
  2199. success?: GetSystemInfoAsyncSuccessCallback
  2200. }
  2201. interface GetSystemInfoOption {
  2202. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2203. complete?: GetSystemInfoCompleteCallback
  2204. /** 接口调用失败的回调函数 */
  2205. fail?: GetSystemInfoFailCallback
  2206. /** 接口调用成功的回调函数 */
  2207. success?: GetSystemInfoSuccessCallback
  2208. }
  2209. interface GetTextLineHeightOption {
  2210. /** 字体名称 */
  2211. fontFamily: string
  2212. /** 文本的内容 */
  2213. text: string
  2214. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2215. complete?: GetTextLineHeightCompleteCallback
  2216. /** 接口调用失败的回调函数 */
  2217. fail?: GetTextLineHeightFailCallback
  2218. /** 字号 */
  2219. fontSize?: number
  2220. /** 字体样式
  2221. *
  2222. * 可选值:
  2223. * - 'normal': 正常;
  2224. * - 'italic': 斜体; */
  2225. fontStyle?: 'normal' | 'italic'
  2226. /** 字重
  2227. *
  2228. * 可选值:
  2229. * - 'normal': 正常;
  2230. * - 'bold': 粗体; */
  2231. fontWeight?: 'normal' | 'bold'
  2232. /** 接口调用成功的回调函数 */
  2233. success?: GetTextLineHeightSuccessCallback
  2234. }
  2235. interface GetUserCloudStorageKeysOption {
  2236. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2237. complete?: GetUserCloudStorageKeysCompleteCallback
  2238. /** 接口调用失败的回调函数 */
  2239. fail?: GetUserCloudStorageKeysFailCallback
  2240. /** 接口调用成功的回调函数 */
  2241. success?: GetUserCloudStorageKeysSuccessCallback
  2242. }
  2243. interface GetUserCloudStorageKeysSuccessCallbackResult {
  2244. /** 用户托管数据当中所有的 key 数组 */
  2245. keys: string[]
  2246. errMsg: string
  2247. }
  2248. interface GetUserCloudStorageOption {
  2249. /** 要获取的 key 列表 */
  2250. keyList: string[]
  2251. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2252. complete?: GetUserCloudStorageCompleteCallback
  2253. /** 接口调用失败的回调函数 */
  2254. fail?: GetUserCloudStorageFailCallback
  2255. /** 接口调用成功的回调函数 */
  2256. success?: GetUserCloudStorageSuccessCallback
  2257. }
  2258. interface GetUserCloudStorageSuccessCallbackResult {
  2259. /** 用户托管的 KV 数据列表 */
  2260. KVDataList: KVData[]
  2261. errMsg: string
  2262. }
  2263. interface GetUserInfoOption {
  2264. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2265. complete?: GetUserInfoCompleteCallback
  2266. /** 接口调用失败的回调函数 */
  2267. fail?: GetUserInfoFailCallback
  2268. /** 显示用户信息的语言
  2269. *
  2270. * 可选值:
  2271. * - 'en': 英文;
  2272. * - 'zh_CN': 简体中文;
  2273. * - 'zh_TW': 繁体中文; */
  2274. lang?: 'en' | 'zh_CN' | 'zh_TW'
  2275. /** 接口调用成功的回调函数 */
  2276. success?: GetUserInfoSuccessCallback
  2277. /** 是否带上登录态信息。当 withCredentials 为 true 时,要求此前有调用过 wx.login 且登录态尚未过期,此时返回的数据会包含 encryptedData, iv 等敏感信息;当 withCredentials 为 false 时,不要求有登录态,返回的数据不包含 encryptedData, iv 等敏感信息。 */
  2278. withCredentials?: boolean
  2279. }
  2280. interface GetUserInfoSuccessCallbackResult {
  2281. /** 需要基础库: `2.7.0`
  2282. *
  2283. * 敏感数据对应的云 ID,开通[云开发](https://developers.weixin.qq.com/minigame/dev/wxcloud/basis/getting-started.html)的小程序才会返回,可通过云调用直接获取开放数据,详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#method-cloud) */
  2284. cloudID: string
  2285. /** 包括敏感数据在内的完整用户信息的加密数据,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
  2286. encryptedData: string
  2287. /** 加密算法的初始向量,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
  2288. iv: string
  2289. /** 不包括敏感信息的原始数据字符串,用于计算签名 */
  2290. rawData: string
  2291. /** 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  2292. signature: string
  2293. /** [UserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfo.html)
  2294. *
  2295. * 用户信息对象,不包含 openid 等敏感信息 */
  2296. userInfo: UserInfo
  2297. errMsg: string
  2298. }
  2299. interface GetUserInteractiveStorageFailCallbackResult {
  2300. /** 错误码
  2301. *
  2302. * 可选值:
  2303. * - -17008: 非法的 key; */
  2304. errCode: -17008
  2305. /** 错误信息 */
  2306. errMsg: string
  2307. }
  2308. interface GetUserInteractiveStorageOption {
  2309. /** 要获取的 key 列表 */
  2310. keyList: string
  2311. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2312. complete?: GetUserInteractiveStorageCompleteCallback
  2313. /** 接口调用失败的回调函数 */
  2314. fail?: GetUserInteractiveStorageFailCallback
  2315. /** 接口调用成功的回调函数 */
  2316. success?: GetUserInteractiveStorageSuccessCallback
  2317. }
  2318. interface GetUserInteractiveStorageSuccessCallbackResult {
  2319. /** 敏感数据对应的云 ID,开通[云开发](https://developers.weixin.qq.com/minigame/dev/wxcloud/basis/getting-started.html)的小程序才会返回,可通过云调用直接获取开放数据,详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#method-cloud) */
  2320. cloudID: string
  2321. /** 加密数据,包含互动型托管数据的值。解密后的结果为一个 `KVDataList`,每一项为一个 `KVData`。 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
  2322. encryptedData: string
  2323. errMsg: string
  2324. }
  2325. interface GetWeRunDataOption {
  2326. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2327. complete?: GetWeRunDataCompleteCallback
  2328. /** 接口调用失败的回调函数 */
  2329. fail?: GetWeRunDataFailCallback
  2330. /** 接口调用成功的回调函数 */
  2331. success?: GetWeRunDataSuccessCallback
  2332. }
  2333. interface GetWeRunDataSuccessCallbackResult {
  2334. /** 需要基础库: `2.7.0`
  2335. *
  2336. * 敏感数据对应的云 ID,开通云开发的小程序才会返回,可通过云调用直接获取开放数据,详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#method-cloud) */
  2337. cloudID: string
  2338. /** 包括敏感数据在内的完整用户信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html)。解密后得到的数据结构见后文 */
  2339. encryptedData: string
  2340. /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  2341. iv: string
  2342. errMsg: string
  2343. }
  2344. /** grid(格子) 广告组件。grid(格子) 广告组件是一个原生组件,层级比普通组件高。grid(格子) 广告组件默认是隐藏的,需要调用 GridAd.show() 将其显示。grid(格子) 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 GridAd.onResize() 事件中提供。 */
  2345. interface GridAd {
  2346. /** grid(格子) 广告广告组件的主题,提供 `white` `black` 两种主题选择。 */
  2347. adTheme: string
  2348. /** grid(格子) 广告组件的格子个数,可设置爱5,8两种格子个数样式,默认值为5 */
  2349. gridCount: number
  2350. /** grid(格子) 广告广告组件的样式。style 上的属性的值仅为开发者设置的grid(格子) 广告) 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 GridAd.onResize() 事件获得。 */
  2351. style: GridAdStyle
  2352. }
  2353. /** grid(格子) 广告广告组件的样式。style 上的属性的值仅为开发者设置的grid(格子) 广告) 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 GridAd.onResize() 事件获得。 */
  2354. interface GridAdStyle {
  2355. /** grid(格子) 广告组件的高度 */
  2356. height: number
  2357. /** grid(格子) 广告广告组件的左上角横坐标 */
  2358. left: number
  2359. /** grid(格子) 广告组件经过缩放后真实的高度 */
  2360. realHeight: number
  2361. /** grid(格子) 广告组件经过缩放后真实的宽度 */
  2362. realWidth: number
  2363. /** grid(格子) 广告组件的左上角纵坐标 */
  2364. top: number
  2365. /** grid(格子) 广告组件的宽度。最小 300,最大至 `屏幕宽度`(屏幕宽度可以通过 wx.getSystemInfoSync() 获取)。 */
  2366. width: number
  2367. }
  2368. interface HideKeyboardOption {
  2369. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2370. complete?: HideKeyboardCompleteCallback
  2371. /** 接口调用失败的回调函数 */
  2372. fail?: HideKeyboardFailCallback
  2373. /** 接口调用成功的回调函数 */
  2374. success?: HideKeyboardSuccessCallback
  2375. }
  2376. interface HideLoadingOption {
  2377. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2378. complete?: HideLoadingCompleteCallback
  2379. /** 接口调用失败的回调函数 */
  2380. fail?: HideLoadingFailCallback
  2381. /** 接口调用成功的回调函数 */
  2382. success?: HideLoadingSuccessCallback
  2383. }
  2384. interface HideShareMenuOption {
  2385. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2386. complete?: HideShareMenuCompleteCallback
  2387. /** 接口调用失败的回调函数 */
  2388. fail?: HideShareMenuFailCallback
  2389. /** 需要基础库: `2.11.3`
  2390. *
  2391. * 本接口为 Beta 版本,暂只在 Android 平台支持。需要隐藏的转发按钮名称列表,默认['shareAppMessage', 'shareTimeline']。按钮名称合法值包含 "shareAppMessage"、"shareTimeline" 两种 */
  2392. menus?: string[]
  2393. /** 接口调用成功的回调函数 */
  2394. success?: HideShareMenuSuccessCallback
  2395. }
  2396. interface HideToastOption {
  2397. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2398. complete?: HideToastCompleteCallback
  2399. /** 接口调用失败的回调函数 */
  2400. fail?: HideToastFailCallback
  2401. /** 接口调用成功的回调函数 */
  2402. success?: HideToastSuccessCallback
  2403. }
  2404. /** 需要基础库: `2.12.3`
  2405. *
  2406. * 当前小程序运行的宿主环境 */
  2407. interface Host {
  2408. /** 宿主 app 对应的 appId */
  2409. appId: string
  2410. }
  2411. /** 单个游戏icon的位置和样式等信息 */
  2412. interface IconItem {
  2413. /** 游戏名称是否隐藏 */
  2414. appNameHidden: boolean
  2415. /** 游戏icon的border颜色色值 */
  2416. borderColor: string
  2417. /** 游戏icon的border尺寸 */
  2418. borderWidth: number
  2419. /** 游戏名称的颜色色号 */
  2420. color: string
  2421. /** 游戏icon的X轴坐标 */
  2422. left: number
  2423. /** 游戏icon的宽高值 */
  2424. size: number
  2425. /** 游戏icon的Y轴坐标 */
  2426. top: number
  2427. }
  2428. /** 图片对象 */
  2429. interface Image {
  2430. /** 图片的真实高度 */
  2431. height: number
  2432. /** 图片加载发生错误后触发的回调函数 */
  2433. onerror: (...args: any[]) => any
  2434. /** 图片加载完成后触发的回调函数 */
  2435. onload: (...args: any[]) => any
  2436. /** 图片的 URL */
  2437. src: string
  2438. /** 图片的真实宽度 */
  2439. width: number
  2440. }
  2441. /** 需要基础库: `1.2.0`
  2442. *
  2443. * 图片的本地临时文件列表 */
  2444. interface ImageFile {
  2445. /** 本地临时文件路径 (本地路径) */
  2446. path: string
  2447. /** 本地临时文件大小,单位 B */
  2448. size: number
  2449. }
  2450. interface InitFaceDetectOption {
  2451. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2452. complete?: InitFaceDetectCompleteCallback
  2453. /** 接口调用失败的回调函数 */
  2454. fail?: InitFaceDetectFailCallback
  2455. /** 接口调用成功的回调函数 */
  2456. success?: InitFaceDetectSuccessCallback
  2457. }
  2458. /** InnerAudioContext 实例,可通过 [wx.createInnerAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createInnerAudioContext.html) 接口获取实例。注意,音频播放过程中,可能被系统中断,可通过 [wx.onAudioInterruptionBegin](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onAudioInterruptionBegin.html)、[wx.onAudioInterruptionEnd](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onAudioInterruptionEnd.html)事件来处理这种情况。
  2459. *
  2460. * **支持格式**
  2461. *
  2462. * | 格式 | iOS | Android |
  2463. * | ---- | ---- | ------- |
  2464. * | flac | x | √ |
  2465. * | m4a | √ | √ |
  2466. * | ogg | x | √ |
  2467. * | ape | x | √ |
  2468. * | amr | x | √ |
  2469. * | wma | x | √ |
  2470. * | wav | √ | √ |
  2471. * | mp3 | √ | √ |
  2472. * | mp4 | x | √ |
  2473. * | aac | √ | √ |
  2474. * | aiff | √ | x |
  2475. * | caf | √ | x |
  2476. *
  2477. * **示例代码**
  2478. *
  2479. * ```js
  2480. const innerAudioContext = wx.createInnerAudioContext()
  2481. innerAudioContext.autoplay = true
  2482. innerAudioContext.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'
  2483. innerAudioContext.onPlay(() => {
  2484. console.log('开始播放')
  2485. })
  2486. innerAudioContext.onError((res) => {
  2487. console.log(res.errMsg)
  2488. console.log(res.errCode)
  2489. })
  2490. ``` */
  2491. interface InnerAudioContext {
  2492. /** 是否自动开始播放,默认为 `false` */
  2493. autoplay: boolean
  2494. /** 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲(只读) */
  2495. buffered: number
  2496. /** 当前音频的播放位置(单位 s)。只有在当前有合法的 src 时返回,时间保留小数点后 6 位(只读) */
  2497. currentTime: number
  2498. /** 当前音频的长度(单位 s)。只有在当前有合法的 src 时返回(只读) */
  2499. duration: number
  2500. /** 是否循环播放,默认为 `false` */
  2501. loop: boolean
  2502. /** 是否遵循系统静音开关,默认为 `true`。当此参数为 `false` 时,即使用户打开了静音开关,也能继续发出声音。从 2.3.0 版本开始此参数不生效,使用 [wx.setInnerAudioOption](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.setInnerAudioOption.html) 接口统一设置。 */
  2503. obeyMuteSwitch: boolean
  2504. /** 当前是是否暂停或停止状态(只读) */
  2505. paused: boolean
  2506. /** 需要基础库: `2.11.0`
  2507. *
  2508. * 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) */
  2509. playbackRate: number
  2510. /** 需要基础库: `2.13.0`
  2511. *
  2512. * `origin`: 发送完整的referrer; `no-referrer`: 不发送。格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本; */
  2513. referrerPolicy: string
  2514. /** 音频资源的地址,用于直接播放。[2.2.3](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 开始支持云文件ID */
  2515. src: string
  2516. /** 开始播放的位置(单位:s),默认为 0 */
  2517. startTime: number
  2518. /** 需要基础库: `1.9.90`
  2519. *
  2520. * 音量。范围 0~1。默认为 1 */
  2521. volume: number
  2522. }
  2523. interface InnerAudioContextOnErrorCallbackResult {
  2524. /** 可选值:
  2525. * - 10001: 系统错误;
  2526. * - 10002: 网络错误;
  2527. * - 10003: 文件错误;
  2528. * - 10004: 格式错误;
  2529. * - -1: 未知错误; */
  2530. errCode: 10001 | 10002 | 10003 | 10004 | -1
  2531. errMsg: string
  2532. }
  2533. interface InterstitialAdOnErrorCallbackResult {
  2534. /** 错误码
  2535. *
  2536. * 可选值:
  2537. * - 1000: 后端接口调用失败;
  2538. * - 1001: 参数错误;
  2539. * - 1002: 广告单元无效;
  2540. * - 1003: 内部错误;
  2541. * - 1004: 无合适的广告;
  2542. * - 1005: 广告组件审核中;
  2543. * - 1006: 广告组件被驳回;
  2544. * - 1007: 广告组件被封禁;
  2545. * - 1008: 广告单元已关闭; */
  2546. errCode: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008
  2547. /** 错误信息 */
  2548. errMsg: string
  2549. }
  2550. interface InviteFriendOption {
  2551. /** 被邀请玩家的 openId */
  2552. openId: string
  2553. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2554. complete?: InviteFriendCompleteCallback
  2555. /** 接口调用失败的回调函数 */
  2556. fail?: InviteFriendFailCallback
  2557. /** 接口调用成功的回调函数 */
  2558. success?: InviteFriendSuccessCallback
  2559. }
  2560. interface IsBluetoothDevicePairedOption {
  2561. /** 蓝牙设备 id */
  2562. deviceId: string
  2563. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2564. complete?: IsBluetoothDevicePairedCompleteCallback
  2565. /** 接口调用失败的回调函数 */
  2566. fail?: IsBluetoothDevicePairedFailCallback
  2567. /** 接口调用成功的回调函数 */
  2568. success?: IsBluetoothDevicePairedSuccessCallback
  2569. }
  2570. interface JoinRoomOption {
  2571. /** 游戏房间访问凭证 */
  2572. accessInfo: string
  2573. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2574. complete?: JoinRoomCompleteCallback
  2575. /** 接口调用失败的回调函数 */
  2576. fail?: JoinRoomFailCallback
  2577. /** 游戏自定义的关于个人的扩展信息,其他人可在 `MemberInfo` 中读取到,最多 32 个字节 */
  2578. memberExtInfo?: string
  2579. /** 接口调用成功的回调函数 */
  2580. success?: JoinRoomSuccessCallback
  2581. }
  2582. interface JoinRoomSuccessCallbackDataResult {
  2583. /** 用户在房间内的唯一标识 */
  2584. clientId: number
  2585. /** 加入房间后被分配的座位号 */
  2586. myPos: number
  2587. }
  2588. interface JoinRoomSuccessCallbackResult {
  2589. data: JoinRoomSuccessCallbackDataResult
  2590. errMsg: string
  2591. }
  2592. interface JoinVoIPChatOption {
  2593. /** 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 */
  2594. groupId: string
  2595. /** 验证所需的随机字符串 */
  2596. nonceStr: string
  2597. /** 签名,用于验证小游戏的身份 */
  2598. signature: string
  2599. /** 验证所需的时间戳 */
  2600. timeStamp: number
  2601. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2602. complete?: JoinVoIPChatCompleteCallback
  2603. /** 接口调用失败的回调函数 */
  2604. fail?: JoinVoIPChatFailCallback
  2605. /** 静音设置 */
  2606. muteConfig?: MuteConfig
  2607. /** 房间类型
  2608. *
  2609. * 可选值:
  2610. * - 'voice': 音频房间,用于语音通话;
  2611. * - 'video': 视频房间,结合 [voip-room](#) 组件可显示成员画面; */
  2612. roomType?: 'voice' | 'video'
  2613. /** 接口调用成功的回调函数 */
  2614. success?: JoinVoIPChatSuccessCallback
  2615. }
  2616. interface JoinVoIPChatSuccessCallbackResult {
  2617. /** 错误码 */
  2618. errCode: number
  2619. /** 调用结果 */
  2620. errMsg: string
  2621. /** 在此通话中的成员 openId 名单 */
  2622. openIdList: string[]
  2623. }
  2624. /** 托管的 KV 数据
  2625. *
  2626. * **将排行榜显示在小游戏中心**
  2627. *
  2628. * 若开发者希望把游戏的排行榜显示于小游戏中心,则需要把排行榜数据存储到对应的key/value中,一个排行榜数据对应一个key,多个排行榜则多个key。同时在mp.weixin.qq.com的小游戏管理后台“设置-游戏-排行榜设置”下配置对应的key以及相关排行榜属性。且value的内容必须是JSON Object格式序列化的字符串,该JSON Object顶层必须包含 `wxgame` 字段,定义如下:
  2629. *
  2630. * | 属性名 | 类型 | 必填 | 说明 |
  2631. * |-------------|--------|------|----------------------------------|
  2632. * | score | Int32 | 是 | 该榜单对应分数值 |
  2633. * | update_time | Int64 | 是 | 该分数最后更新时间,Unix时间戳 |
  2634. *
  2635. * 注意: `wxgame`下开发者不可自定义其他字段, `wxgame`同级开发者可自由定义,比如定义一个`detail` 字段,用于存储取得该分数的中间状态。
  2636. *
  2637. * ### 举例
  2638. *
  2639. * 比如某小游戏有一个分数排行榜,分数排行榜需要记录分数以及获得分数的耗时(游戏内的排行榜需要展示耗时),可以在`wxgame`同级别定义一个`cost_ms`字段,存储耗时的毫秒数。
  2640. * 分配一个不和已定义的托管数据的key相冲突的key作为分数排行榜的key,如 "score"。
  2641. *
  2642. * 在玩家耗时36500ms后,获得本周最高分16分,则需要更新分数,假设当前时间戳为1513080573, 则完整 value在序列化之前的内容如下:
  2643. * ```json
  2644. {
  2645. "wxgame": {
  2646. "score":16,
  2647. "update_time": 1513080573
  2648. },
  2649. "cost_ms":36500
  2650. }
  2651. ```
  2652. *
  2653. * 最终序列化为string后,value为`{\"wxgame\":{\"score\":16,\"update_time\": 1513080573},\"cost_ms\":36500}`。 */
  2654. interface KVData {
  2655. /** 数据的 key */
  2656. key: string
  2657. /** 数据的 value */
  2658. value: string
  2659. }
  2660. interface KickoutMemberOption {
  2661. /** 欲踢除的玩家的座位号 */
  2662. kickoutPos: number
  2663. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2664. complete?: KickoutMemberCompleteCallback
  2665. /** 接口调用失败的回调函数 */
  2666. fail?: KickoutMemberFailCallback
  2667. /** 接口调用成功的回调函数 */
  2668. success?: KickoutMemberSuccessCallback
  2669. }
  2670. /** 启动参数 */
  2671. interface LaunchOptionsGame {
  2672. /** 启动小游戏的 query 参数 */
  2673. query: IAnyObject
  2674. /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
  2675. referrerInfo: EnterOptionsGameReferrerInfo
  2676. /** 启动小游戏的[场景值](https://developers.weixin.qq.com/minigame/dev/devtools/interface/scene.html) */
  2677. scene: number
  2678. /** 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
  2679. *
  2680. * 可选值:
  2681. * - 1: 微信联系人单聊;
  2682. * - 2: 企业微信联系人单聊;
  2683. * - 3: 普通微信群聊;
  2684. * - 4: 企业微信互通群聊; */
  2685. chatType?: 1 | 2 | 3 | 4
  2686. /** shareTicket,详见[获取更多转发信息](#) */
  2687. shareTicket?: string
  2688. }
  2689. interface LoadSubpackageOption {
  2690. /** 分包加载结束回调事件(加载成功、失败都会执行) */
  2691. complete: (...args: any[]) => any
  2692. /** 分包加载失败回调事件 */
  2693. fail: (...args: any[]) => any
  2694. /** 分包的名字,可以填 name 或者 root。在独立分包内,填 \_\_GAME\_\_ 表示加载主包,详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
  2695. name: string
  2696. /** 分包加载成功回调事件 */
  2697. success: (...args: any[]) => any
  2698. }
  2699. interface LoadSubpackageTaskOnProgressUpdateCallbackResult {
  2700. /** 分包下载进度百分比 */
  2701. progress: number
  2702. /** 预期需要下载的数据总长度,单位 Bytes */
  2703. totalBytesExpectedToWrite: number
  2704. /** 已经下载的数据长度,单位 Bytes */
  2705. totalBytesWritten: number
  2706. }
  2707. /** 接收端地址信息,2.18.0 起支持 */
  2708. interface LocalInfo {
  2709. /** 接收消息的 socket 的地址 */
  2710. address: string
  2711. /** 使用的协议族,为 IPv4 或者 IPv6 */
  2712. family: string
  2713. /** 端口号 */
  2714. port: number
  2715. }
  2716. interface LoginOption {
  2717. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2718. complete?: LoginCompleteCallback
  2719. /** 接口调用失败的回调函数 */
  2720. fail?: LoginFailCallback
  2721. /** 接口调用成功的回调函数 */
  2722. success?: LoginSuccessCallback
  2723. /** 需要基础库: `1.9.90`
  2724. *
  2725. * 超时时间,单位ms */
  2726. timeout?: number
  2727. }
  2728. interface LoginSuccessCallbackResult {
  2729. /** 用户登录凭证(有效期五分钟)。开发者需要在开发者服务器后台调用 [auth.code2Session](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/login/auth.code2Session.html),使用 code 换取 openid、unionid、session_key 等信息 */
  2730. code: string
  2731. errMsg: string
  2732. }
  2733. interface MakeBluetoothPairOption {
  2734. /** 蓝牙设备 id */
  2735. deviceId: string
  2736. /** pin 码,Base64 格式。 */
  2737. pin: string
  2738. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2739. complete?: MakeBluetoothPairCompleteCallback
  2740. /** 接口调用失败的回调函数 */
  2741. fail?: MakeBluetoothPairFailCallback
  2742. /** 接口调用成功的回调函数 */
  2743. success?: MakeBluetoothPairSuccessCallback
  2744. /** 超时时间,单位 ms */
  2745. timeout?: number
  2746. }
  2747. /** 广播的制造商信息。仅安卓支持,iOS 因系统限制无法定制。 */
  2748. interface ManufacturerData {
  2749. /** 制造商ID,0x 开头的十六进制 */
  2750. manufacturerId: string
  2751. /** 制造商信息 */
  2752. manufacturerSpecificData?: ArrayBuffer
  2753. }
  2754. /** 匹配到的队伍信息 */
  2755. interface MatchGroupInfo {
  2756. /** 队伍的序号 */
  2757. groupIndex: number
  2758. /** 队伍中成员信息 */
  2759. memberInfoList: MatchMemberInfo[]
  2760. }
  2761. /** 队伍中成员信息 */
  2762. interface MatchMemberInfo {
  2763. /** 队伍中成员的头像 */
  2764. avatarUrl: string
  2765. /** 成员的序号 */
  2766. memberIndex: number
  2767. /** 队伍中成员的昵称 */
  2768. nickName: string
  2769. /** 队伍中成员的openid */
  2770. openId: string
  2771. }
  2772. /** MediaAudioPlayer 实例,可通过 [wx.createMediaAudioPlayer](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createMediaAudioPlayer.html) 接口获取实例。 */
  2773. interface MediaAudioPlayer {
  2774. /** 音量。范围 0~1。默认为 1 */
  2775. volume: number
  2776. }
  2777. /** 需要预览的资源列表 */
  2778. interface MediaSource {
  2779. /** 图片或视频的地址 */
  2780. url: string
  2781. /** 视频的封面图片 */
  2782. poster?: string
  2783. /** 资源的类型,默认为图片
  2784. *
  2785. * 可选值:
  2786. * - 'image': 图片;
  2787. * - 'video': 视频; */
  2788. type?: 'image' | 'video'
  2789. }
  2790. interface MemberLeaveRoomOption {
  2791. /** 游戏房间访问凭证 */
  2792. accessInfo: string
  2793. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2794. complete?: MemberLeaveRoomCompleteCallback
  2795. /** 接口调用失败的回调函数 */
  2796. fail?: MemberLeaveRoomFailCallback
  2797. /** 接口调用成功的回调函数 */
  2798. success?: MemberLeaveRoomSuccessCallback
  2799. }
  2800. /** 小程序帐号信息 */
  2801. interface MiniProgram {
  2802. /** 小程序 appId */
  2803. appId: string
  2804. /** 需要基础库: `2.10.0`
  2805. *
  2806. * 小程序版本
  2807. *
  2808. * 可选值:
  2809. * - 'develop': 开发版;
  2810. * - 'trial': 体验版;
  2811. * - 'release': 正式版; */
  2812. envVersion: 'develop' | 'trial' | 'release'
  2813. /** 需要基础库: `2.10.2`
  2814. *
  2815. * 线上小程序版本号 */
  2816. version: string
  2817. }
  2818. interface MkdirFailCallbackResult {
  2819. /** 错误信息
  2820. *
  2821. * 可选值:
  2822. * - 'fail no such file or directory ${dirPath}': 上级目录不存在(该错误仅在 recursive = false 时生效);
  2823. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
  2824. * - 'fail file already exists ${dirPath}': 有同名文件或目录(该错误仅在 recursive = false 时生效);
  2825. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  2826. errMsg: string
  2827. }
  2828. interface MkdirOption {
  2829. /** 创建的目录路径 (本地路径) */
  2830. dirPath: string
  2831. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2832. complete?: MkdirCompleteCallback
  2833. /** 接口调用失败的回调函数 */
  2834. fail?: MkdirFailCallback
  2835. /** 需要基础库: `2.3.0`
  2836. *
  2837. * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 */
  2838. recursive?: boolean
  2839. /** 接口调用成功的回调函数 */
  2840. success?: MkdirSuccessCallback
  2841. }
  2842. interface ModifyFriendInteractiveStorageFailCallbackResult {
  2843. /** 错误码
  2844. *
  2845. * 可选值:
  2846. * - -17006: 非好友关系;
  2847. * - -17007: 非法的 toUser openId;
  2848. * - -17008: 非法的 key;
  2849. * - -17009: 非法的 operation;
  2850. * - -17010: 非法的操作数;
  2851. * - -17011: JSServer 校验写操作失败; */
  2852. errCode: -17006 | -17007 | -17008 | -17009 | -17010 | -17011
  2853. /** 错误信息 */
  2854. errMsg: string
  2855. }
  2856. interface ModifyFriendInteractiveStorageOption {
  2857. /** 需要修改的数据的 key,目前可以为 '1' - '50' */
  2858. key: string
  2859. /** 需要修改的数值,目前只能为 1 */
  2860. opNum: number
  2861. /** 修改类型
  2862. *
  2863. * 可选值:
  2864. * - 'add': 加; */
  2865. operation: 'add'
  2866. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2867. complete?: ModifyFriendInteractiveStorageCompleteCallback
  2868. /** 接口调用失败的回调函数 */
  2869. fail?: ModifyFriendInteractiveStorageFailCallback
  2870. /** 需要基础库: `2.9.0`
  2871. *
  2872. * 分享图片地址,详见 wx.shareMessageToFriend 同名参数(需要配置模板规则) */
  2873. imageUrl?: string
  2874. /** 需要基础库: `2.9.0`
  2875. *
  2876. * 分享图片 ID,详见 wx.shareMessageToFriend 同名参数(需要配置模板规则) */
  2877. imageUrlId?: string
  2878. /** 需要基础库: `2.9.0`
  2879. *
  2880. * 是否静默修改(不弹框)。当进入场景是好友 [定向分享](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.shareMessageToFriend.html) 的卡片时有效,代表分享反馈操作,此时 `toUser` 默认为原分享者的 openId */
  2881. quiet?: boolean
  2882. /** 接口调用成功的回调函数 */
  2883. success?: ModifyFriendInteractiveStorageSuccessCallback
  2884. /** 需要基础库: `2.9.0`
  2885. *
  2886. * 分享标题,如果设置了这个值,则在交互成功后自动询问用户是否分享给好友(需要配置模板规则) */
  2887. title?: string
  2888. /** 目标好友的 openId */
  2889. toUser?: string
  2890. }
  2891. /** 静音设置 */
  2892. interface MuteConfig {
  2893. /** 是否静音耳机 */
  2894. muteEarphone?: boolean
  2895. /** 是否静音麦克风 */
  2896. muteMicrophone?: boolean
  2897. }
  2898. interface NavigateToMiniProgramOption {
  2899. /** 要打开的小程序 appId */
  2900. appId: string
  2901. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2902. complete?: NavigateToMiniProgramCompleteCallback
  2903. /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版,则打开的小程序必定是正式版。
  2904. *
  2905. * 可选值:
  2906. * - 'develop': 开发版;
  2907. * - 'trial': 体验版;
  2908. * - 'release': 正式版; */
  2909. envVersion?: 'develop' | 'trial' | 'release'
  2910. /** 需要传递给目标小程序的数据,目标小程序可在 `App.onLaunch`,`App.onShow` 中获取到这份数据。如果跳转的是小游戏,可以在 [wx.onShow](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onShow.html)、[wx.getLaunchOptionsSync](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html) 中可以获取到这份数据数据。 */
  2911. extraData?: IAnyObject
  2912. /** 接口调用失败的回调函数 */
  2913. fail?: NavigateToMiniProgramFailCallback
  2914. /** 打开的页面路径,如果为空则打开首页。path 中 ? 后面的部分会成为 query,在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数或小游戏的 [wx.onShow](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onShow.html) 回调函数、[wx.getLaunchOptionsSync](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html) 中可以获取到 query 数据。对于小游戏,可以只传入 query 部分,来实现传参效果,如:传入 "?foo=bar"。 */
  2915. path?: string
  2916. /** 需要基础库: `2.18.1`
  2917. *
  2918. * 小程序链接,当传递该参数后,可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 */
  2919. shortLink?: string
  2920. /** 接口调用成功的回调函数 */
  2921. success?: NavigateToMiniProgramSuccessCallback
  2922. }
  2923. interface NotifyBLECharacteristicValueChangeOption {
  2924. /** 蓝牙特征的 UUID */
  2925. characteristicId: string
  2926. /** 蓝牙设备 id */
  2927. deviceId: string
  2928. /** 蓝牙特征对应服务的 UUID */
  2929. serviceId: string
  2930. /** 是否启用 notify */
  2931. state: boolean
  2932. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  2933. complete?: NotifyBLECharacteristicValueChangeCompleteCallback
  2934. /** 接口调用失败的回调函数 */
  2935. fail?: NotifyBLECharacteristicValueChangeFailCallback
  2936. /** 接口调用成功的回调函数 */
  2937. success?: NotifyBLECharacteristicValueChangeSuccessCallback
  2938. /** 需要基础库: `2.4.0`
  2939. *
  2940. * 设置特征订阅类型,有效值有 `notification` 和 `indication` */
  2941. type?: string
  2942. }
  2943. interface OnAccelerometerChangeCallbackResult {
  2944. /** X 轴 */
  2945. x: number
  2946. /** Y 轴 */
  2947. y: number
  2948. /** Z 轴 */
  2949. z: number
  2950. }
  2951. interface OnAddToFavoritesCallbackResult {
  2952. /** 禁止收藏后长按转发,默认 false */
  2953. disableForward: boolean
  2954. /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
  2955. imageUrl: string
  2956. /** 查询字符串,必须是 key1=val1&key2=val2 的格式。从收藏进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。 */
  2957. query: string
  2958. /** 收藏标题,不传则默认使用当前小游戏的昵称。 */
  2959. title: string
  2960. }
  2961. interface OnBLECharacteristicValueChangeCallbackResult {
  2962. /** 蓝牙特征的 UUID */
  2963. characteristicId: string
  2964. /** 蓝牙设备 id */
  2965. deviceId: string
  2966. /** 蓝牙特征对应服务的 UUID */
  2967. serviceId: string
  2968. /** 特征最新的值 */
  2969. value: ArrayBuffer
  2970. }
  2971. interface OnBLEConnectionStateChangeCallbackResult {
  2972. /** 是否处于已连接状态 */
  2973. connected: boolean
  2974. /** 蓝牙设备 id */
  2975. deviceId: string
  2976. }
  2977. interface OnBLEMTUChangeCallbackResult {
  2978. /** 蓝牙设备 id */
  2979. deviceId: string
  2980. /** 最大传输单元 */
  2981. mtu: number
  2982. }
  2983. interface OnBLEPeripheralConnectionStateChangedCallbackResult {
  2984. /** 连接目前状态 */
  2985. connected: boolean
  2986. /** 连接状态变化的设备 id */
  2987. deviceId: string
  2988. /** server 的 UUID */
  2989. serverId: string
  2990. }
  2991. interface OnBeKickedOutCallbackResult {
  2992. res: IAnyObject
  2993. }
  2994. interface OnBeaconServiceChangeCallbackResult {
  2995. /** 服务目前是否可用 */
  2996. available: boolean
  2997. /** 目前是否处于搜索状态 */
  2998. discovering: boolean
  2999. }
  3000. interface OnBeaconUpdateCallbackResult {
  3001. /** 当前搜寻到的所有 Beacon 设备列表 */
  3002. beacons: BeaconInfo[]
  3003. }
  3004. interface OnBluetoothAdapterStateChangeCallbackResult {
  3005. /** 蓝牙适配器是否可用 */
  3006. available: boolean
  3007. /** 蓝牙适配器是否处于搜索状态 */
  3008. discovering: boolean
  3009. }
  3010. interface OnBluetoothDeviceFoundCallbackResult {
  3011. /** 新搜索到的设备列表 */
  3012. devices: BlueToothDevice[]
  3013. }
  3014. interface OnBroadcastCallbackResult {
  3015. /** 广播消息 */
  3016. msg: string
  3017. }
  3018. interface OnCameraFrameCallbackResult {
  3019. /** 图像像素点数据,一维数组,每四项表示一个像素点的 rgba */
  3020. data: ArrayBuffer
  3021. /** 图像数据矩形的高度 */
  3022. height: number
  3023. /** 图像数据矩形的宽度 */
  3024. width: number
  3025. }
  3026. interface OnCharacteristicReadRequestCallbackResult {
  3027. /** 唯一标识码,调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 时使用 */
  3028. callbackId: number
  3029. /** 蓝牙特征的 UUID */
  3030. characteristicId: string
  3031. /** 蓝牙特征对应服务的 UUID */
  3032. serviceId: string
  3033. }
  3034. interface OnCharacteristicSubscribedCallbackResult {
  3035. /** 蓝牙特征的 UUID */
  3036. characteristicId: string
  3037. /** 蓝牙特征对应服务的 UUID */
  3038. serviceId: string
  3039. }
  3040. interface OnCharacteristicWriteRequestCallbackResult {
  3041. /** 唯一标识码,调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 时使用 */
  3042. callbackId: number
  3043. /** 蓝牙特征的 UUID */
  3044. characteristicId: string
  3045. /** 蓝牙特征对应服务的 UUID */
  3046. serviceId: string
  3047. /** 请求写入特征的二进制数据值 */
  3048. value: ArrayBuffer
  3049. }
  3050. interface OnCheckForUpdateCallbackResult {
  3051. /** 是否有新版本 */
  3052. hasUpdate: boolean
  3053. }
  3054. /** 开发者服务器每次返回新chunk时的Response */
  3055. interface OnChunkReceivedCallbackResult {
  3056. /** 返回的chunk buffer */
  3057. data: ArrayBuffer
  3058. }
  3059. interface OnCompassChangeCallbackResult {
  3060. /** 需要基础库: `2.4.0`
  3061. *
  3062. * 精度 */
  3063. accuracy: number | string
  3064. /** 面对的方向度数 */
  3065. direction: number
  3066. }
  3067. interface OnCopyUrlCallbackResult {
  3068. /** 用短链打开小程序时当前页面携带的查询字符串。小程序中使用时,应在进入页面时调用 `wx.onCopyUrl` 自定义 `query`,退出页面时调用 `wx.offCopyUrl`,防止影响其它页面。 */
  3069. query: string
  3070. }
  3071. interface OnDeviceMotionChangeCallbackResult {
  3072. /** 当 手机坐标 X/Y 和 地球 X/Y 重合时,绕着 Z 轴转动的夹角为 alpha,范围值为 [0, 2*PI)。逆时针转动为正。 */
  3073. alpha: number
  3074. /** 当手机坐标 Y/Z 和地球 Y/Z 重合时,绕着 X 轴转动的夹角为 beta。范围值为 [-1*PI, PI) 。顶部朝着地球表面转动为正。也有可能朝着用户为正。 */
  3075. beta: number
  3076. /** 当手机 X/Z 和地球 X/Z 重合时,绕着 Y 轴转动的夹角为 gamma。范围值为 [-1*PI/2, PI/2)。右边朝着地球表面转动为正。 */
  3077. gamma: number
  3078. }
  3079. interface OnDeviceOrientationChangeCallbackResult {
  3080. /** 表示切换后的屏幕是横屏还是竖屏
  3081. *
  3082. * 可选值:
  3083. * - 'portrait': 竖屏;
  3084. * - 'landscape': 横屏正方向,以 HOME 键在屏幕右侧为正方向;
  3085. * - 'landscapeReverse': 横屏反方向,以 HOME 键在屏幕左侧为反方向; */
  3086. value: 'portrait' | 'landscape' | 'landscapeReverse'
  3087. }
  3088. interface OnDisconnectCallbackResult {
  3089. /** 可选值:
  3090. * - 'room': 房间服务断开连接,只有在进入房间后有机会收到。房间服务断开连接后,将无法进行房间相关的操作,以及无法收到房间信息变化事件。;
  3091. * - 'game': 游戏服务断开连接,只有在游戏开始后有机会收到。游戏服务断开连接后,将无法收发帧。; */
  3092. type: 'room' | 'game'
  3093. }
  3094. interface OnFrameRecordedCallbackResult {
  3095. /** 录音分片数据 */
  3096. frameBuffer: ArrayBuffer
  3097. /** 当前帧是否正常录音结束前的最后一帧 */
  3098. isLastFrame: boolean
  3099. }
  3100. interface OnGameEndCallbackResult {
  3101. /** 游戏唯一标识,用于后台接口拉取对局记录 */
  3102. gameAccessInfo: string
  3103. }
  3104. interface OnGyroscopeChangeCallbackResult {
  3105. /** x 轴的角速度 */
  3106. x: number
  3107. /** y 轴的角速度 */
  3108. y: number
  3109. /** z 轴的角速度 */
  3110. z: number
  3111. }
  3112. interface OnHandoffCallbackResult {
  3113. /** 需要传递给接力客户端的 query */
  3114. query: string
  3115. }
  3116. interface OnHeadersReceivedCallbackResult {
  3117. /** 开发者服务器返回的 HTTP Response Header */
  3118. header: IAnyObject
  3119. }
  3120. interface OnInviteCallbackResult {
  3121. /** 邀请者附带的额外信息 */
  3122. data: string
  3123. /** 邀请者的 openId */
  3124. openId: string
  3125. res: IAnyObject
  3126. }
  3127. interface OnKeyDownCallbackResult {
  3128. /** 同 Web 规范 KeyEvent code 属性 */
  3129. code: string
  3130. /** 同 Web 规范 KeyEvent key 属性 */
  3131. key: string
  3132. /** 事件触发时的时间戳 */
  3133. timeStamp: number
  3134. }
  3135. interface OnKeyboardHeightChangeCallbackResult {
  3136. /** 键盘高度 */
  3137. height: number
  3138. }
  3139. interface OnKeyboardInputCallbackResult {
  3140. /** 键盘输入的当前值 */
  3141. value: string
  3142. }
  3143. interface OnLockStepErrorCallbackResult {
  3144. /** 错误码 */
  3145. errCode: number
  3146. /** 错误原因 */
  3147. errMsg: string
  3148. }
  3149. interface OnMatchCallbackResult {
  3150. /** 匹配到的队伍信息 */
  3151. groupInfoList: MatchGroupInfo[]
  3152. /** 与 startMatch 一致的 matchId */
  3153. matchId: string
  3154. /** 自己的 openId */
  3155. openId: string
  3156. /** 唯一的本次对局id */
  3157. raceId: string
  3158. /** 房间服务的accessinfo,如果matchid中指定需要匹配完成时创建房间服务,则会携带下来,后续调用房间服务相关接口加入房间即可 */
  3159. roomServiceAccessInfo: string
  3160. }
  3161. interface OnMemoryWarningCallbackResult {
  3162. /** 内存告警等级,只有 Android 才有,对应系统宏定义
  3163. *
  3164. * 可选值:
  3165. * - 5: TRIM_MEMORY_RUNNING_MODERATE;
  3166. * - 10: TRIM_MEMORY_RUNNING_LOW;
  3167. * - 15: TRIM_MEMORY_RUNNING_CRITICAL; */
  3168. level: 5 | 10 | 15
  3169. }
  3170. interface OnMouseDownCallbackResult {
  3171. /** 按键类型,0左键,1中键,2右键 */
  3172. button: number
  3173. /** 事件触发时的时间戳 */
  3174. timeStamp: number
  3175. /** 事件触发时鼠标所在的位置横坐标 */
  3176. x: number
  3177. /** 事件触发时鼠标所在的位置纵坐标 */
  3178. y: number
  3179. }
  3180. interface OnMouseMoveCallbackResult {
  3181. /** 鼠标横坐标偏移量 */
  3182. movementX: number
  3183. /** 鼠标纵坐标偏移量 */
  3184. movementY: number
  3185. /** 事件触发时的时间戳 */
  3186. timeStamp: number
  3187. /** 事件触发时鼠标所在的位置横坐标 */
  3188. x: number
  3189. /** 事件触发时鼠标所在的位置纵坐标 */
  3190. y: number
  3191. }
  3192. interface OnNetworkStatusChangeCallbackResult {
  3193. /** 当前是否有网络连接 */
  3194. isConnected: boolean
  3195. /** 网络类型
  3196. *
  3197. * 可选值:
  3198. * - 'wifi': wifi 网络;
  3199. * - '2g': 2g 网络;
  3200. * - '3g': 3g 网络;
  3201. * - '4g': 4g 网络;
  3202. * - 'unknown': Android 下不常见的网络类型;
  3203. * - 'none': 无网络; */
  3204. networkType: 'wifi' | '2g' | '3g' | '4g' | 'unknown' | 'none'
  3205. }
  3206. interface OnNetworkWeakChangeCallbackResult {
  3207. /** 当前网络类型 */
  3208. networkType: string
  3209. /** 当前是否处于弱网状态 */
  3210. weakNet: boolean
  3211. }
  3212. interface OnOpenCallbackResult {
  3213. /** 需要基础库: `2.0.0`
  3214. *
  3215. * 连接成功的 HTTP 响应 Header */
  3216. header: IAnyObject
  3217. /** 需要基础库: `2.10.4`
  3218. *
  3219. * 网络请求过程中一些调试信息 */
  3220. profile: SocketProfile
  3221. }
  3222. interface OnProgressCallbackResult {
  3223. /** 当前的缓冲进度,缓冲进度区间为 (0~100],100表示缓冲完成 */
  3224. buffered: number
  3225. /** 视频的总时长,单位为秒 */
  3226. duration: number
  3227. }
  3228. interface OnResizeCallbackResult {
  3229. /** 缩放后的高度 */
  3230. height: number
  3231. /** 缩放后的宽度 */
  3232. width: number
  3233. }
  3234. interface OnRoomInfoChangeCallbackResult {
  3235. /** 小游戏 appId */
  3236. appId: string
  3237. /** 创建时间 */
  3238. createTimestamp: number
  3239. /** 游戏对局时长,单位 s */
  3240. gameLastTime: number
  3241. /** 游戏下发帧的时间间隔,单位 ms */
  3242. gameTick: number
  3243. /** 房间最多可容纳人数 */
  3244. maxMemberNum: number
  3245. /** 成员列表 */
  3246. memberList: RoomMemberInfo[]
  3247. /** 游戏自定义的关于房间的扩展信息 */
  3248. roomExtInfo: string
  3249. /** 房间 ID */
  3250. roomIdStr: number
  3251. /** 房间状态
  3252. *
  3253. * 可选值:
  3254. * - 1: 组队中;
  3255. * - 2: 该房间的对局游戏已开始;
  3256. * - 3: 该房间的对局游戏已结束;
  3257. * - 4: 房间已销毁;
  3258. * - 5: 房间连接已建立,等待对战连接建立; */
  3259. roomState: 1 | 2 | 3 | 4 | 5
  3260. /** 游戏随机种子 */
  3261. seed: string
  3262. /** 需要满足百分比的玩家都发送了开始指令才能启动游戏。有效范围 0~100,0 表示只要有一个人调用开始就启动,100 表示要求所有人都开始才能启动。 */
  3263. startPercent: number
  3264. /** UDP可靠性策略, 0:全冗余 N:固定冗余N帧 */
  3265. udpReliabilityStrategy: number
  3266. /** 最近更新时间 */
  3267. updateTimestamp: number
  3268. }
  3269. interface OnShareAppMessageCallbackResult {
  3270. /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
  3271. imageUrl: string
  3272. /** 查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。 */
  3273. query: string
  3274. /** 转发标题,不传则默认使用当前小游戏的昵称。 */
  3275. title: string
  3276. /** 需要基础库: `2.4.3`
  3277. *
  3278. * 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
  3279. imageUrlId?: string
  3280. /** 需要基础库: `2.12.2`
  3281. *
  3282. * 独立分包路径。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
  3283. path?: string
  3284. /** 需要基础库: `2.12.0`
  3285. *
  3286. * 如果该参数存在,则其它的参数将会以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数 */
  3287. promise?: Promise<any>
  3288. /** 需要基础库: `2.12.2`
  3289. *
  3290. * 是否转发到当前群。该参数只对从群工具栏打开的场景下生效,默认转发到当前群,填入false时可转发到其他会话。 */
  3291. toCurrentGroup?: boolean
  3292. }
  3293. interface OnShareMessageToFriendCallbackResult {
  3294. /** 错误信息 */
  3295. errMsg: string
  3296. /** 是否成功 */
  3297. success: boolean
  3298. }
  3299. interface OnShareTimelineCallbackResult {
  3300. /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。(该图片用于分享到朋友圈的卡片以及从朋友圈转发到会话消息的卡片展示) */
  3301. imageUrl: string
  3302. /** 需要基础库: `2.14.3`
  3303. *
  3304. * 朋友圈预览图链接,不传则默认使用当前游戏画面截图 */
  3305. imagePreviewUrl?: string
  3306. /** 需要基础库: `2.14.3`
  3307. *
  3308. * 审核通过的朋友圈预览图图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
  3309. imagePreviewUrlId?: string
  3310. /** 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
  3311. imageUrlId?: string
  3312. /** 需要基础库: `2.12.2`
  3313. *
  3314. * 独立分包路径。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
  3315. path?: string
  3316. /** 查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。不传则默认使用当前页面query。 */
  3317. query?: string
  3318. /** 转发标题,不传则默认使用当前小游戏的昵称。 */
  3319. title?: string
  3320. }
  3321. interface OnShowCallbackResult {
  3322. /** 查询参数 */
  3323. query: IAnyObject
  3324. /** 当场景为由从另一个小程序或公众号或App打开时,返回此字段 */
  3325. referrerInfo: ResultReferrerInfo
  3326. /** 场景值 */
  3327. scene: number
  3328. /** shareTicket */
  3329. shareTicket?: string
  3330. }
  3331. interface OnSocketOpenCallbackResult {
  3332. /** 需要基础库: `2.0.0`
  3333. *
  3334. * 连接成功的 HTTP 响应 Header */
  3335. header: IAnyObject
  3336. }
  3337. interface OnStateUpdateCallbackResult {
  3338. /** 好友 openId */
  3339. openId: string
  3340. /** 系统状态,0 掉线 1 在线 */
  3341. sysState: number
  3342. /** 该玩家的自定义状态信息 */
  3343. userState: string
  3344. }
  3345. interface OnStopCallbackResult {
  3346. /** 录音总时长,单位:ms */
  3347. duration: number
  3348. /** 录音文件大小,单位:Byte */
  3349. fileSize: number
  3350. /** 录音文件的临时路径 (本地路径) */
  3351. tempFilePath: string
  3352. }
  3353. interface OnSyncFrameCallbackResult {
  3354. /** 帧数据列表,如果为空则说明该帧是空帧,每一项的类型与配置项 `lockStepOption.dataType` 一致 */
  3355. actionList: string[] | ArrayBuffer[]
  3356. /** 帧号,从 1 开始递增 */
  3357. frameId: number
  3358. }
  3359. interface OnTapCallbackResult {
  3360. /** 包括敏感数据在内的完整用户信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  3361. encryptedData: string
  3362. /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  3363. iv: string
  3364. /** 不包括敏感信息的原始数据字符串,用于计算签名 */
  3365. rawData: string
  3366. /** 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息,参考文档[signature](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  3367. signature: string
  3368. /** [UserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfo.html)
  3369. *
  3370. * 用户信息对象,不包含 openid 等敏感信息 */
  3371. userInfo: UserInfo
  3372. }
  3373. interface OnTimeUpdateCallbackResult {
  3374. /** 视频的总时长,单位为秒 */
  3375. duration: number
  3376. /** 当前的播放位置,单位为秒 */
  3377. position: number
  3378. }
  3379. interface OnTouchStartCallbackResult {
  3380. /** 触发此次事件的触摸点列表 */
  3381. changedTouches: Touch[]
  3382. /** 事件触发时的时间戳 */
  3383. timeStamp: number
  3384. /** 当前所有触摸点的列表 */
  3385. touches: Touch[]
  3386. }
  3387. interface OnUnhandledRejectionCallbackResult {
  3388. /** 被拒绝的 promise 对象 */
  3389. promise: string
  3390. /** 拒绝原因,一般是一个 Error 对象 */
  3391. reason: string
  3392. }
  3393. interface OnVoIPChatInterruptedCallbackResult {
  3394. /** 错误码 */
  3395. errCode: number
  3396. /** 调用结果(错误原因) */
  3397. errMsg: string
  3398. }
  3399. interface OnVoIPChatMembersChangedCallbackResult {
  3400. /** 错误码 */
  3401. errCode: number
  3402. /** 调用结果 */
  3403. errMsg: string
  3404. /** 还在实时语音通话中的成员 openId 名单 */
  3405. openIdList: string[]
  3406. }
  3407. interface OnVoIPChatSpeakersChangedCallbackResult {
  3408. /** 错误码 */
  3409. errCode: number
  3410. /** 调用结果(错误原因) */
  3411. errMsg: string
  3412. /** 还在实时语音通话中的成员 openId 名单 */
  3413. openIdList: string[]
  3414. }
  3415. interface OnVoIPChatStateChangedCallbackResult {
  3416. /** 事件码 */
  3417. code: number
  3418. /** 附加信息 */
  3419. data: IAnyObject
  3420. /** 错误码 */
  3421. errCode: number
  3422. /** 调用结果 */
  3423. errMsg: string
  3424. }
  3425. interface OnWheelCallbackResult {
  3426. /** 滚轮 x 轴方向滚动量 */
  3427. deltaX: number
  3428. /** 滚轮 y 轴方向滚动量 */
  3429. deltaY: number
  3430. /** 滚轮 z 轴方向滚动量 */
  3431. deltaZ: number
  3432. /** 事件触发时的时间戳 */
  3433. timeStamp: number
  3434. /** 事件触发时鼠标所在的位置横坐标 */
  3435. x: number
  3436. /** 事件触发时鼠标所在的位置纵坐标 */
  3437. y: number
  3438. }
  3439. interface OnWindowResizeCallbackResult {
  3440. /** 变化后的窗口高度,单位 px */
  3441. windowHeight: number
  3442. /** 变化后的窗口宽度,单位 px */
  3443. windowWidth: number
  3444. }
  3445. interface OpenBluetoothAdapterOption {
  3446. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3447. complete?: OpenBluetoothAdapterCompleteCallback
  3448. /** 接口调用失败的回调函数 */
  3449. fail?: OpenBluetoothAdapterFailCallback
  3450. /** 需要基础库: `2.10.0`
  3451. *
  3452. * 蓝牙模式,可作为主/从设备,仅 iOS 需要。
  3453. *
  3454. * 可选值:
  3455. * - 'central': 主机模式;
  3456. * - 'peripheral': 从机(外围设备)模式; */
  3457. mode?: 'central' | 'peripheral'
  3458. /** 接口调用成功的回调函数 */
  3459. success?: OpenBluetoothAdapterSuccessCallback
  3460. }
  3461. interface OpenCardOption {
  3462. /** 需要打开的卡券列表 */
  3463. cardList: OpenCardRequestInfo[]
  3464. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3465. complete?: OpenCardCompleteCallback
  3466. /** 接口调用失败的回调函数 */
  3467. fail?: OpenCardFailCallback
  3468. /** 接口调用成功的回调函数 */
  3469. success?: OpenCardSuccessCallback
  3470. }
  3471. /** 需要打开的卡券列表 */
  3472. interface OpenCardRequestInfo {
  3473. /** 卡券 ID */
  3474. cardId: string
  3475. /** 由 [wx.addCard](https://developers.weixin.qq.com/minigame/dev/api/open-api/card/wx.addCard.html) 的返回对象中的加密 code 通过解密后得到,解密请参照:[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) */
  3476. code: string
  3477. }
  3478. interface OpenChannelsActivityOption {
  3479. /** 视频 feedId */
  3480. feedId: string
  3481. /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
  3482. finderUserName: string
  3483. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3484. complete?: OpenChannelsActivityCompleteCallback
  3485. /** 接口调用失败的回调函数 */
  3486. fail?: OpenChannelsActivityFailCallback
  3487. /** 接口调用成功的回调函数 */
  3488. success?: OpenChannelsActivitySuccessCallback
  3489. }
  3490. interface OpenChannelsEventOption {
  3491. /** 活动 id */
  3492. eventId: string
  3493. /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
  3494. finderUserName: string
  3495. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3496. complete?: OpenChannelsEventCompleteCallback
  3497. /** 接口调用失败的回调函数 */
  3498. fail?: OpenChannelsEventFailCallback
  3499. /** 接口调用成功的回调函数 */
  3500. success?: OpenChannelsEventSuccessCallback
  3501. }
  3502. interface OpenChannelsLiveOption {
  3503. /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
  3504. finderUserName: string
  3505. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3506. complete?: OpenChannelsLiveCompleteCallback
  3507. /** 接口调用失败的回调函数 */
  3508. fail?: OpenChannelsLiveFailCallback
  3509. /** 直播 feedId,通过 getChannelsLiveInfo 接口获取(基础库 v2.19.2 之前的版本需要填写) */
  3510. feedId?: string
  3511. /** 直播 nonceId,通过 getChannelsLiveInfo 接口获取(基础库 v2.19.2 之前的版本需要填写) */
  3512. nonceId?: string
  3513. /** 接口调用成功的回调函数 */
  3514. success?: OpenChannelsLiveSuccessCallback
  3515. }
  3516. interface OpenChannelsUserProfileOption {
  3517. /** 视频号 id */
  3518. finderUserName: string
  3519. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3520. complete?: OpenChannelsUserProfileCompleteCallback
  3521. /** 接口调用失败的回调函数 */
  3522. fail?: OpenChannelsUserProfileFailCallback
  3523. /** 接口调用成功的回调函数 */
  3524. success?: OpenChannelsUserProfileSuccessCallback
  3525. }
  3526. interface OpenCustomerServiceConversationOption {
  3527. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3528. complete?: OpenCustomerServiceConversationCompleteCallback
  3529. /** 接口调用失败的回调函数 */
  3530. fail?: OpenCustomerServiceConversationFailCallback
  3531. /** 会话内消息卡片图片路径 */
  3532. sendMessageImg?: string
  3533. /** 会话内消息卡片路径 */
  3534. sendMessagePath?: string
  3535. /** 会话内消息卡片标题 */
  3536. sendMessageTitle?: string
  3537. /** 会话来源 */
  3538. sessionFrom?: string
  3539. /** 是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息 */
  3540. showMessageCard?: boolean
  3541. /** 接口调用成功的回调函数 */
  3542. success?: OpenCustomerServiceConversationSuccessCallback
  3543. }
  3544. /** 开放数据域对象 */
  3545. interface OpenDataContext {
  3546. /** [Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html)
  3547. *
  3548. * 开放数据域和主域共享的 sharedCanvas */
  3549. canvas: Canvas
  3550. }
  3551. interface OpenFailCallbackResult {
  3552. /** 错误信息
  3553. *
  3554. * 可选值:
  3555. * - 'fail no such file or directory "${filePath}"': 上级目录不存在; */
  3556. errMsg: string
  3557. }
  3558. interface OpenOption {
  3559. /** 文件路径 (本地路径) */
  3560. filePath: string
  3561. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3562. complete?: OpenCompleteCallback
  3563. /** 接口调用失败的回调函数 */
  3564. fail?: OpenFailCallback
  3565. /** 文件系统标志,默认值: 'r'
  3566. *
  3567. * 可选值:
  3568. * - 'a': 打开文件用于追加。 如果文件不存在,则创建该文件;
  3569. * - 'ax': 类似于 'a',但如果路径存在,则失败;
  3570. * - 'a+': 打开文件用于读取和追加。 如果文件不存在,则创建该文件;
  3571. * - 'ax+': 类似于 'a+',但如果路径存在,则失败;
  3572. * - 'as': 打开文件用于追加(在同步模式中)。 如果文件不存在,则创建该文件;
  3573. * - 'as+': 打开文件用于读取和追加(在同步模式中)。 如果文件不存在,则创建该文件;
  3574. * - 'r': 打开文件用于读取。 如果文件不存在,则会发生异常;
  3575. * - 'r+': 打开文件用于读取和写入。 如果文件不存在,则会发生异常;
  3576. * - 'w': 打开文件用于写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
  3577. * - 'wx': 类似于 'w',但如果路径存在,则失败;
  3578. * - 'w+': 打开文件用于读取和写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
  3579. * - 'wx+': 类似于 'w+',但如果路径存在,则失败; */
  3580. flag?:
  3581. | 'a'
  3582. | 'ax'
  3583. | 'a+'
  3584. | 'ax+'
  3585. | 'as'
  3586. | 'as+'
  3587. | 'r'
  3588. | 'r+'
  3589. | 'w'
  3590. | 'wx'
  3591. | 'w+'
  3592. | 'wx+'
  3593. /** 接口调用成功的回调函数 */
  3594. success?: OpenSuccessCallback
  3595. }
  3596. /** 用户点击后打开设置页面的按钮 */
  3597. interface OpenSettingButton {
  3598. /** 按钮的样式 */
  3599. style: OptionStyle
  3600. /** 按钮的类型。
  3601. *
  3602. * 可选值:
  3603. * - 'text': 可以设置背景色和文本的按钮;
  3604. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  3605. type: 'text' | 'image'
  3606. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  3607. image?: string
  3608. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  3609. text?: string
  3610. }
  3611. interface OpenSettingOption {
  3612. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3613. complete?: OpenSettingCompleteCallback
  3614. /** 接口调用失败的回调函数 */
  3615. fail?: OpenSettingFailCallback
  3616. /** 接口调用成功的回调函数 */
  3617. success?: OpenSettingSuccessCallback
  3618. /** 需要基础库: `2.10.3`
  3619. *
  3620. * 是否同时获取用户订阅消息的订阅状态,默认不获取。注意:withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择,不再询问”的订阅消息。 */
  3621. withSubscriptions?: boolean
  3622. }
  3623. interface OpenSettingSuccessCallbackResult {
  3624. /** [AuthSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/AuthSetting.html)
  3625. *
  3626. * 用户授权结果 */
  3627. authSetting: AuthSetting
  3628. /** [SubscriptionsSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/SubscriptionsSetting.html)
  3629. *
  3630. * 需要基础库: `2.10.3`
  3631. *
  3632. * 用户订阅消息设置,接口参数`withSubscriptions`值为`true`时才会返回。 */
  3633. subscriptionsSetting: SubscriptionsSetting
  3634. errMsg: string
  3635. }
  3636. interface OpenSuccessCallbackResult {
  3637. /** 文件描述符 */
  3638. fd: string
  3639. errMsg: string
  3640. }
  3641. interface OpenSyncOption {
  3642. /** 文件路径 (本地路径) */
  3643. filePath: string
  3644. /** 文件系统标志,默认值: 'r'
  3645. *
  3646. * 可选值:
  3647. * - 'a': 打开文件用于追加。 如果文件不存在,则创建该文件;
  3648. * - 'ax': 类似于 'a',但如果路径存在,则失败;
  3649. * - 'a+': 打开文件用于读取和追加。 如果文件不存在,则创建该文件;
  3650. * - 'ax+': 类似于 'a+',但如果路径存在,则失败;
  3651. * - 'as': 打开文件用于追加(在同步模式中)。 如果文件不存在,则创建该文件;
  3652. * - 'as+': 打开文件用于读取和追加(在同步模式中)。 如果文件不存在,则创建该文件;
  3653. * - 'r': 打开文件用于读取。 如果文件不存在,则会发生异常;
  3654. * - 'r+': 打开文件用于读取和写入。 如果文件不存在,则会发生异常;
  3655. * - 'w': 打开文件用于写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
  3656. * - 'wx': 类似于 'w',但如果路径存在,则失败;
  3657. * - 'w+': 打开文件用于读取和写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
  3658. * - 'wx+': 类似于 'w+',但如果路径存在,则失败; */
  3659. flag?:
  3660. | 'a'
  3661. | 'ax'
  3662. | 'a+'
  3663. | 'ax+'
  3664. | 'as'
  3665. | 'as+'
  3666. | 'r'
  3667. | 'r+'
  3668. | 'w'
  3669. | 'wx'
  3670. | 'w+'
  3671. | 'wx+'
  3672. }
  3673. /** 按钮的样式 */
  3674. interface OptionStyle {
  3675. /** 背景颜色 */
  3676. backgroundColor: string
  3677. /** 边框颜色 */
  3678. borderColor: string
  3679. /** 边框圆角 */
  3680. borderRadius: number
  3681. /** 边框宽度 */
  3682. borderWidth: number
  3683. /** 文本的颜色。格式为 6 位 16 进制数。 */
  3684. color: string
  3685. /** 字号 */
  3686. fontSize: number
  3687. /** 高度 */
  3688. height: number
  3689. /** 左上角横坐标 */
  3690. left: number
  3691. /** 文本的行高 */
  3692. lineHeight: number
  3693. /** 文本的水平居中方式
  3694. *
  3695. * 可选值:
  3696. * - 'left': 居左;
  3697. * - 'center': 居中;
  3698. * - 'right': 居右; */
  3699. textAlign: 'left' | 'center' | 'right'
  3700. /** 左上角纵坐标 */
  3701. top: number
  3702. /** 宽度 */
  3703. width: number
  3704. }
  3705. interface OwnerLeaveRoomOption {
  3706. /** 游戏房间访问凭证 */
  3707. accessInfo: string
  3708. /** 指定座位号的玩家接任房主角色,优先级高于 assignToMinPosNum */
  3709. assignOwnerToPosNum?: boolean
  3710. /** 自动指定最小座位号玩家作为新房主 */
  3711. assignToMinPosNum?: boolean
  3712. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3713. complete?: OwnerLeaveRoomCompleteCallback
  3714. /** 接口调用失败的回调函数 */
  3715. fail?: OwnerLeaveRoomFailCallback
  3716. /** 接口调用成功的回调函数 */
  3717. success?: OwnerLeaveRoomSuccessCallback
  3718. }
  3719. /** 插件帐号信息(仅在插件中调用时包含这一项) */
  3720. interface Plugin {
  3721. /** 插件 appId */
  3722. appId: string
  3723. /** 插件版本号 */
  3724. version: string
  3725. }
  3726. interface PreviewImageOption {
  3727. /** 需要预览的图片链接列表。[2.2.3](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起支持云文件ID。 */
  3728. urls: string[]
  3729. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3730. complete?: PreviewImageCompleteCallback
  3731. /** 当前显示图片的链接 */
  3732. current?: string
  3733. /** 接口调用失败的回调函数 */
  3734. fail?: PreviewImageFailCallback
  3735. /** 需要基础库: `2.13.0`
  3736. *
  3737. * `origin`: 发送完整的referrer; `no-referrer`: 不发送。格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本; */
  3738. referrerPolicy?: string
  3739. /** 需要基础库: `2.13.0`
  3740. *
  3741. * 是否显示长按菜单。
  3742. *
  3743. * 支持识别的码:小程序码
  3744. *
  3745. * 仅小程序支持识别的码:微信个人码、微信群码、企业微信个人码、 企业微信群码与企业微信互通群码; */
  3746. showmenu?: boolean
  3747. /** 接口调用成功的回调函数 */
  3748. success?: PreviewImageSuccessCallback
  3749. }
  3750. interface PreviewMediaOption {
  3751. /** 需要预览的资源列表 */
  3752. sources: MediaSource[]
  3753. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3754. complete?: PreviewMediaCompleteCallback
  3755. /** 当前显示的资源序号 */
  3756. current?: number
  3757. /** 接口调用失败的回调函数 */
  3758. fail?: PreviewMediaFailCallback
  3759. /** 需要基础库: `2.13.0`
  3760. *
  3761. * `origin`: 发送完整的referrer; `no-referrer`: 不发送。格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本; */
  3762. referrerPolicy?: string
  3763. /** 需要基础库: `2.13.0`
  3764. *
  3765. * 是否显示长按菜单。
  3766. *
  3767. * 支持识别的码:小程序码
  3768. *
  3769. * 仅小程序支持识别的码:微信个人码、微信群码、企业微信个人码、 企业微信群码与企业微信互通群码; */
  3770. showmenu?: boolean
  3771. /** 接口调用成功的回调函数 */
  3772. success?: PreviewMediaSuccessCallback
  3773. }
  3774. interface ReadBLECharacteristicValueOption {
  3775. /** 蓝牙特征的 UUID */
  3776. characteristicId: string
  3777. /** 蓝牙设备 id */
  3778. deviceId: string
  3779. /** 蓝牙特征对应服务的 UUID */
  3780. serviceId: string
  3781. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3782. complete?: ReadBLECharacteristicValueCompleteCallback
  3783. /** 接口调用失败的回调函数 */
  3784. fail?: ReadBLECharacteristicValueFailCallback
  3785. /** 接口调用成功的回调函数 */
  3786. success?: ReadBLECharacteristicValueSuccessCallback
  3787. }
  3788. interface ReadCompressedFileFailCallbackResult {
  3789. /** 错误信息
  3790. *
  3791. * 可选值:
  3792. * - 'fail decompress fail': 指定的 compressionAlgorithm 与文件实际压缩格式不符;
  3793. * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
  3794. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限; */
  3795. errMsg: string
  3796. }
  3797. interface ReadCompressedFileOption {
  3798. /** 文件压缩类型,目前仅支持 'br'。
  3799. *
  3800. * 可选值:
  3801. * - 'br': brotli压缩文件; */
  3802. compressionAlgorithm: 'br'
  3803. /** 要读取的文件的路径 (本地用户文件或代码包文件) */
  3804. filePath: string
  3805. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3806. complete?: ReadCompressedFileCompleteCallback
  3807. /** 接口调用失败的回调函数 */
  3808. fail?: ReadCompressedFileFailCallback
  3809. /** 接口调用成功的回调函数 */
  3810. success?: ReadCompressedFileSuccessCallback
  3811. }
  3812. interface ReadCompressedFileSuccessCallbackResult {
  3813. /** 文件内容 */
  3814. data: ArrayBuffer
  3815. errMsg: string
  3816. }
  3817. interface ReadCompressedFileSyncOption {
  3818. /** 文件压缩类型,目前仅支持 'br'。
  3819. *
  3820. * 可选值:
  3821. * - 'br': brotli压缩文件; */
  3822. compressionAlgorithm: 'br'
  3823. /** 要读取的文件的路径 (本地用户文件或代码包文件) */
  3824. filePath: string
  3825. }
  3826. interface ReadFailCallbackResult {
  3827. /** 错误信息
  3828. *
  3829. * 可选值:
  3830. * - 'bad file descriptor': 无效的文件描述符;
  3831. * - 'fail permission denied': 指定的 fd 路径没有读权限;
  3832. * - 'fail the value of "offset" is out of range': 传入的 offset 不合法;
  3833. * - 'fail the value of "length" is out of range': 传入的 length 不合法;
  3834. * - 'fail sdcard not mounted': android sdcard 挂载失败;
  3835. * - 'bad file descriptor': 无效的文件描述符; */
  3836. errMsg: string
  3837. }
  3838. interface ReadFileFailCallbackResult {
  3839. /** 错误信息
  3840. *
  3841. * 可选值:
  3842. * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
  3843. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;
  3844. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  3845. errMsg: string
  3846. }
  3847. interface ReadFileOption {
  3848. /** 要读取的文件的路径 (本地路径) */
  3849. filePath: string
  3850. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3851. complete?: ReadFileCompleteCallback
  3852. /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
  3853. *
  3854. * 可选值:
  3855. * - 'ascii': ;
  3856. * - 'base64': ;
  3857. * - 'binary': ;
  3858. * - 'hex': ;
  3859. * - 'ucs2': 以小端序读取;
  3860. * - 'ucs-2': 以小端序读取;
  3861. * - 'utf16le': 以小端序读取;
  3862. * - 'utf-16le': 以小端序读取;
  3863. * - 'utf-8': ;
  3864. * - 'utf8': ;
  3865. * - 'latin1': ; */
  3866. encoding?:
  3867. | 'ascii'
  3868. | 'base64'
  3869. | 'binary'
  3870. | 'hex'
  3871. | 'ucs2'
  3872. | 'ucs-2'
  3873. | 'utf16le'
  3874. | 'utf-16le'
  3875. | 'utf-8'
  3876. | 'utf8'
  3877. | 'latin1'
  3878. /** 接口调用失败的回调函数 */
  3879. fail?: ReadFileFailCallback
  3880. /** 需要基础库: `2.10.0`
  3881. *
  3882. * 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
  3883. length?: number
  3884. /** 需要基础库: `2.10.0`
  3885. *
  3886. * 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
  3887. position?: number
  3888. /** 接口调用成功的回调函数 */
  3889. success?: ReadFileSuccessCallback
  3890. }
  3891. interface ReadFileSuccessCallbackResult {
  3892. /** 文件内容 */
  3893. data: string | ArrayBuffer
  3894. errMsg: string
  3895. }
  3896. interface ReadOption {
  3897. /** 数据写入的缓冲区,必须是 ArrayBuffer 实例 */
  3898. arrayBuffer: ArrayBuffer
  3899. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  3900. fd: string
  3901. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3902. complete?: ReadCompleteCallback
  3903. /** 接口调用失败的回调函数 */
  3904. fail?: ReadFailCallback
  3905. /** 要从文件中读取的字节数,默认0 */
  3906. length?: number
  3907. /** 缓冲区中的写入偏移量,默认0 */
  3908. offset?: number
  3909. /** 文件读取的起始位置,如不传或传 null,则会从当前文件指针的位置读取。如果 position 是正整数,则文件指针位置会保持不变并从 position 读取文件。 */
  3910. position?: number
  3911. /** 接口调用成功的回调函数 */
  3912. success?: ReadSuccessCallback
  3913. }
  3914. /** 文件读取结果。 通过 [FileSystemManager.readSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readSync.html) 接口返回 */
  3915. interface ReadResult {
  3916. /** 被写入的缓存区的对象,即接口入参的 arrayBuffer */
  3917. arrayBuffer: ArrayBuffer
  3918. /** 实际读取的字节数 */
  3919. bytesRead: number
  3920. }
  3921. interface ReadSuccessCallbackResult {
  3922. /** 被写入的缓存区的对象,即接口入参的 arrayBuffer */
  3923. arrayBuffer: ArrayBuffer
  3924. /** 实际读取的字节数 */
  3925. bytesRead: number
  3926. errMsg: string
  3927. }
  3928. interface ReadSyncOption {
  3929. /** 数据写入的缓冲区,必须是 ArrayBuffer 实例 */
  3930. arrayBuffer: ArrayBuffer
  3931. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  3932. fd: string
  3933. /** 要从文件中读取的字节数,默认0 */
  3934. length?: number
  3935. /** 缓冲区中的写入偏移量,默认0 */
  3936. offset?: number
  3937. /** 文件读取的起始位置,如不传或传 null,则会从当前文件指针的位置读取。如果 position 是正整数,则文件指针位置会保持不变并从 position 读取文件。 */
  3938. position?: number
  3939. }
  3940. interface ReadZipEntryOption {
  3941. /** 要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件) */
  3942. entries: EntryItem[] | 'all'
  3943. /** 要读取的压缩包的路径 (本地路径) */
  3944. filePath: string
  3945. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3946. complete?: ReadZipEntryCompleteCallback
  3947. /** 统一指定读取文件的字符编码,只在 entries 值为"all"时有效。如果 entries 值为"all"且不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
  3948. *
  3949. * 可选值:
  3950. * - 'ascii': ;
  3951. * - 'base64': ;
  3952. * - 'binary': ;
  3953. * - 'hex': ;
  3954. * - 'ucs2': 以小端序读取;
  3955. * - 'ucs-2': 以小端序读取;
  3956. * - 'utf16le': 以小端序读取;
  3957. * - 'utf-16le': 以小端序读取;
  3958. * - 'utf-8': ;
  3959. * - 'utf8': ;
  3960. * - 'latin1': ; */
  3961. encoding?:
  3962. | 'ascii'
  3963. | 'base64'
  3964. | 'binary'
  3965. | 'hex'
  3966. | 'ucs2'
  3967. | 'ucs-2'
  3968. | 'utf16le'
  3969. | 'utf-16le'
  3970. | 'utf-8'
  3971. | 'utf8'
  3972. | 'latin1'
  3973. /** 接口调用失败的回调函数 */
  3974. fail?: ReadZipEntryFailCallback
  3975. /** 接口调用成功的回调函数 */
  3976. success?: ReadZipEntrySuccessCallback
  3977. }
  3978. interface ReadZipEntrySuccessCallbackResult {
  3979. /** 文件读取结果。res.entries 是一个对象,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。 */
  3980. entries: EntriesResult
  3981. errMsg: string
  3982. }
  3983. interface ReaddirFailCallbackResult {
  3984. /** 错误信息
  3985. *
  3986. * 可选值:
  3987. * - 'fail no such file or directory ${dirPath}': 目录不存在;
  3988. * - 'fail not a directory ${dirPath}': dirPath 不是目录;
  3989. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;
  3990. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  3991. errMsg: string
  3992. }
  3993. interface ReaddirOption {
  3994. /** 要读取的目录路径 (本地路径) */
  3995. dirPath: string
  3996. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  3997. complete?: ReaddirCompleteCallback
  3998. /** 接口调用失败的回调函数 */
  3999. fail?: ReaddirFailCallback
  4000. /** 接口调用成功的回调函数 */
  4001. success?: ReaddirSuccessCallback
  4002. }
  4003. interface ReaddirSuccessCallbackResult {
  4004. /** 指定目录下的文件名数组。 */
  4005. files: string[]
  4006. errMsg: string
  4007. }
  4008. interface ReconnectOption {
  4009. /** 需要重连的对局房间唯一标识 */
  4010. accessInfo: number
  4011. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4012. complete?: ReconnectCompleteCallback
  4013. /** 接口调用失败的回调函数 */
  4014. fail?: ReconnectFailCallback
  4015. /** 接口调用成功的回调函数 */
  4016. success?: ReconnectSuccessCallback
  4017. }
  4018. interface ReconnectSuccessCallbackDataResult {
  4019. /** 此时服务器的最大帧号。 */
  4020. maxFrameId: any[]
  4021. }
  4022. interface ReconnectSuccessCallbackResult {
  4023. data: ReconnectSuccessCallbackDataResult
  4024. errMsg: string
  4025. }
  4026. interface RecorderManagerStartOption {
  4027. /** 需要基础库: `2.1.0`
  4028. *
  4029. * 指定录音的音频输入源,可通过 [wx.getAvailableAudioSources()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.getAvailableAudioSources.html) 获取当前可用的音频源
  4030. *
  4031. * 可选值:
  4032. * - 'auto': 自动设置,默认使用手机麦克风,插上耳麦后自动切换使用耳机麦克风,所有平台适用;
  4033. * - 'buildInMic': 手机麦克风,仅限 iOS;
  4034. * - 'headsetMic': 有线耳机麦克风,仅限 iOS;
  4035. * - 'mic': 麦克风(没插耳麦时是手机麦克风,插耳麦时是耳机麦克风),仅限 Android;
  4036. * - 'camcorder': 同 mic,适用于录制音视频内容,仅限 Android;
  4037. * - 'voice_communication': 同 mic,适用于实时沟通,仅限 Android;
  4038. * - 'voice_recognition': 同 mic,适用于语音识别,仅限 Android; */
  4039. audioSource?:
  4040. | 'auto'
  4041. | 'buildInMic'
  4042. | 'headsetMic'
  4043. | 'mic'
  4044. | 'camcorder'
  4045. | 'voice_communication'
  4046. | 'voice_recognition'
  4047. /** 录音的时长,单位 ms,最大值 600000(10 分钟) */
  4048. duration?: number
  4049. /** 编码码率,有效值见下表格 */
  4050. encodeBitRate?: number
  4051. /** 音频格式
  4052. *
  4053. * 可选值:
  4054. * - 'mp3': mp3 格式;
  4055. * - 'aac': aac 格式;
  4056. * - 'wav': wav 格式;
  4057. * - 'PCM': pcm 格式; */
  4058. format?: 'mp3' | 'aac' | 'wav' | 'PCM'
  4059. /** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
  4060. frameSize?: number
  4061. /** 录音通道数
  4062. *
  4063. * 可选值:
  4064. * - 1: 1 个通道;
  4065. * - 2: 2 个通道; */
  4066. numberOfChannels?: 1 | 2
  4067. /** 采样率(pc不支持)
  4068. *
  4069. * 可选值:
  4070. * - 8000: 8000 采样率;
  4071. * - 11025: 11025 采样率;
  4072. * - 12000: 12000 采样率;
  4073. * - 16000: 16000 采样率;
  4074. * - 22050: 22050 采样率;
  4075. * - 24000: 24000 采样率;
  4076. * - 32000: 32000 采样率;
  4077. * - 44100: 44100 采样率;
  4078. * - 48000: 48000 采样率; */
  4079. sampleRate?:
  4080. | 8000
  4081. | 11025
  4082. | 12000
  4083. | 16000
  4084. | 22050
  4085. | 24000
  4086. | 32000
  4087. | 44100
  4088. | 48000
  4089. }
  4090. /** 发送端地址信息 */
  4091. interface RemoteInfo {
  4092. /** 发送消息的 socket 的地址 */
  4093. address: string
  4094. /** 使用的协议族,为 IPv4 或者 IPv6 */
  4095. family: string
  4096. /** 端口号 */
  4097. port: number
  4098. /** message 的大小,单位:字节 */
  4099. size: number
  4100. }
  4101. interface RemoveSavedFileFailCallbackResult {
  4102. /** 错误信息
  4103. *
  4104. * 可选值:
  4105. * - 'fail file not exist': 指定的 tempFilePath 找不到文件; */
  4106. errMsg: string
  4107. }
  4108. interface RemoveSavedFileOption {
  4109. /** 需要删除的文件路径 (本地路径) */
  4110. filePath: string
  4111. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4112. complete?: RemoveSavedFileCompleteCallback
  4113. /** 接口调用失败的回调函数 */
  4114. fail?: RemoveSavedFileFailCallback
  4115. /** 接口调用成功的回调函数 */
  4116. success?: RemoveSavedFileSuccessCallback
  4117. }
  4118. interface RemoveServiceOption {
  4119. /** service 的 UUID */
  4120. serviceId: string
  4121. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4122. complete?: RemoveServiceCompleteCallback
  4123. /** 接口调用失败的回调函数 */
  4124. fail?: RemoveServiceFailCallback
  4125. /** 接口调用成功的回调函数 */
  4126. success?: RemoveServiceSuccessCallback
  4127. }
  4128. interface RemoveStorageOption {
  4129. /** 本地缓存中指定的 key */
  4130. key: string
  4131. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4132. complete?: RemoveStorageCompleteCallback
  4133. /** 接口调用失败的回调函数 */
  4134. fail?: RemoveStorageFailCallback
  4135. /** 接口调用成功的回调函数 */
  4136. success?: RemoveStorageSuccessCallback
  4137. }
  4138. interface RemoveUserCloudStorageOption {
  4139. /** 要删除掉 key 列表 */
  4140. keyList: string[]
  4141. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4142. complete?: RemoveUserCloudStorageCompleteCallback
  4143. /** 接口调用失败的回调函数 */
  4144. fail?: RemoveUserCloudStorageFailCallback
  4145. /** 接口调用成功的回调函数 */
  4146. success?: RemoveUserCloudStorageSuccessCallback
  4147. }
  4148. interface RenameFailCallbackResult {
  4149. /** 错误信息
  4150. *
  4151. * 可选值:
  4152. * - 'fail permission denied, rename ${oldPath} -> ${newPath}': 指定源文件或目标文件没有写权限;
  4153. * - 'fail no such file or directory, rename ${oldPath} -> ${newPath}': 源文件不存在,或目标文件路径的上层目录不存在; */
  4154. errMsg: string
  4155. }
  4156. interface RenameOption {
  4157. /** 新文件路径,支持本地路径 */
  4158. newPath: string
  4159. /** 源文件路径,支持本地路径 */
  4160. oldPath: string
  4161. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4162. complete?: RenameCompleteCallback
  4163. /** 接口调用失败的回调函数 */
  4164. fail?: RenameFailCallback
  4165. /** 接口调用成功的回调函数 */
  4166. success?: RenameSuccessCallback
  4167. }
  4168. /** 画布对象的绘图上下文。
  4169. *
  4170. * - 通过 Canvas.getContext('2d') 接口可以获取 CanvasRenderingContext2D 对象,实现了 [HTML Canvas 2D Context](https://www.w3.org/TR/2dcontext/) 定义的大部分属性、方法。
  4171. * - 通过 Canvas.getContext('webgl') 接口可以获取 WebGLRenderingContext 对象,实现了 [WebGL 1.0](https://www.khronos.org/registry/webgl/specs/latest/1.0/) 定义的所有属性、方法、常量。
  4172. *
  4173. * **2d 接口支持情况**
  4174. *
  4175. * iOS/Android 不支持的 2d 属性和接口
  4176. *
  4177. * - globalCompositeOperation 不支持以下值: source-in source-out destination-atop lighter copy。如果使用,不会报错,但是将得到与预期不符的结果。
  4178. * - isPointInPath
  4179. *
  4180. * **WebGL 接口支持情况**
  4181. *
  4182. * 压缩纹理的支持
  4183. * - iOS 支持 pvr 格式
  4184. * - Android 支持 etc1 格式 */
  4185. interface RenderingContext {}
  4186. interface ReportUserBehaviorBranchAnalyticsOption {
  4187. /** 分支ID,在「小程序管理后台」获取 */
  4188. branchId: string
  4189. /** 事件类型,1:曝光; 2:点击 */
  4190. eventType: number
  4191. /** 自定义维度,基础库 v2.14.0 开始支持可选 */
  4192. branchDim?: string
  4193. }
  4194. interface RequestMidasFriendPaymentOption {
  4195. /** 购买数量。mode=game 时必填。购买数量。详见 [buyQuantity 限制说明](#buyQuantity限制说明)。 */
  4196. buyQuantity: number
  4197. /** 币种
  4198. *
  4199. * 可选值:
  4200. * - 'CNY': 人民币; */
  4201. currencyType: 'CNY'
  4202. /** 环境配置
  4203. *
  4204. * 可选值:
  4205. * - 0: 米大师正式环境;
  4206. * - 1: 米大师沙箱环境; */
  4207. env: 0 | 1
  4208. /** 支付的类型,不同的支付类型有各自额外要传的附加参数
  4209. *
  4210. * 可选值:
  4211. * - 'game': 购买游戏币; */
  4212. mode: 'game'
  4213. /** 随机字符串,长度应小于 128 */
  4214. nonceStr: string
  4215. /** 在米大师侧申请的应用 id */
  4216. offerId: string
  4217. /** 开发者业务订单号,每个订单号只能使用一次,重复使用会失败。要求32个字符内,只能是数字、大小写字母、符号 `_-|*@` */
  4218. outTradeNo: string
  4219. /** 申请接入时的平台,platform 与应用id有关。
  4220. *
  4221. * 可选值:
  4222. * - 'android': Android平台; */
  4223. platform: 'android'
  4224. /** 签名 */
  4225. signature: string
  4226. /** 生成这个随机字符串的 UNIX 时间戳(精确到秒) */
  4227. timeStamp: number
  4228. /** 分区 ID */
  4229. zoneId: string
  4230. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4231. complete?: RequestMidasFriendPaymentCompleteCallback
  4232. /** 接口调用失败的回调函数 */
  4233. fail?: RequestMidasFriendPaymentFailCallback
  4234. /** 接口调用成功的回调函数 */
  4235. success?: RequestMidasFriendPaymentSuccessCallback
  4236. }
  4237. interface RequestMidasFriendPaymentSuccessCallbackResult {
  4238. /** 敏感数据对应的云 ID,开通[云开发](https://developers.weixin.qq.com/minigame/dev/wxcloud/basis/getting-started.html)的小程序才会返回,可通过云调用直接获取开放数据,详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#method-cloud) */
  4239. cloudID: string
  4240. /** 包括敏感数据在内的完整转发信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  4241. encryptedData: string
  4242. /** 错误信息 */
  4243. errMsg: string
  4244. /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
  4245. iv: string
  4246. }
  4247. interface RequestMidasPaymentOption {
  4248. /** 币种
  4249. *
  4250. * 可选值:
  4251. * - 'CNY': 人民币; */
  4252. currencyType: 'CNY'
  4253. /** 支付的类型,不同的支付类型有各自额外要传的附加参数。
  4254. *
  4255. * 可选值:
  4256. * - 'game': 购买游戏币; */
  4257. mode: 'game'
  4258. /** 在米大师侧申请的应用 id */
  4259. offerId: string
  4260. /** 购买数量。mode=game 时必填。购买数量。详见 [buyQuantity 限制说明](#buyquantity-限制说明)。 */
  4261. buyQuantity?: number
  4262. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4263. complete?: RequestMidasPaymentCompleteCallback
  4264. /** 环境配置
  4265. *
  4266. * 可选值:
  4267. * - 0: 米大师正式环境;
  4268. * - 1: 米大师沙箱环境; */
  4269. env?: 0 | 1
  4270. /** 接口调用失败的回调函数 */
  4271. fail?: RequestMidasPaymentFailCallback
  4272. /** 申请接入时的平台,platform 与应用id有关。
  4273. *
  4274. * 可选值:
  4275. * - 'android': android; */
  4276. platform?: 'android'
  4277. /** 接口调用成功的回调函数 */
  4278. success?: RequestMidasPaymentSuccessCallback
  4279. /** 分区 ID */
  4280. zoneId?: string
  4281. }
  4282. interface RequestOption<
  4283. T extends string | IAnyObject | ArrayBuffer =
  4284. | string
  4285. | IAnyObject
  4286. | ArrayBuffer
  4287. > {
  4288. /** 开发者服务器接口地址 */
  4289. url: string
  4290. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4291. complete?: RequestCompleteCallback
  4292. /** 请求的参数 */
  4293. data?: string | IAnyObject | ArrayBuffer
  4294. /** 返回的数据格式
  4295. *
  4296. * 可选值:
  4297. * - 'json': 返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse;
  4298. * - '其他': 不对返回的内容进行 JSON.parse; */
  4299. dataType?: 'json' | '其他'
  4300. /** 需要基础库: `2.10.4`
  4301. *
  4302. * 开启 cache */
  4303. enableCache?: boolean
  4304. /** 需要基础库: `2.20.2`
  4305. *
  4306. * 开启 transfer-encoding chunked。 */
  4307. enableChunked?: boolean
  4308. /** 需要基础库: `2.10.4`
  4309. *
  4310. * 开启 http2 */
  4311. enableHttp2?: boolean
  4312. /** 需要基础库: `2.19.1`
  4313. *
  4314. * 是否开启 HttpDNS 服务。如开启,需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html) */
  4315. enableHttpDNS?: boolean
  4316. /** 需要基础库: `2.10.4`
  4317. *
  4318. * 开启 quic */
  4319. enableQuic?: boolean
  4320. /** 接口调用失败的回调函数 */
  4321. fail?: RequestFailCallback
  4322. /** 设置请求的 header,header 中不能设置 Referer。
  4323. *
  4324. * `content-type` 默认为 `application/json` */
  4325. header?: IAnyObject
  4326. /** 需要基础库: `2.19.1`
  4327. *
  4328. * HttpDNS 服务商 Id。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html) */
  4329. httpDNSServiceId?: boolean
  4330. /** HTTP 请求方法
  4331. *
  4332. * 可选值:
  4333. * - 'OPTIONS': HTTP 请求 OPTIONS;
  4334. * - 'GET': HTTP 请求 GET;
  4335. * - 'HEAD': HTTP 请求 HEAD;
  4336. * - 'POST': HTTP 请求 POST;
  4337. * - 'PUT': HTTP 请求 PUT;
  4338. * - 'DELETE': HTTP 请求 DELETE;
  4339. * - 'TRACE': HTTP 请求 TRACE;
  4340. * - 'CONNECT': HTTP 请求 CONNECT; */
  4341. method?:
  4342. | 'OPTIONS'
  4343. | 'GET'
  4344. | 'HEAD'
  4345. | 'POST'
  4346. | 'PUT'
  4347. | 'DELETE'
  4348. | 'TRACE'
  4349. | 'CONNECT'
  4350. /** 需要基础库: `1.7.0`
  4351. *
  4352. * 响应的数据类型
  4353. *
  4354. * 可选值:
  4355. * - 'text': 响应的数据为文本;
  4356. * - 'arraybuffer': 响应的数据为 ArrayBuffer; */
  4357. responseType?: 'text' | 'arraybuffer'
  4358. /** 接口调用成功的回调函数 */
  4359. success?: RequestSuccessCallback<T>
  4360. /** 需要基础库: `2.10.0`
  4361. *
  4362. * 超时时间,单位为毫秒 */
  4363. timeout?: number
  4364. }
  4365. /** 需要基础库: `2.10.4`
  4366. *
  4367. * 网络请求过程中一些调试信息,[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html) */
  4368. interface RequestProfile {
  4369. /** SSL建立完成的时间,如果不是安全连接,则值为 0 */
  4370. SSLconnectionEnd: number
  4371. /** SSL建立连接的时间,如果不是安全连接,则值为 0 */
  4372. SSLconnectionStart: number
  4373. /** HTTP(TCP) 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过 */
  4374. connectEnd: number
  4375. /** HTTP(TCP) 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间 */
  4376. connectStart: number
  4377. /** DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
  4378. domainLookupEnd: number
  4379. /** DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
  4380. domainLookupStart: number
  4381. /** 评估当前网络下载的kbps */
  4382. downstreamThroughputKbpsEstimate: number
  4383. /** 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6 */
  4384. estimate_nettype: number
  4385. /** 组件准备好使用 HTTP 请求抓取资源的时间,这发生在检查本地缓存之前 */
  4386. fetchStart: number
  4387. /** 协议层根据多个请求评估当前网络的 rtt(仅供参考) */
  4388. httpRttEstimate: number
  4389. /** 当前请求的IP */
  4390. peerIP: string
  4391. /** 当前请求的端口 */
  4392. port: number
  4393. /** 使用协议类型,有效值:http1.1, h2, quic, unknown */
  4394. protocol: string
  4395. /** 收到字节数 */
  4396. receivedBytedCount: number
  4397. /** 最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算,否则值为 0 */
  4398. redirectEnd: number
  4399. /** 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算,否则值为 0 */
  4400. redirectStart: number
  4401. /** HTTP请求读取真实文档结束的时间 */
  4402. requestEnd: number
  4403. /** HTTP请求读取真实文档开始的时间(完成建立连接),包括从本地读取缓存。连接错误重连时,这里显示的也是新建立连接的时间 */
  4404. requestStart: number
  4405. /** HTTP 响应全部接收完成的时间(获取到最后一个字节),包括从本地读取缓存 */
  4406. responseEnd: number
  4407. /** HTTP 开始接收响应的时间(获取到第一个字节),包括从本地读取缓存 */
  4408. responseStart: number
  4409. /** 当次请求连接过程中实时 rtt */
  4410. rtt: number
  4411. /** 发送的字节数 */
  4412. sendBytesCount: number
  4413. /** 是否复用连接 */
  4414. socketReused: boolean
  4415. /** 当前网络的实际下载kbps */
  4416. throughputKbps: number
  4417. /** 传输层根据多个请求评估的当前网络的 rtt(仅供参考) */
  4418. transportRttEstimate: number
  4419. }
  4420. interface RequestSubscribeMessageFailCallbackResult {
  4421. /** 接口调用失败错误码 */
  4422. errCode: number
  4423. /** 接口调用失败错误信息 */
  4424. errMsg: string
  4425. }
  4426. interface RequestSubscribeMessageOption {
  4427. /** 需要订阅的消息模板的id的集合,一次调用最多可订阅3条消息(注意:iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息,iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息)消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置。每个tmplId对应的模板标题需要不相同,否则会被过滤。 */
  4428. tmplIds: any[]
  4429. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4430. complete?: RequestSubscribeMessageCompleteCallback
  4431. /** 接口调用失败的回调函数 */
  4432. fail?: RequestSubscribeMessageFailCallback
  4433. /** 接口调用成功的回调函数 */
  4434. success?: RequestSubscribeMessageSuccessCallback
  4435. }
  4436. interface RequestSubscribeMessageSuccessCallbackResult {
  4437. /** [TEMPLATE_ID]是动态的键,即模板id,值包括'accept'、'reject'、'ban'、'filter'。'accept'表示用户同意订阅该条id对应的模板消息,'reject'表示用户拒绝订阅该条id对应的模板消息,'ban'表示已被后台封禁,'filter'表示该模板因为模板标题同名被后台过滤。例如 { errMsg: "requestSubscribeMessage:ok", zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: "accept"} 表示用户同意订阅zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE这条消息 */
  4438. [TEMPLATE_ID: string]: string
  4439. /** 接口调用成功时errMsg值为'requestSubscribeMessage:ok' */
  4440. errMsg: string
  4441. }
  4442. interface RequestSubscribeSystemMessageOption {
  4443. /** 系统订阅消息类型列表,一次调用最多可订阅3种类型的消息,目前支持两种类型,"SYS_MSG_TYPE_INTERACTIVE"(好友互动提醒)、"SYS_MSG_TYPE_RANK"(排行榜超越提醒) */
  4444. msgTypeList: string[]
  4445. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4446. complete?: RequestSubscribeSystemMessageCompleteCallback
  4447. /** 接口调用失败的回调函数 */
  4448. fail?: RequestSubscribeSystemMessageFailCallback
  4449. /** 接口调用成功的回调函数 */
  4450. success?: RequestSubscribeSystemMessageSuccessCallback
  4451. }
  4452. interface RequestSubscribeSystemMessageSuccessCallbackResult {
  4453. /** [MSG_TYPE]是动态的键,即系统订阅消息类型,值为'accept'、'reject'、'ban','accept'表示用户同意订阅该类型对应的模板消息,'reject'表示用户拒绝订阅该类型对应的模板消息,'ban'表示已被后台封禁。例如 { errMsg: "requestSubscribeSystemMessage:ok", SYS_MSG_TYPE_INTERACTIVE: "accept" } 表示用户同意订阅'SYS_MSG_TYPE_INTERACTIVE'这条消息 */
  4454. MSG_TYPE: string
  4455. /** 接口调用成功时errMsg值为'requestSubscribeSystemMessage:ok' */
  4456. errMsg: string
  4457. }
  4458. interface RequestSuccessCallbackResult<
  4459. T extends string | IAnyObject | ArrayBuffer =
  4460. | string
  4461. | IAnyObject
  4462. | ArrayBuffer
  4463. > {
  4464. /** 需要基础库: `2.10.0`
  4465. *
  4466. * 开发者服务器返回的 cookies,格式为字符串数组 */
  4467. cookies: string[]
  4468. /** 开发者服务器返回的数据 */
  4469. data: T
  4470. /** 需要基础库: `1.2.0`
  4471. *
  4472. * 开发者服务器返回的 HTTP Response Header */
  4473. header: IAnyObject
  4474. /** 需要基础库: `2.10.4`
  4475. *
  4476. * 网络请求过程中一些调试信息,[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html) */
  4477. profile: RequestProfile
  4478. /** 开发者服务器返回的 HTTP 状态码 */
  4479. statusCode: number
  4480. errMsg: string
  4481. }
  4482. interface RequestTaskOnChunkReceivedCallbackResult {
  4483. /** 开发者服务器每次返回新chunk时的Response */
  4484. res: OnChunkReceivedCallbackResult
  4485. }
  4486. interface Res {
  4487. /** 好友状态信息列表 */
  4488. list: StateData[]
  4489. }
  4490. interface ReserveChannelsLiveOption {
  4491. /** 预告 id,通过 getChannelsLiveNoticeInfo 接口获取 */
  4492. noticeId: string
  4493. }
  4494. interface RestartOption {
  4495. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4496. complete?: RestartCompleteCallback
  4497. /** 接口调用失败的回调函数 */
  4498. fail?: RestartFailCallback
  4499. /** 接口调用成功的回调函数 */
  4500. success?: RestartSuccessCallback
  4501. }
  4502. /** 当场景为由从另一个小程序或公众号或App打开时,返回此字段 */
  4503. interface ResultReferrerInfo {
  4504. /** 来源小程序或公众号或App的 appId */
  4505. appId: string
  4506. /** 来源小程序传过来的数据,scene=1037或1038时支持 */
  4507. extraData: IAnyObject
  4508. }
  4509. interface RewardedVideoAdOnCloseCallbackResult {
  4510. /** 需要基础库: `2.1.0`
  4511. *
  4512. * 视频是否是在用户完整观看的情况下被关闭的 */
  4513. isEnded: boolean
  4514. }
  4515. interface RmdirFailCallbackResult {
  4516. /** 错误信息
  4517. *
  4518. * 可选值:
  4519. * - 'fail no such file or directory ${dirPath}': 目录不存在;
  4520. * - 'fail directory not empty': 目录不为空;
  4521. * - 'fail permission denied, open ${dirPath}': 指定的 dirPath 路径没有写权限;
  4522. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  4523. errMsg: string
  4524. }
  4525. interface RmdirOption {
  4526. /** 要删除的目录路径 (本地路径) */
  4527. dirPath: string
  4528. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4529. complete?: RmdirCompleteCallback
  4530. /** 接口调用失败的回调函数 */
  4531. fail?: RmdirFailCallback
  4532. /** 需要基础库: `2.3.0`
  4533. *
  4534. * 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 */
  4535. recursive?: boolean
  4536. /** 接口调用成功的回调函数 */
  4537. success?: RmdirSuccessCallback
  4538. }
  4539. interface RoomInfo {
  4540. /** 小游戏 appId */
  4541. appId: string
  4542. /** 创建时间 */
  4543. createTimestamp: number
  4544. /** 游戏对局时长,单位 s */
  4545. gameLastTime: number
  4546. /** 游戏下发帧的时间间隔,单位 ms */
  4547. gameTick: number
  4548. /** 房间最多可容纳人数 */
  4549. maxMemberNum: number
  4550. /** 成员列表 */
  4551. memberList: RoomMemberInfo[]
  4552. /** 游戏自定义的关于房间的扩展信息 */
  4553. roomExtInfo: string
  4554. /** 房间 ID */
  4555. roomIdStr: number
  4556. /** 房间状态
  4557. *
  4558. * 可选值:
  4559. * - 1: 组队中;
  4560. * - 2: 该房间的对局游戏已开始;
  4561. * - 3: 该房间的对局游戏已结束;
  4562. * - 4: 房间已销毁;
  4563. * - 5: 房间连接已建立,等待对战连接建立; */
  4564. roomState: 1 | 2 | 3 | 4 | 5
  4565. /** 游戏随机种子 */
  4566. seed: string
  4567. /** 需要满足百分比的玩家都发送了开始指令才能启动游戏。有效范围 0~100,0 表示只要有一个人调用开始就启动,100 表示要求所有人都开始才能启动。 */
  4568. startPercent: number
  4569. /** UDP可靠性策略, 0:全冗余 N:固定冗余N帧 */
  4570. udpReliabilityStrategy: number
  4571. /** 最近更新时间 */
  4572. updateTimestamp: number
  4573. }
  4574. /** 成员列表 */
  4575. interface RoomMemberInfo {
  4576. /** 用户在房间内的唯一标识 */
  4577. clientId: number
  4578. /** 是否已做好游戏开始准备(调用过 startGame) */
  4579. enableToStart: boolean
  4580. /** 头像 URL(房间 needUserInfo 为 true 时才会有) */
  4581. headimg: string
  4582. /** 玩家准备状态 */
  4583. isReady: boolean
  4584. /** 游戏自定义的关于成员的扩展信息 */
  4585. memberExtInfo: string
  4586. /** 用户昵称(房间 needUserInfo 为 true 时才会有) */
  4587. nickname: string
  4588. /** 座位号,从 0 开始 */
  4589. posNum: number
  4590. /** 角色
  4591. *
  4592. * 可选值:
  4593. * - 0: 普通成员;
  4594. * - 1: 房主; */
  4595. role: 0 | 1
  4596. }
  4597. /** 需要基础库: `2.7.0`
  4598. *
  4599. * 在竖屏正方向下的安全区域 */
  4600. interface SafeArea {
  4601. /** 安全区域右下角纵坐标 */
  4602. bottom: number
  4603. /** 安全区域的高度,单位逻辑像素 */
  4604. height: number
  4605. /** 安全区域左上角横坐标 */
  4606. left: number
  4607. /** 安全区域右下角横坐标 */
  4608. right: number
  4609. /** 安全区域左上角纵坐标 */
  4610. top: number
  4611. /** 安全区域的宽度,单位逻辑像素 */
  4612. width: number
  4613. }
  4614. interface SaveFileFailCallbackResult {
  4615. /** 错误信息
  4616. *
  4617. * 可选值:
  4618. * - 'fail tempFilePath file not exist': 指定的 tempFilePath 找不到文件;
  4619. * - 'fail permission denied, open "${filePath}"': 指定的 filePath 路径没有写权限;
  4620. * - 'fail no such file or directory "${dirPath}"': 上级目录不存在;
  4621. * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
  4622. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  4623. errMsg: string
  4624. }
  4625. interface SaveFileOption {
  4626. /** 临时存储文件路径 (本地路径) */
  4627. tempFilePath: string
  4628. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4629. complete?: SaveFileCompleteCallback
  4630. /** 接口调用失败的回调函数 */
  4631. fail?: SaveFileFailCallback
  4632. /** 要存储的文件路径 (本地路径) */
  4633. filePath?: string
  4634. /** 接口调用成功的回调函数 */
  4635. success?: SaveFileSuccessCallback
  4636. }
  4637. interface SaveFileSuccessCallbackResult {
  4638. /** 存储后的文件路径 (本地路径) */
  4639. savedFilePath: string
  4640. errMsg: string
  4641. }
  4642. interface SaveFileToDiskOption {
  4643. /** 待保存文件路径 */
  4644. filePath: string
  4645. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4646. complete?: SaveFileToDiskCompleteCallback
  4647. /** 接口调用失败的回调函数 */
  4648. fail?: SaveFileToDiskFailCallback
  4649. /** 接口调用成功的回调函数 */
  4650. success?: SaveFileToDiskSuccessCallback
  4651. }
  4652. interface SaveImageToPhotosAlbumOption {
  4653. /** 图片文件路径,可以是临时文件路径或永久文件路径 (本地路径) ,不支持网络路径 */
  4654. filePath: string
  4655. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4656. complete?: SaveImageToPhotosAlbumCompleteCallback
  4657. /** 接口调用失败的回调函数 */
  4658. fail?: SaveImageToPhotosAlbumFailCallback
  4659. /** 接口调用成功的回调函数 */
  4660. success?: SaveImageToPhotosAlbumSuccessCallback
  4661. }
  4662. interface ScanCodeOption {
  4663. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4664. complete?: ScanCodeCompleteCallback
  4665. /** 接口调用失败的回调函数 */
  4666. fail?: ScanCodeFailCallback
  4667. /** 需要基础库: `1.2.0`
  4668. *
  4669. * 是否只能从相机扫码,不允许从相册选择图片 */
  4670. onlyFromCamera?: boolean
  4671. /** 需要基础库: `1.7.0`
  4672. *
  4673. * 扫码类型
  4674. *
  4675. * 可选值:
  4676. * - 'barCode': 一维码;
  4677. * - 'qrCode': 二维码;
  4678. * - 'datamatrix': Data Matrix 码;
  4679. * - 'pdf417': PDF417 条码; */
  4680. scanType?: Array<'barCode' | 'qrCode' | 'datamatrix' | 'pdf417'>
  4681. /** 接口调用成功的回调函数 */
  4682. success?: ScanCodeSuccessCallback
  4683. }
  4684. interface ScanCodeSuccessCallbackResult {
  4685. /** 所扫码的字符集 */
  4686. charSet: string
  4687. /** 当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path */
  4688. path: string
  4689. /** 原始数据,base64编码 */
  4690. rawData: string
  4691. /** 所扫码的内容 */
  4692. result: string
  4693. /** 所扫码的类型
  4694. *
  4695. * 可选值:
  4696. * - 'QR_CODE': 二维码;
  4697. * - 'AZTEC': 一维码;
  4698. * - 'CODABAR': 一维码;
  4699. * - 'CODE_39': 一维码;
  4700. * - 'CODE_93': 一维码;
  4701. * - 'CODE_128': 一维码;
  4702. * - 'DATA_MATRIX': 二维码;
  4703. * - 'EAN_8': 一维码;
  4704. * - 'EAN_13': 一维码;
  4705. * - 'ITF': 一维码;
  4706. * - 'MAXICODE': 一维码;
  4707. * - 'PDF_417': 二维码;
  4708. * - 'RSS_14': 一维码;
  4709. * - 'RSS_EXPANDED': 一维码;
  4710. * - 'UPC_A': 一维码;
  4711. * - 'UPC_E': 一维码;
  4712. * - 'UPC_EAN_EXTENSION': 一维码;
  4713. * - 'WX_CODE': 二维码;
  4714. * - 'CODE_25': 一维码; */
  4715. scanType:
  4716. | 'QR_CODE'
  4717. | 'AZTEC'
  4718. | 'CODABAR'
  4719. | 'CODE_39'
  4720. | 'CODE_93'
  4721. | 'CODE_128'
  4722. | 'DATA_MATRIX'
  4723. | 'EAN_8'
  4724. | 'EAN_13'
  4725. | 'ITF'
  4726. | 'MAXICODE'
  4727. | 'PDF_417'
  4728. | 'RSS_14'
  4729. | 'RSS_EXPANDED'
  4730. | 'UPC_A'
  4731. | 'UPC_E'
  4732. | 'UPC_EAN_EXTENSION'
  4733. | 'WX_CODE'
  4734. | 'CODE_25'
  4735. errMsg: string
  4736. }
  4737. interface SendSocketMessageOption {
  4738. /** 需要发送的内容 */
  4739. data: string | ArrayBuffer
  4740. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4741. complete?: SendSocketMessageCompleteCallback
  4742. /** 接口调用失败的回调函数 */
  4743. fail?: SendSocketMessageFailCallback
  4744. /** 接口调用成功的回调函数 */
  4745. success?: SendSocketMessageSuccessCallback
  4746. }
  4747. interface SetBLEMTUFailCallbackResult {
  4748. /** 最终协商的 MTU 值。如果协商失败则无此参数。安卓客户端 8.0.9 开始支持。 */
  4749. mtu: number
  4750. }
  4751. interface SetBLEMTUOption {
  4752. /** 蓝牙设备 id */
  4753. deviceId: string
  4754. /** 最大传输单元。设置范围为 (22,512) 区间内,单位 bytes */
  4755. mtu: number
  4756. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4757. complete?: SetBLEMTUCompleteCallback
  4758. /** 接口调用失败的回调函数 */
  4759. fail?: SetBLEMTUFailCallback
  4760. /** 接口调用成功的回调函数 */
  4761. success?: SetBLEMTUSuccessCallback
  4762. }
  4763. interface SetBLEMTUSuccessCallbackResult {
  4764. /** 最终协商的 MTU 值,与传入参数一致。安卓客户端 8.0.9 开始支持。 */
  4765. mtu: number
  4766. errMsg: string
  4767. }
  4768. interface SetClipboardDataOption {
  4769. /** 剪贴板的内容 */
  4770. data: string
  4771. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4772. complete?: SetClipboardDataCompleteCallback
  4773. /** 接口调用失败的回调函数 */
  4774. fail?: SetClipboardDataFailCallback
  4775. /** 接口调用成功的回调函数 */
  4776. success?: SetClipboardDataSuccessCallback
  4777. }
  4778. interface SetEnableDebugOption {
  4779. /** 是否打开调试 */
  4780. enableDebug: boolean
  4781. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4782. complete?: SetEnableDebugCompleteCallback
  4783. /** 接口调用失败的回调函数 */
  4784. fail?: SetEnableDebugFailCallback
  4785. /** 接口调用成功的回调函数 */
  4786. success?: SetEnableDebugSuccessCallback
  4787. }
  4788. interface SetInnerAudioOption {
  4789. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4790. complete?: SetInnerAudioOptionCompleteCallback
  4791. /** 接口调用失败的回调函数 */
  4792. fail?: SetInnerAudioOptionFailCallback
  4793. /** 是否与其他音频混播,设置为 true 之后,不会终止其他应用或微信内的音乐 */
  4794. mixWithOther?: boolean
  4795. /** (仅在 iOS 生效)是否遵循静音开关,设置为 false 之后,即使是在静音模式下,也能播放声音 */
  4796. obeyMuteSwitch?: boolean
  4797. /** true 代表用扬声器播放,false 代表听筒播放,默认值为 true。 */
  4798. speakerOn?: boolean
  4799. /** 接口调用成功的回调函数 */
  4800. success?: SetInnerAudioOptionSuccessCallback
  4801. }
  4802. interface SetKeepScreenOnOption {
  4803. /** 是否保持屏幕常亮 */
  4804. keepScreenOn: boolean
  4805. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4806. complete?: SetKeepScreenOnCompleteCallback
  4807. /** 接口调用失败的回调函数 */
  4808. fail?: SetKeepScreenOnFailCallback
  4809. /** 接口调用成功的回调函数 */
  4810. success?: SetKeepScreenOnSuccessCallback
  4811. }
  4812. interface SetMenuStyleOption {
  4813. /** 样式风格
  4814. *
  4815. * 可选值:
  4816. * - 'light': 浅色;
  4817. * - 'dark': 深色; */
  4818. style: 'light' | 'dark'
  4819. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4820. complete?: SetMenuStyleCompleteCallback
  4821. /** 接口调用失败的回调函数 */
  4822. fail?: SetMenuStyleFailCallback
  4823. /** 接口调用成功的回调函数 */
  4824. success?: SetMenuStyleSuccessCallback
  4825. }
  4826. interface SetMessageToFriendQueryOption {
  4827. /** 需要传递的代表场景的数字,需要在 0 - 50 之间 */
  4828. shareMessageToFriendScene: number
  4829. }
  4830. interface SetScreenBrightnessOption {
  4831. /** 屏幕亮度值,范围 0 ~ 1。0 最暗,1 最亮 */
  4832. value: number
  4833. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4834. complete?: SetScreenBrightnessCompleteCallback
  4835. /** 接口调用失败的回调函数 */
  4836. fail?: SetScreenBrightnessFailCallback
  4837. /** 接口调用成功的回调函数 */
  4838. success?: SetScreenBrightnessSuccessCallback
  4839. }
  4840. interface SetStateOption {
  4841. /** 该玩家的自定义状态信息,长度限制为 256 个字符 */
  4842. userState: string
  4843. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4844. complete?: SetStateCompleteCallback
  4845. /** 接口调用失败的回调函数 */
  4846. fail?: SetStateFailCallback
  4847. /** 接口调用成功的回调函数 */
  4848. success?: SetStateSuccessCallback
  4849. }
  4850. interface SetStatusBarStyleOption {
  4851. /** 样式风格
  4852. *
  4853. * 可选值:
  4854. * - 'white': 白色;
  4855. * - 'black': 浅色; */
  4856. style: 'white' | 'black'
  4857. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4858. complete?: SetStatusBarStyleCompleteCallback
  4859. /** 接口调用失败的回调函数 */
  4860. fail?: SetStatusBarStyleFailCallback
  4861. /** 接口调用成功的回调函数 */
  4862. success?: SetStatusBarStyleSuccessCallback
  4863. }
  4864. interface SetStorageOption<T = any> {
  4865. /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
  4866. data: T
  4867. /** 本地缓存中指定的 key */
  4868. key: string
  4869. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4870. complete?: SetStorageCompleteCallback
  4871. /** 需要基础库: `2.21.3`
  4872. *
  4873. * 是否开启加密存储。只有异步的 setStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 加密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true。此外,由于加密后的数据会比原始数据膨胀1.4倍,因此开启 encrypt 的情况下,单个 key 允许存储的最大数据长度为 0.7MB,所有数据存储上限为 7.1MB */
  4874. encrypt?: boolean
  4875. /** 接口调用失败的回调函数 */
  4876. fail?: SetStorageFailCallback
  4877. /** 接口调用成功的回调函数 */
  4878. success?: SetStorageSuccessCallback
  4879. }
  4880. interface SetUserCloudStorageOption {
  4881. /** 要修改的 KV 数据列表 */
  4882. KVDataList: KVData[]
  4883. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4884. complete?: SetUserCloudStorageCompleteCallback
  4885. /** 接口调用失败的回调函数 */
  4886. fail?: SetUserCloudStorageFailCallback
  4887. /** 接口调用成功的回调函数 */
  4888. success?: SetUserCloudStorageSuccessCallback
  4889. }
  4890. interface SetWindowSizeOption {
  4891. /** 窗口高度,以像素为单位 */
  4892. height: number
  4893. /** 窗口宽度,以像素为单位 */
  4894. width: number
  4895. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4896. complete?: SetWindowSizeCompleteCallback
  4897. /** 接口调用失败的回调函数 */
  4898. fail?: SetWindowSizeFailCallback
  4899. /** 接口调用成功的回调函数 */
  4900. success?: SetWindowSizeSuccessCallback
  4901. }
  4902. /** 对局回放的分享参数。 */
  4903. interface Share {
  4904. /** 对局回放的剪辑区间,是一个二维数组,单位 ms(毫秒)。[[1000, 3000], [4000, 5000]] 表示剪辑已录制对局回放的 1-3 秒和 4-5 秒最终合成为一个 3 秒的对局回放。对局回放剪辑后的总时长最多 60 秒,即 1 分钟。 */
  4905. timeRange: number[]
  4906. /** 需要基础库: `2.9.2`
  4907. *
  4908. * 对局回放的播放速率,只能设置以下几个值:0.3,0.5,1,1.5,2,2.5,3。其中1表示原速播放,小于1表示减速播放,大于1表示加速播放。 */
  4909. atempo?: number
  4910. /** 需要基础库: `2.10.0`
  4911. *
  4912. * 如果原始视频文件中有音频,是否与新传入的bgm混音,默认为false,表示不混音,只保留一个音轨,值为true时表示原始音频与传入的bgm混音。 */
  4913. audioMix?: boolean
  4914. /** 对局回放背景音乐的地址。必须是一个代码包文件路径或者 wxfile:// 文件路径,不支持 http/https 开头的 url。 */
  4915. bgm?: string
  4916. /** 对局回放的按钮的配置。对局回放按钮的文案不能随意设置,只能选择预设的文案模版。 */
  4917. button?: ButtonShare
  4918. /** 需要基础库: `2.13.2`
  4919. *
  4920. * 分享的对局回放打开后跳转小游戏的 path (独立分包路径)。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
  4921. path?: string
  4922. /** 分享的对局回放打开后跳转小游戏的 query。 */
  4923. query?: string
  4924. /** 对局回放的标题的配置。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
  4925. title?: TitleShare
  4926. /** 需要基础库: `2.9.2`
  4927. *
  4928. * 对局回放的音量大小,最小 0,最大 1。 */
  4929. volume?: number
  4930. }
  4931. interface ShareAppMessageOption {
  4932. /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
  4933. imageUrl?: string
  4934. /** 需要基础库: `2.4.3`
  4935. *
  4936. * 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
  4937. imageUrlId?: string
  4938. /** 需要基础库: `2.12.2`
  4939. *
  4940. * 独立分包路径。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
  4941. path?: string
  4942. /** 查询字符串,从这条转发消息进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。必须是 key1=val1&key2=val2 的格式。 */
  4943. query?: string
  4944. /** 转发标题,不传则默认使用当前小游戏的昵称。 */
  4945. title?: string
  4946. /** 需要基础库: `2.12.2`
  4947. *
  4948. * 是否转发到当前群。该参数只对从群工具栏打开的场景下生效,默认转发到当前群,填入false时可转发到其他会话。 */
  4949. toCurrentGroup?: boolean
  4950. }
  4951. interface ShareMessageToFriendOption {
  4952. /** 发送对象的 openId */
  4953. openId: string
  4954. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  4955. complete?: ShareMessageToFriendCompleteCallback
  4956. /** 接口调用失败的回调函数 */
  4957. fail?: ShareMessageToFriendFailCallback
  4958. /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
  4959. imageUrl?: string
  4960. /** 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
  4961. imageUrlId?: string
  4962. /** 接口调用成功的回调函数 */
  4963. success?: ShareMessageToFriendSuccessCallback
  4964. /** 转发标题,不传则默认使用当前小游戏的昵称。 */
  4965. title?: string
  4966. }
  4967. /** 对局回放的分享参数。 */
  4968. interface ShareOption {
  4969. /** 对局回放背景音乐的地址。必须是一个代码包文件路径或者 wxfile:// 文件路径,不支持 http/https 开头的 url。 */
  4970. bgm: string
  4971. /** 对局回放的剪辑区间,是一个二维数组,单位 ms(毫秒)。[[1000, 3000], [4000, 5000]] 表示剪辑已录制对局回放的 1-3 秒和 4-5 秒最终合成为一个 3 秒的对局回放。对局回放剪辑后的总时长最多 60 秒,即 1 分钟。 */
  4972. timeRange: number[]
  4973. /** 需要基础库: `2.9.2`
  4974. *
  4975. * 对局回放的播放速率,只能设置以下几个值:0.3,0.5,1,1.5,2,2.5,3。其中1表示原速播放,小于1表示减速播放,大于1表示加速播放。 */
  4976. atempo?: number
  4977. /** 需要基础库: `2.10.0`
  4978. *
  4979. * 如果原始视频文件中有音频,是否与新传入的bgm混音,默认为false,表示不混音,只保留一个音轨,值为true时表示原始音频与传入的bgm混音。 */
  4980. audioMix?: boolean
  4981. /** 对局回放的按钮。只能选择预设的文案模版。 */
  4982. button?: ButtonShareOption
  4983. /** 需要基础库: `2.13.2`
  4984. *
  4985. * 分享的对局回放打开后跳转小游戏的 path (独立分包路径)。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
  4986. path?: string
  4987. /** 分享的对局回放打开后跳转小游戏的 query。 */
  4988. query?: string
  4989. /** 对局回放的标题。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
  4990. title?: TitleShareOption
  4991. /** 需要基础库: `2.9.2`
  4992. *
  4993. * 对局回放的音量大小,最小 0,最大 1。 */
  4994. volume?: number
  4995. }
  4996. interface ShowActionSheetOption {
  4997. /** 按钮的文字数组,数组长度最大为 6 */
  4998. itemList: string[]
  4999. /** 需要基础库: `2.14.0`
  5000. *
  5001. * 警示文案 */
  5002. alertText?: string
  5003. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5004. complete?: ShowActionSheetCompleteCallback
  5005. /** 接口调用失败的回调函数 */
  5006. fail?: ShowActionSheetFailCallback
  5007. /** 按钮的文字颜色 */
  5008. itemColor?: string
  5009. /** 接口调用成功的回调函数 */
  5010. success?: ShowActionSheetSuccessCallback
  5011. }
  5012. interface ShowActionSheetSuccessCallbackResult {
  5013. /** 用户点击的按钮序号,从上到下的顺序,从0开始 */
  5014. tapIndex: number
  5015. errMsg: string
  5016. }
  5017. interface ShowKeyboardOption {
  5018. /** 当点击完成时键盘是否收起 */
  5019. confirmHold: boolean
  5020. /** 键盘右下角 confirm 按钮的类型,只影响按钮的文本内容
  5021. *
  5022. * 可选值:
  5023. * - 'done': 完成;
  5024. * - 'next': 下一个;
  5025. * - 'search': 搜索;
  5026. * - 'go': 前往;
  5027. * - 'send': 发送; */
  5028. confirmType: 'done' | 'next' | 'search' | 'go' | 'send'
  5029. /** 键盘输入框显示的默认值 */
  5030. defaultValue: string
  5031. /** 键盘中文本的最大长度 */
  5032. maxLength: number
  5033. /** 是否为多行输入 */
  5034. multiple: boolean
  5035. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5036. complete?: ShowKeyboardCompleteCallback
  5037. /** 接口调用失败的回调函数 */
  5038. fail?: ShowKeyboardFailCallback
  5039. /** 接口调用成功的回调函数 */
  5040. success?: ShowKeyboardSuccessCallback
  5041. }
  5042. interface ShowLoadingOption {
  5043. /** 提示的内容 */
  5044. title: string
  5045. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5046. complete?: ShowLoadingCompleteCallback
  5047. /** 接口调用失败的回调函数 */
  5048. fail?: ShowLoadingFailCallback
  5049. /** 是否显示透明蒙层,防止触摸穿透 */
  5050. mask?: boolean
  5051. /** 接口调用成功的回调函数 */
  5052. success?: ShowLoadingSuccessCallback
  5053. }
  5054. interface ShowModalOption {
  5055. /** 取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
  5056. cancelColor?: string
  5057. /** 取消按钮的文字,最多 4 个字符 */
  5058. cancelText?: string
  5059. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5060. complete?: ShowModalCompleteCallback
  5061. /** 确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
  5062. confirmColor?: string
  5063. /** 确认按钮的文字,最多 4 个字符 */
  5064. confirmText?: string
  5065. /** 提示的内容 */
  5066. content?: string
  5067. /** 需要基础库: `2.17.1`
  5068. *
  5069. * 是否显示输入框 */
  5070. editable?: boolean
  5071. /** 接口调用失败的回调函数 */
  5072. fail?: ShowModalFailCallback
  5073. /** 需要基础库: `2.17.1`
  5074. *
  5075. * 显示输入框时的提示文本 */
  5076. placeholderText?: string
  5077. /** 是否显示取消按钮 */
  5078. showCancel?: boolean
  5079. /** 接口调用成功的回调函数 */
  5080. success?: ShowModalSuccessCallback
  5081. /** 提示的标题 */
  5082. title?: string
  5083. }
  5084. interface ShowModalSuccessCallbackResult {
  5085. /** 需要基础库: `1.1.0`
  5086. *
  5087. * 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) */
  5088. cancel: boolean
  5089. /** 为 true 时,表示用户点击了确定按钮 */
  5090. confirm: boolean
  5091. /** editable 为 true 时,用户输入的文本 */
  5092. content: string
  5093. errMsg: string
  5094. }
  5095. interface ShowShareImageMenuOption {
  5096. /** 要分享的图片地址,必须为本地路径或临时路径 */
  5097. path: string
  5098. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5099. complete?: ShowShareImageMenuCompleteCallback
  5100. /** 接口调用失败的回调函数 */
  5101. fail?: ShowShareImageMenuFailCallback
  5102. /** 接口调用成功的回调函数 */
  5103. success?: ShowShareImageMenuSuccessCallback
  5104. }
  5105. interface ShowShareMenuOption {
  5106. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5107. complete?: ShowShareMenuCompleteCallback
  5108. /** 接口调用失败的回调函数 */
  5109. fail?: ShowShareMenuFailCallback
  5110. /** 需要基础库: `2.11.3`
  5111. *
  5112. * 本接口为 Beta 版本,暂只在 Android 平台支持。需要显示的转发按钮名称列表,默认['shareAppMessage']。按钮名称合法值包含 "shareAppMessage"、"shareTimeline" 两种 */
  5113. menus?: string[]
  5114. /** 接口调用成功的回调函数 */
  5115. success?: ShowShareMenuSuccessCallback
  5116. /** 是否使用带 shareTicket 的转发[详情](#) */
  5117. withShareTicket?: boolean
  5118. }
  5119. interface ShowToastOption {
  5120. /** 提示的内容 */
  5121. title: string
  5122. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5123. complete?: ShowToastCompleteCallback
  5124. /** 提示的延迟时间 */
  5125. duration?: number
  5126. /** 接口调用失败的回调函数 */
  5127. fail?: ShowToastFailCallback
  5128. /** 图标
  5129. *
  5130. * 可选值:
  5131. * - 'success': 显示成功图标,此时 title 文本最多显示 7 个汉字长度;
  5132. * - 'error': 显示失败图标,此时 title 文本最多显示 7 个汉字长度;
  5133. * - 'loading': 显示加载图标,此时 title 文本最多显示 7 个汉字长度;
  5134. * - 'none': 不显示图标,此时 title 文本最多可显示两行,[1.9.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)及以上版本支持; */
  5135. icon?: 'success' | 'error' | 'loading' | 'none'
  5136. /** 需要基础库: `1.1.0`
  5137. *
  5138. * 自定义图标的本地路径,image 的优先级高于 icon */
  5139. image?: string
  5140. /** 是否显示透明蒙层,防止触摸穿透 */
  5141. mask?: boolean
  5142. /** 接口调用成功的回调函数 */
  5143. success?: ShowToastSuccessCallback
  5144. }
  5145. /** 需要基础库: `2.10.4`
  5146. *
  5147. * 网络请求过程中一些调试信息 */
  5148. interface SocketProfile {
  5149. /** 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过 */
  5150. connectEnd: number
  5151. /** 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间 */
  5152. connectStart: number
  5153. /** 上层请求到返回的耗时 */
  5154. cost: number
  5155. /** DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
  5156. domainLookupEnd: number
  5157. /** DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
  5158. domainLookupStart: number
  5159. /** 组件准备好使用 SOCKET 建立请求的时间,这发生在检查本地缓存之前 */
  5160. fetchStart: number
  5161. /** 握手耗时 */
  5162. handshakeCost: number
  5163. /** 单次连接的耗时,包括 connect ,tls */
  5164. rtt: number
  5165. }
  5166. interface SocketTaskCloseOption {
  5167. /** 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 */
  5168. code?: number
  5169. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5170. complete?: CloseCompleteCallback
  5171. /** 接口调用失败的回调函数 */
  5172. fail?: SocketTaskCloseFailCallback
  5173. /** 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。 */
  5174. reason?: string
  5175. /** 接口调用成功的回调函数 */
  5176. success?: CloseSuccessCallback
  5177. }
  5178. interface SocketTaskOnCloseCallbackResult {
  5179. /** 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 */
  5180. code: number
  5181. /** 一个可读的字符串,表示连接被关闭的原因。 */
  5182. reason: string
  5183. }
  5184. interface SocketTaskOnMessageCallbackResult {
  5185. /** 服务器返回的消息 */
  5186. data: string | ArrayBuffer
  5187. }
  5188. interface SocketTaskSendOption {
  5189. /** 需要发送的内容 */
  5190. data: string | ArrayBuffer
  5191. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5192. complete?: SendCompleteCallback
  5193. /** 接口调用失败的回调函数 */
  5194. fail?: SendFailCallback
  5195. /** 接口调用成功的回调函数 */
  5196. success?: SendSuccessCallback
  5197. }
  5198. interface StartAccelerometerOption {
  5199. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5200. complete?: StartAccelerometerCompleteCallback
  5201. /** 接口调用失败的回调函数 */
  5202. fail?: StartAccelerometerFailCallback
  5203. /** 需要基础库: `2.1.0`
  5204. *
  5205. * 监听加速度数据回调函数的执行频率
  5206. *
  5207. * 可选值:
  5208. * - 'game': 适用于更新游戏的回调频率,在 20ms/次 左右;
  5209. * - 'ui': 适用于更新 UI 的回调频率,在 60ms/次 左右;
  5210. * - 'normal': 普通的回调频率,在 200ms/次 左右; */
  5211. interval?: 'game' | 'ui' | 'normal'
  5212. /** 接口调用成功的回调函数 */
  5213. success?: StartAccelerometerSuccessCallback
  5214. }
  5215. interface StartAdvertisingObject {
  5216. /** 广播自定义参数 */
  5217. advertiseRequest: AdvertiseReqObj
  5218. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5219. complete?: StartAdvertisingCompleteCallback
  5220. /** 接口调用失败的回调函数 */
  5221. fail?: StartAdvertisingFailCallback
  5222. /** 广播功率
  5223. *
  5224. * 可选值:
  5225. * - 'low': 功率低;
  5226. * - 'medium': 功率适中;
  5227. * - 'high': 功率高; */
  5228. powerLevel?: 'low' | 'medium' | 'high'
  5229. /** 接口调用成功的回调函数 */
  5230. success?: StartAdvertisingSuccessCallback
  5231. }
  5232. interface StartBeaconDiscoveryOption {
  5233. /** Beacon 设备广播的 UUID 列表 */
  5234. uuids: string[]
  5235. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5236. complete?: StartBeaconDiscoveryCompleteCallback
  5237. /** 接口调用失败的回调函数 */
  5238. fail?: StartBeaconDiscoveryFailCallback
  5239. /** 是否校验蓝牙开关,仅在 iOS 下有效。iOS 11 起,控制面板里关掉蓝牙,还是能继续使用 Beacon 服务。 */
  5240. ignoreBluetoothAvailable?: boolean
  5241. /** 接口调用成功的回调函数 */
  5242. success?: StartBeaconDiscoverySuccessCallback
  5243. }
  5244. interface StartBluetoothDevicesDiscoveryOption {
  5245. /** 是否允许重复上报同一设备。如果允许重复上报,则 [wx.onBlueToothDeviceFound](#) 方法会多次上报同一设备,但是 RSSI 值会有不同。 */
  5246. allowDuplicatesKey?: boolean
  5247. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5248. complete?: StartBluetoothDevicesDiscoveryCompleteCallback
  5249. /** 接口调用失败的回调函数 */
  5250. fail?: StartBluetoothDevicesDiscoveryFailCallback
  5251. /** 上报设备的间隔,单位 ms。0 表示找到新设备立即上报,其他数值根据传入的间隔上报。 */
  5252. interval?: number
  5253. /** 扫描模式,越高扫描越快,也越耗电。仅安卓微信客户端 7.0.12 及以上支持。
  5254. *
  5255. * 可选值:
  5256. * - 'low': 低;
  5257. * - 'medium': 中;
  5258. * - 'high': 高; */
  5259. powerLevel?: 'low' | 'medium' | 'high'
  5260. /** 要搜索的蓝牙设备主服务的 UUID 列表(支持 16/32/128 位 UUID)。某些蓝牙设备会广播自己的主 service 的 UUID。如果设置此参数,则只搜索广播包有对应 UUID 的主服务的蓝牙设备。建议通过该参数过滤掉周边不需要处理的其他蓝牙设备。 */
  5261. services?: string[]
  5262. /** 接口调用成功的回调函数 */
  5263. success?: StartBluetoothDevicesDiscoverySuccessCallback
  5264. }
  5265. interface StartCompassOption {
  5266. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5267. complete?: StartCompassCompleteCallback
  5268. /** 接口调用失败的回调函数 */
  5269. fail?: StartCompassFailCallback
  5270. /** 接口调用成功的回调函数 */
  5271. success?: StartCompassSuccessCallback
  5272. }
  5273. interface StartDeviceMotionListeningOption {
  5274. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5275. complete?: StartDeviceMotionListeningCompleteCallback
  5276. /** 接口调用失败的回调函数 */
  5277. fail?: StartDeviceMotionListeningFailCallback
  5278. /** 监听设备方向的变化回调函数的执行频率
  5279. *
  5280. * 可选值:
  5281. * - 'game': 适用于更新游戏的回调频率,在 20ms/次 左右;
  5282. * - 'ui': 适用于更新 UI 的回调频率,在 60ms/次 左右;
  5283. * - 'normal': 普通的回调频率,在 200ms/次 左右; */
  5284. interval?: 'game' | 'ui' | 'normal'
  5285. /** 接口调用成功的回调函数 */
  5286. success?: StartDeviceMotionListeningSuccessCallback
  5287. }
  5288. interface StartGameOption {
  5289. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5290. complete?: StartGameCompleteCallback
  5291. /** 接口调用失败的回调函数 */
  5292. fail?: StartGameFailCallback
  5293. /** 接口调用成功的回调函数 */
  5294. success?: StartGameSuccessCallback
  5295. }
  5296. interface StartGyroscopeOption {
  5297. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5298. complete?: StartGyroscopeCompleteCallback
  5299. /** 接口调用失败的回调函数 */
  5300. fail?: StartGyroscopeFailCallback
  5301. /** 监听陀螺仪数据回调函数的执行频率
  5302. *
  5303. * 可选值:
  5304. * - 'game': 适用于更新游戏的回调频率,在 20ms/次 左右;
  5305. * - 'ui': 适用于更新 UI 的回调频率,在 60ms/次 左右;
  5306. * - 'normal': 普通的回调频率,在 200ms/次 左右; */
  5307. interval?: 'game' | 'ui' | 'normal'
  5308. /** 接口调用成功的回调函数 */
  5309. success?: StartGyroscopeSuccessCallback
  5310. }
  5311. interface StartHandoffOption {
  5312. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5313. complete?: StartHandoffCompleteCallback
  5314. /** 接口调用失败的回调函数 */
  5315. fail?: StartHandoffFailCallback
  5316. /** 接口调用成功的回调函数 */
  5317. success?: StartHandoffSuccessCallback
  5318. }
  5319. interface StartMatchOption {
  5320. /** 通过后台接口申请的matchId */
  5321. matchId: string
  5322. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5323. complete?: StartMatchCompleteCallback
  5324. /** 接口调用失败的回调函数 */
  5325. fail?: StartMatchFailCallback
  5326. /** 补充类型,0:自动补充队友 1:不补充队友 */
  5327. fillType?: number
  5328. /** 接口调用成功的回调函数 */
  5329. success?: StartMatchSuccessCallback
  5330. }
  5331. interface StartStateServiceOption {
  5332. /** 该玩家的自定义状态信息,长度限制为 256 个字符 */
  5333. userState: string
  5334. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5335. complete?: StartStateServiceCompleteCallback
  5336. /** 接口调用失败的回调函数 */
  5337. fail?: StartStateServiceFailCallback
  5338. /** 接口调用成功的回调函数 */
  5339. success?: StartStateServiceSuccessCallback
  5340. }
  5341. interface StatFailCallbackResult {
  5342. /** 错误信息
  5343. *
  5344. * 可选值:
  5345. * - 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;
  5346. * - 'fail no such file or directory ${path}': 文件不存在;
  5347. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  5348. errMsg: string
  5349. }
  5350. interface StatOption {
  5351. /** 文件/目录路径 (本地路径) */
  5352. path: string
  5353. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5354. complete?: StatCompleteCallback
  5355. /** 接口调用失败的回调函数 */
  5356. fail?: StatFailCallback
  5357. /** 需要基础库: `2.3.0`
  5358. *
  5359. * 是否递归获取目录下的每个文件的 Stats 信息 */
  5360. recursive?: boolean
  5361. /** 接口调用成功的回调函数 */
  5362. success?: StatSuccessCallback
  5363. }
  5364. interface StatSuccessCallbackResult {
  5365. /** [Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)|Array.&lt;[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)&gt;
  5366. *
  5367. * 当 recursive 为 false 时,res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时,res.stats 是一个 Array,数组的每一项是一个对象,每个对象包含 path 和 stats。 */
  5368. stats: Stats | Stats[]
  5369. errMsg: string
  5370. }
  5371. /** 好友状态信息列表 */
  5372. interface StateData {
  5373. /** 好友头像 */
  5374. avatarUrl: string
  5375. /** 好友性别 0未设置 1男 2女 */
  5376. gender: number
  5377. /** 好友昵称 */
  5378. nickName: string
  5379. /** 好友 openId */
  5380. openid: string
  5381. /** 系统状态,0 掉线 1 在线 */
  5382. sysState: number
  5383. /** 该玩家的自定义状态信息,通过 `GameServerManager.setState` 接口设置 */
  5384. userState: string
  5385. }
  5386. /** 描述文件状态的对象 */
  5387. interface Stats {
  5388. /** 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime */
  5389. lastAccessedTime: number
  5390. /** 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime */
  5391. lastModifiedTime: number
  5392. /** 文件的类型和存取的权限,对应 POSIX stat.st_mode */
  5393. mode: string
  5394. /** 文件大小,单位:B,对应 POSIX stat.st_size */
  5395. size: number
  5396. }
  5397. interface StopAccelerometerOption {
  5398. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5399. complete?: StopAccelerometerCompleteCallback
  5400. /** 接口调用失败的回调函数 */
  5401. fail?: StopAccelerometerFailCallback
  5402. /** 接口调用成功的回调函数 */
  5403. success?: StopAccelerometerSuccessCallback
  5404. }
  5405. interface StopAdvertisingOption {
  5406. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5407. complete?: StopAdvertisingCompleteCallback
  5408. /** 接口调用失败的回调函数 */
  5409. fail?: StopAdvertisingFailCallback
  5410. /** 接口调用成功的回调函数 */
  5411. success?: StopAdvertisingSuccessCallback
  5412. }
  5413. interface StopBeaconDiscoveryOption {
  5414. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5415. complete?: StopBeaconDiscoveryCompleteCallback
  5416. /** 接口调用失败的回调函数 */
  5417. fail?: StopBeaconDiscoveryFailCallback
  5418. /** 接口调用成功的回调函数 */
  5419. success?: StopBeaconDiscoverySuccessCallback
  5420. }
  5421. interface StopBluetoothDevicesDiscoveryOption {
  5422. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5423. complete?: StopBluetoothDevicesDiscoveryCompleteCallback
  5424. /** 接口调用失败的回调函数 */
  5425. fail?: StopBluetoothDevicesDiscoveryFailCallback
  5426. /** 接口调用成功的回调函数 */
  5427. success?: StopBluetoothDevicesDiscoverySuccessCallback
  5428. }
  5429. interface StopCompassOption {
  5430. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5431. complete?: StopCompassCompleteCallback
  5432. /** 接口调用失败的回调函数 */
  5433. fail?: StopCompassFailCallback
  5434. /** 接口调用成功的回调函数 */
  5435. success?: StopCompassSuccessCallback
  5436. }
  5437. interface StopDeviceMotionListeningOption {
  5438. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5439. complete?: StopDeviceMotionListeningCompleteCallback
  5440. /** 接口调用失败的回调函数 */
  5441. fail?: StopDeviceMotionListeningFailCallback
  5442. /** 接口调用成功的回调函数 */
  5443. success?: StopDeviceMotionListeningSuccessCallback
  5444. }
  5445. interface StopFaceDetectOption {
  5446. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5447. complete?: StopFaceDetectCompleteCallback
  5448. /** 接口调用失败的回调函数 */
  5449. fail?: StopFaceDetectFailCallback
  5450. /** 接口调用成功的回调函数 */
  5451. success?: StopFaceDetectSuccessCallback
  5452. }
  5453. interface StopGyroscopeOption {
  5454. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5455. complete?: StopGyroscopeCompleteCallback
  5456. /** 接口调用失败的回调函数 */
  5457. fail?: StopGyroscopeFailCallback
  5458. /** 接口调用成功的回调函数 */
  5459. success?: StopGyroscopeSuccessCallback
  5460. }
  5461. /** 单个游戏icon的位置和样式信息 */
  5462. interface StyleItem {
  5463. /** 游戏名称是否隐藏 */
  5464. appNameHidden: boolean
  5465. /** 游戏icon的border颜色色值 */
  5466. borderColor: string
  5467. /** 游戏icon的border尺寸 */
  5468. borderWidth: number
  5469. /** 游戏名称的颜色色值 */
  5470. color: string
  5471. /** 游戏icon的X轴坐标 */
  5472. left: number
  5473. /** 游戏icon的宽高值 */
  5474. size: number
  5475. /** 游戏icon的Y轴坐标 */
  5476. top: number
  5477. }
  5478. /** 订阅消息设置
  5479. *
  5480. * **示例代码**
  5481. *
  5482. * ```javascript
  5483. wx.getSetting({
  5484. withSubscriptions: true,
  5485. success (res) {
  5486. console.log(res.authSetting)
  5487. // res.authSetting = {
  5488. // "scope.userInfo": true,
  5489. // "scope.userLocation": true
  5490. // }
  5491. console.log(res.subscriptionsSetting)
  5492. // res.subscriptionsSetting = {
  5493. // mainSwitch: true, // 订阅消息总开关
  5494. // itemSettings: { // 每一项开关
  5495. // SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息
  5496. // SYS_MSG_TYPE_RANK: 'accept'
  5497. // zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息
  5498. // ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban',
  5499. // }
  5500. // }
  5501. }
  5502. })
  5503. ``` */
  5504. interface SubscriptionsSetting {
  5505. /** 订阅消息总开关,true为开启,false为关闭 */
  5506. mainSwitch: boolean
  5507. /** 每一项订阅消息的订阅状态。itemSettings对象的键为**一次性订阅消息的模板id**或**系统订阅消息的类型**,值为'accept'、'reject'、'ban'中的其中一种。'accept'表示用户同意订阅这条消息,'reject'表示用户拒绝订阅这条消息,'ban'表示已被后台封禁。一次性订阅消息使用方法详见 [wx.requestSubscribeMessage](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html),永久订阅消息(仅小游戏可用)使用方法详见[wx.requestSubscribeSystemMessage](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeSystemMessage.html)
  5508. * ## 注意事项
  5509. * - itemSettings 只返回用户勾选过订阅面板中的“总是保持以上选择,不再询问”的订阅消息。 */
  5510. itemSettings?: IAnyObject
  5511. }
  5512. interface SystemInfo {
  5513. /** 需要基础库: `1.1.0`
  5514. *
  5515. * 客户端基础库版本 */
  5516. SDKVersion: string
  5517. /** 需要基础库: `2.6.0`
  5518. *
  5519. * 允许微信使用相册的开关(仅 iOS 有效) */
  5520. albumAuthorized: boolean
  5521. /** 需要基础库: `1.8.0`
  5522. *
  5523. * 设备性能等级(仅 Android)。取值为:-2 或 0(该设备无法运行小游戏),-1(性能未知),>=1(设备性能值,该值越高,设备性能越好,目前最高不到50) */
  5524. benchmarkLevel: number
  5525. /** 需要基础库: `2.6.0`
  5526. *
  5527. * 蓝牙的系统开关 */
  5528. bluetoothEnabled: boolean
  5529. /** 需要基础库: `1.5.0`
  5530. *
  5531. * 设备品牌 */
  5532. brand: string
  5533. /** 需要基础库: `2.6.0`
  5534. *
  5535. * 允许微信使用摄像头的开关 */
  5536. cameraAuthorized: boolean
  5537. /** 设备方向
  5538. *
  5539. * 可选值:
  5540. * - 'portrait': 竖屏;
  5541. * - 'landscape': 横屏; */
  5542. deviceOrientation: 'portrait' | 'landscape'
  5543. /** 需要基础库: `2.15.0`
  5544. *
  5545. * 是否已打开调试。可通过右上角菜单或 [wx.setEnableDebug](https://developers.weixin.qq.com/minigame/dev/api/base/debug/wx.setEnableDebug.html) 打开调试。 */
  5546. enableDebug: boolean
  5547. /** 需要基础库: `1.5.0`
  5548. *
  5549. * 用户字体大小(单位px)。以微信客户端「我-设置-通用-字体大小」中的设置为准 */
  5550. fontSizeSetting: number
  5551. /** 需要基础库: `2.12.3`
  5552. *
  5553. * 当前小程序运行的宿主环境 */
  5554. host: Host
  5555. /** 微信设置的语言 */
  5556. language: string
  5557. /** 需要基础库: `2.6.0`
  5558. *
  5559. * 允许微信使用定位的开关 */
  5560. locationAuthorized: boolean
  5561. /** 需要基础库: `2.6.0`
  5562. *
  5563. * 地理位置的系统开关 */
  5564. locationEnabled: boolean
  5565. /** `true` 表示模糊定位,`false` 表示精确定位,仅 iOS 支持 */
  5566. locationReducedAccuracy: boolean
  5567. /** 需要基础库: `2.6.0`
  5568. *
  5569. * 允许微信使用麦克风的开关 */
  5570. microphoneAuthorized: boolean
  5571. /** 设备型号。新机型刚推出一段时间会显示unknown,微信会尽快进行适配。 */
  5572. model: string
  5573. /** 需要基础库: `2.6.0`
  5574. *
  5575. * 允许微信通知带有提醒的开关(仅 iOS 有效) */
  5576. notificationAlertAuthorized: boolean
  5577. /** 需要基础库: `2.6.0`
  5578. *
  5579. * 允许微信通知的开关 */
  5580. notificationAuthorized: boolean
  5581. /** 需要基础库: `2.6.0`
  5582. *
  5583. * 允许微信通知带有标记的开关(仅 iOS 有效) */
  5584. notificationBadgeAuthorized: boolean
  5585. /** 需要基础库: `2.6.0`
  5586. *
  5587. * 允许微信通知带有声音的开关(仅 iOS 有效) */
  5588. notificationSoundAuthorized: boolean
  5589. /** 需要基础库: `2.19.3`
  5590. *
  5591. * 允许微信使用日历的开关 */
  5592. phoneCalendarAuthorized: boolean
  5593. /** 设备像素比 */
  5594. pixelRatio: number
  5595. /** 客户端平台 */
  5596. platform: string
  5597. /** 需要基础库: `2.7.0`
  5598. *
  5599. * 在竖屏正方向下的安全区域 */
  5600. safeArea: SafeArea
  5601. /** 需要基础库: `1.1.0`
  5602. *
  5603. * 屏幕高度,单位px */
  5604. screenHeight: number
  5605. /** 需要基础库: `1.1.0`
  5606. *
  5607. * 屏幕宽度,单位px */
  5608. screenWidth: number
  5609. /** 需要基础库: `1.9.0`
  5610. *
  5611. * 状态栏的高度,单位px */
  5612. statusBarHeight: number
  5613. /** 操作系统及版本 */
  5614. system: string
  5615. /** 微信版本号 */
  5616. version: string
  5617. /** 需要基础库: `2.6.0`
  5618. *
  5619. * Wi-Fi 的系统开关 */
  5620. wifiEnabled: boolean
  5621. /** 可使用窗口高度,单位px */
  5622. windowHeight: number
  5623. /** 可使用窗口宽度,单位px */
  5624. windowWidth: number
  5625. /** 需要基础库: `2.11.0`
  5626. *
  5627. * 系统当前主题,取值为`light`或`dark`,全局配置`"darkmode":true`时才能获取,否则为 undefined (不支持小游戏)
  5628. *
  5629. * 可选值:
  5630. * - 'dark': 深色主题;
  5631. * - 'light': 浅色主题; */
  5632. theme?: 'dark' | 'light'
  5633. }
  5634. /** 对局回放的标题的配置。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
  5635. interface TitleShare {
  5636. /** 对局回放的标题的模版参数。 */
  5637. data?: IAnyObject
  5638. /** 对局回放的标题的模版。不传则为:${用户昵称} 在 ${游戏名称} 的游戏时刻
  5639. *
  5640. * 可选值:
  5641. * - 'default.score': 模版格式为,《小游戏名称》,本局得分:${score},对应的 data 应该如 { score: 4500 };
  5642. * - 'default.level': 模版格式为,《小游戏名称》,当前关卡:第42关,对应的 data 应该如 { level: 23 };
  5643. * - 'default.opponent': 模版格式为,《小游戏名称》,本局对手:${opponent},对应的 data 应该如 { opponent_openid: 'oC6J75Sh1_4K8Mf5b1mlgDkMPhoI' };
  5644. * - 'default.cost': 模版格式为,《小游戏名称》,本局耗时:${cost}秒,对应的 data 应该如 { cost_seconds: 123 }; */
  5645. template?:
  5646. | 'default.score'
  5647. | 'default.level'
  5648. | 'default.opponent'
  5649. | 'default.cost'
  5650. }
  5651. /** 对局回放的标题。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
  5652. interface TitleShareOption {
  5653. /** 对局回放的标题的模版参数。 */
  5654. data?: IAnyObject
  5655. /** 对局回放的标题的模版。不传则为:${用户昵称} 在 ${游戏名称} 的游戏时刻
  5656. *
  5657. * 可选值:
  5658. * - 'default.score': 模版格式为,${游戏名称},本局得分:${score},对应的 data 应该如 { score: 4500 };
  5659. * - 'default.level': 模版格式为,${游戏名称},当前关卡:第42关,对应的 data 应该如 { level: 23 };
  5660. * - 'default.opponent': 模版格式为,${游戏名称},本局对手:${opponent},对应的 data 应该如 { opponent_openid: 'oC6J75Sh1_4K8Mf5b1mlgDkMPhoI' };
  5661. * - 'default.cost': 模版格式为,${游戏名称},本局耗时:${cost}秒,对应的 data 应该如 { cost_seconds: 123 }; */
  5662. template?:
  5663. | 'default.score'
  5664. | 'default.level'
  5665. | 'default.opponent'
  5666. | 'default.cost'
  5667. }
  5668. interface ToTempFilePathOption {
  5669. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5670. complete?: ToTempFilePathCompleteCallback
  5671. /** 目标文件的高度,会将截取的部分拉伸或压缩至该数值 */
  5672. destHeight?: number
  5673. /** 目标文件的宽度,会将截取的部分拉伸或压缩至该数值 */
  5674. destWidth?: number
  5675. /** 接口调用失败的回调函数 */
  5676. fail?: ToTempFilePathFailCallback
  5677. /** 目标文件的类型
  5678. *
  5679. * 可选值:
  5680. * - 'jpg': jpg 文件;
  5681. * - 'png': png 文件; */
  5682. fileType?: 'jpg' | 'png'
  5683. /** 截取 canvas 的高度 */
  5684. height?: number
  5685. /** jpg图片的质量,仅当 fileType 为 jpg 时有效。取值范围为 0.0(最低)- 1.0(最高),不含 0。不在范围内时当作 1.0 */
  5686. quality?: number
  5687. /** 接口调用成功的回调函数 */
  5688. success?: ToTempFilePathSuccessCallback
  5689. /** 截取 canvas 的宽度 */
  5690. width?: number
  5691. /** 截取 canvas 的左上角横坐标 */
  5692. x?: number
  5693. /** 截取 canvas 的左上角纵坐标 */
  5694. y?: number
  5695. }
  5696. interface ToTempFilePathSuccessCallbackResult {
  5697. /** canvas 生成的临时文件路径 (本地路径) */
  5698. tempFilePath: string
  5699. errMsg: string
  5700. }
  5701. interface ToTempFilePathSyncOption {
  5702. /** 目标文件的高度,会将截取的部分拉伸或压缩至该数值 */
  5703. destHeight?: number
  5704. /** 目标文件的宽度,会将截取的部分拉伸或压缩至该数值 */
  5705. destWidth?: number
  5706. /** 目标文件的类型
  5707. *
  5708. * 可选值:
  5709. * - 'jpg': jpg 文件;
  5710. * - 'png': png 文件; */
  5711. fileType?: 'jpg' | 'png'
  5712. /** 截取 canvas 的高度 */
  5713. height?: number
  5714. /** jpg图片的质量,仅当 fileType 为 jpg 时有效。取值范围为 0.0(最低)- 1.0(最高),不含 0。不在范围内时当作 1.0 */
  5715. quality?: number
  5716. /** 截取 canvas 的宽度 */
  5717. width?: number
  5718. /** 截取 canvas 的左上角横坐标 */
  5719. x?: number
  5720. /** 截取 canvas 的左上角纵坐标 */
  5721. y?: number
  5722. }
  5723. /** 在触控设备上的触摸点。通常是指手指或者触控笔在触屏设备或者触摸板上的操作。 */
  5724. interface Touch {
  5725. /** 触点相对于可见视区左边沿的 X 坐标。 */
  5726. clientX: number
  5727. /** 触点相对于可见视区上边沿的 Y 坐标。 */
  5728. clientY: number
  5729. /** 手指挤压触摸平面的压力大小, 从0.0(没有压力)到1.0(最大压力)的浮点数(仅在支持 force touch 的设备返回) */
  5730. force: number
  5731. /** Touch 对象的唯一标识符,只读属性。一次触摸动作(我们值的是手指的触摸)在平面上移动的整个过程中, 该标识符不变。可以根据它来判断跟踪的是否是同一次触摸过程。 */
  5732. identifier: number
  5733. /** 触点相对于页面左边沿的 X 坐标。 */
  5734. pageX: number
  5735. /** 触点相对于页面上边沿的 Y 坐标。 */
  5736. pageY: number
  5737. }
  5738. interface TruncateFailCallbackResult {
  5739. /** 错误信息
  5740. *
  5741. * 可选值:
  5742. * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
  5743. * - 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;
  5744. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
  5745. * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
  5746. * - 'fail sdcard not mounted': android sdcard 挂载失败; */
  5747. errMsg: string
  5748. }
  5749. interface TruncateOption {
  5750. /** 要截断的文件路径 (本地路径) */
  5751. filePath: string
  5752. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5753. complete?: TruncateCompleteCallback
  5754. /** 接口调用失败的回调函数 */
  5755. fail?: TruncateFailCallback
  5756. /** 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
  5757. length?: number
  5758. /** 接口调用成功的回调函数 */
  5759. success?: TruncateSuccessCallback
  5760. }
  5761. interface TruncateSyncOption {
  5762. /** 要截断的文件路径 (本地路径) */
  5763. filePath: string
  5764. /** 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
  5765. length?: number
  5766. }
  5767. interface UDPSocketOnMessageCallbackResult {
  5768. /** 接收端地址信息,2.18.0 起支持 */
  5769. localInfo: LocalInfo
  5770. /** 收到的消息 */
  5771. message: ArrayBuffer
  5772. /** 发送端地址信息 */
  5773. remoteInfo: RemoteInfo
  5774. }
  5775. interface UDPSocketSendOption {
  5776. /** 要发消息的地址。在基础库 <= 2.9.3 版本必须是和本机同网段的 IP 地址,或安全域名列表内的域名地址;之后版本可以是任意 IP 和域名 */
  5777. address: string
  5778. /** 要发送的数据 */
  5779. message: string | ArrayBuffer
  5780. /** 要发送消息的端口号 */
  5781. port: number
  5782. /** 发送数据的长度,仅当 message 为 ArrayBuffer 类型时有效 */
  5783. length?: number
  5784. /** 发送数据的偏移量,仅当 message 为 ArrayBuffer 类型时有效 */
  5785. offset?: number
  5786. }
  5787. interface UnlinkFailCallbackResult {
  5788. /** 错误信息
  5789. *
  5790. * 可选值:
  5791. * - 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;
  5792. * - 'fail no such file or directory ${path}': 文件不存在;
  5793. * - 'fail operation not permitted, unlink ${filePath}': 传入的 filePath 是一个目录;
  5794. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  5795. errMsg: string
  5796. }
  5797. interface UnlinkOption {
  5798. /** 要删除的文件路径 (本地路径) */
  5799. filePath: string
  5800. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5801. complete?: UnlinkCompleteCallback
  5802. /** 接口调用失败的回调函数 */
  5803. fail?: UnlinkFailCallback
  5804. /** 接口调用成功的回调函数 */
  5805. success?: UnlinkSuccessCallback
  5806. }
  5807. interface UnzipFailCallbackResult {
  5808. /** 错误信息
  5809. *
  5810. * 可选值:
  5811. * - 'fail permission denied, unzip ${zipFilePath} -> ${destPath}': 指定目标文件路径没有写权限;
  5812. * - 'fail no such file or directory, unzip ${zipFilePath} -> "${destPath}': 源文件不存在,或目标文件路径的上层目录不存在; */
  5813. errMsg: string
  5814. }
  5815. interface UnzipOption {
  5816. /** 目标目录路径, 支持本地路径 */
  5817. targetPath: string
  5818. /** 源文件路径,支持本地路径, 只可以是 zip 压缩文件 */
  5819. zipFilePath: string
  5820. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5821. complete?: UnzipCompleteCallback
  5822. /** 接口调用失败的回调函数 */
  5823. fail?: UnzipFailCallback
  5824. /** 接口调用成功的回调函数 */
  5825. success?: UnzipSuccessCallback
  5826. }
  5827. /** 参数列表 */
  5828. interface UpdatableMessageFrontEndParameter {
  5829. /** 参数名 */
  5830. name: string
  5831. /** 参数值 */
  5832. value: string
  5833. }
  5834. /** 需要基础库: `2.4.0`
  5835. *
  5836. * 动态消息的模板信息 */
  5837. interface UpdatableMessageFrontEndTemplateInfo {
  5838. /** 参数列表 */
  5839. parameterList: UpdatableMessageFrontEndParameter[]
  5840. }
  5841. interface UpdateKeyboardOption {
  5842. /** 键盘输入框的当前值 */
  5843. value: string
  5844. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5845. complete?: UpdateKeyboardCompleteCallback
  5846. /** 接口调用失败的回调函数 */
  5847. fail?: UpdateKeyboardFailCallback
  5848. /** 接口调用成功的回调函数 */
  5849. success?: UpdateKeyboardSuccessCallback
  5850. }
  5851. interface UpdateReadyStatusOption {
  5852. /** 游戏房间访问凭证 */
  5853. accessInfo: string
  5854. /** 是否准备完成 */
  5855. isReady: boolean
  5856. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5857. complete?: UpdateReadyStatusCompleteCallback
  5858. /** 接口调用失败的回调函数 */
  5859. fail?: UpdateReadyStatusFailCallback
  5860. /** 接口调用成功的回调函数 */
  5861. success?: UpdateReadyStatusSuccessCallback
  5862. }
  5863. interface UpdateShareMenuOption {
  5864. /** 需要基础库: `2.4.0`
  5865. *
  5866. * 动态消息的 activityId。通过 [updatableMessage.createActivityId](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/updatable-message/updatableMessage.createActivityId.html) 接口获取 */
  5867. activityId?: string
  5868. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5869. complete?: UpdateShareMenuCompleteCallback
  5870. /** 接口调用失败的回调函数 */
  5871. fail?: UpdateShareMenuFailCallback
  5872. /** 需要基础库: `2.13.0`
  5873. *
  5874. * 是否是私密消息。详见 [小程序私密消息](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/private-message.html) */
  5875. isPrivateMessage?: boolean
  5876. /** 需要基础库: `2.4.0`
  5877. *
  5878. * 是否是动态消息,详见[动态消息](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/updatable-message.html) */
  5879. isUpdatableMessage?: boolean
  5880. /** 接口调用成功的回调函数 */
  5881. success?: UpdateShareMenuSuccessCallback
  5882. /** 需要基础库: `2.4.0`
  5883. *
  5884. * 动态消息的模板信息 */
  5885. templateInfo?: UpdatableMessageFrontEndTemplateInfo
  5886. /** 需要基础库: `2.11.0`
  5887. *
  5888. * 群待办消息的id,通过toDoActivityId可以把多个群待办消息聚合为同一个。通过 [updatableMessage.createActivityId](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/updatable-message/updatableMessage.createActivityId.html) 接口获取。详见[群待办消息](#) */
  5889. toDoActivityId?: string
  5890. /** 是否使用带 shareTicket 的转发[详情](#) */
  5891. withShareTicket?: boolean
  5892. }
  5893. interface UpdateVoIPChatMuteConfigOption {
  5894. /** 静音设置 */
  5895. muteConfig: MuteConfig
  5896. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5897. complete?: UpdateVoIPChatMuteConfigCompleteCallback
  5898. /** 接口调用失败的回调函数 */
  5899. fail?: UpdateVoIPChatMuteConfigFailCallback
  5900. /** 接口调用成功的回调函数 */
  5901. success?: UpdateVoIPChatMuteConfigSuccessCallback
  5902. }
  5903. interface UpdateWeChatAppOption {
  5904. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5905. complete?: UpdateWeChatAppCompleteCallback
  5906. /** 接口调用失败的回调函数 */
  5907. fail?: UpdateWeChatAppFailCallback
  5908. /** 接口调用成功的回调函数 */
  5909. success?: UpdateWeChatAppSuccessCallback
  5910. }
  5911. interface UploadFileOption {
  5912. /** 要上传文件资源的路径 (本地路径) */
  5913. filePath: string
  5914. /** 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 */
  5915. name: string
  5916. /** 开发者服务器地址 */
  5917. url: string
  5918. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5919. complete?: UploadFileCompleteCallback
  5920. /** 接口调用失败的回调函数 */
  5921. fail?: UploadFileFailCallback
  5922. /** HTTP 请求中其他额外的 form data */
  5923. formData?: IAnyObject
  5924. /** HTTP 请求 Header,Header 中不能设置 Referer */
  5925. header?: IAnyObject
  5926. /** 接口调用成功的回调函数 */
  5927. success?: UploadFileSuccessCallback
  5928. /** 需要基础库: `2.10.0`
  5929. *
  5930. * 超时时间,单位为毫秒 */
  5931. timeout?: number
  5932. }
  5933. interface UploadFileSuccessCallbackResult {
  5934. /** 开发者服务器返回的数据 */
  5935. data: string
  5936. /** 开发者服务器返回的 HTTP 状态码 */
  5937. statusCode: number
  5938. errMsg: string
  5939. }
  5940. interface UploadFrameOption {
  5941. /** 指令数组,每一项的类型必须与配置项 `lockStepOption.dataType` 一致 */
  5942. actionList: string[] | ArrayBuffer[]
  5943. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  5944. complete?: UploadFrameCompleteCallback
  5945. /** 接口调用失败的回调函数 */
  5946. fail?: UploadFrameFailCallback
  5947. /** 接口调用成功的回调函数 */
  5948. success?: UploadFrameSuccessCallback
  5949. }
  5950. interface UploadTaskOnProgressUpdateCallbackResult {
  5951. /** 上传进度百分比 */
  5952. progress: number
  5953. /** 预期需要上传的数据总长度,单位 Bytes */
  5954. totalBytesExpectedToSend: number
  5955. /** 已经上传的数据长度,单位 Bytes */
  5956. totalBytesSent: number
  5957. }
  5958. /** 托管数据 */
  5959. interface UserGameData {
  5960. /** 用户的托管 KV 数据列表 */
  5961. KVDataList: KVData[]
  5962. /** 用户的微信头像 url */
  5963. avatarUrl: string
  5964. /** 用户的微信昵称 */
  5965. nickname: string
  5966. /** 用户的 openid */
  5967. openid: string
  5968. }
  5969. /** 用户信息 */
  5970. interface UserInfo {
  5971. /** 用户头像图片的 URL。URL 最后一个数值代表正方形头像大小(有 0、46、64、96、132 数值可选,0 代表 640x640 的正方形头像,46 表示 46x46 的正方形头像,剩余数值以此类推。默认132),用户没有头像时该项为空。若用户更换头像,原有头像 URL 将失效。 */
  5972. avatarUrl: string
  5973. /** 用户所在城市。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
  5974. city: string
  5975. /** 用户所在国家。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
  5976. country: string
  5977. /** 用户性别。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801)
  5978. *
  5979. * 可选值:
  5980. * - 0: 未知;
  5981. * - 1: 男性;
  5982. * - 2: 女性; */
  5983. gender: 0 | 1 | 2
  5984. /** 显示 country,province,city 所用的语言。强制返回 “zh_CN”,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801)
  5985. *
  5986. * 可选值:
  5987. * - 'en': 英文;
  5988. * - 'zh_CN': 简体中文;
  5989. * - 'zh_TW': 繁体中文; */
  5990. language: 'en' | 'zh_CN' | 'zh_TW'
  5991. /** 用户昵称 */
  5992. nickName: string
  5993. /** 用户所在省份。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
  5994. province: string
  5995. }
  5996. /** 用户信息按钮 */
  5997. interface UserInfoButton {
  5998. /** 按钮的样式 */
  5999. style: OptionStyle
  6000. /** 按钮的类型。
  6001. *
  6002. * 可选值:
  6003. * - 'text': 可以设置背景色和文本的按钮;
  6004. * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
  6005. type: 'text' | 'image'
  6006. /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
  6007. image?: string
  6008. /** 按钮上的文本,仅当 type 为 `text` 时有效 */
  6009. text?: string
  6010. }
  6011. interface VibrateLongOption {
  6012. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6013. complete?: VibrateLongCompleteCallback
  6014. /** 接口调用失败的回调函数 */
  6015. fail?: VibrateLongFailCallback
  6016. /** 接口调用成功的回调函数 */
  6017. success?: VibrateLongSuccessCallback
  6018. }
  6019. interface VibrateShortOption {
  6020. /** 需要基础库: `2.13.0`
  6021. *
  6022. * 震动强度类型,有效值为:heavy、medium、light */
  6023. type: string
  6024. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6025. complete?: VibrateShortCompleteCallback
  6026. /** 接口调用失败的回调函数 */
  6027. fail?: VibrateShortFailCallback
  6028. /** 接口调用成功的回调函数 */
  6029. success?: VibrateShortSuccessCallback
  6030. }
  6031. /** 视频对象 */
  6032. interface Video {
  6033. /** 视频是否自动播放 */
  6034. autoplay: boolean
  6035. /** 需要基础库: `2.12.0`
  6036. *
  6037. * 视频背景颜色 */
  6038. backgroundColor: string
  6039. /** 视频是否显示控件 */
  6040. controls: boolean
  6041. /** 是否启用手势控制播放进度 */
  6042. enablePlayGesture: boolean
  6043. /** 是否启用手势控制播放进度 */
  6044. enableProgressGesture: boolean
  6045. /** 视频的高度 */
  6046. height: number
  6047. /** 视频的初始播放位置,单位为 s 秒 */
  6048. initialTime: number
  6049. /** 视频是否为直播 */
  6050. live: boolean
  6051. /** 视频是否是否循环播放 */
  6052. loop: boolean
  6053. /** 视频是否禁音播放 */
  6054. muted: boolean
  6055. /** 需要基础库: `2.4.0`
  6056. *
  6057. * 视频是否遵从系统静音开关设置(仅iOS) */
  6058. obeyMuteSwitch: boolean
  6059. /** 视频的缩放模式 */
  6060. objectFit: string
  6061. /** 视频播放到末尾时触发的回调函数 */
  6062. onended: (...args: any[]) => any
  6063. /** 视频发生错误时触发的回调函数 */
  6064. onerror: (...args: any[]) => any
  6065. /** 视频暂停时触发的回调函数 */
  6066. onpause: (...args: any[]) => any
  6067. /** 视频开始播放时触发的回调函数 */
  6068. onplay: (...args: any[]) => any
  6069. /** 视频下载(缓冲)时周期性触发的回调函数 */
  6070. onprogress: (...args: any[]) => any
  6071. /** 每当视频播放进度更新时触发的回调函数 */
  6072. ontimeupdate: (...args: any[]) => any
  6073. /** 视频由于需要缓冲下一帧而停止时触发的回调函数 */
  6074. onwaiting: (...args: any[]) => any
  6075. /** 视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5 */
  6076. playbackRate: number
  6077. /** 视频的封面 */
  6078. poster: string
  6079. /** 是否显示视频中央的播放按钮 */
  6080. showCenterPlayBtn: boolean
  6081. /** 需要基础库: `2.12.0`
  6082. *
  6083. * 是否显示视频底部进度条 */
  6084. showProgress: boolean
  6085. /** 需要基础库: `2.12.0`
  6086. *
  6087. * 是否显示视频控制栏进度条 */
  6088. showProgressInControlMode: boolean
  6089. /** 视频的资源地址 */
  6090. src: string
  6091. /** 视频的宽度 */
  6092. width: number
  6093. /** 视频的左上角横坐标 */
  6094. x: number
  6095. /** 视频的左上角纵坐标 */
  6096. y: number
  6097. }
  6098. interface VideoDecoderStartOption {
  6099. /** 需要解码的视频源文件。基础库 2.13.0 以下的版本只支持本地路径。 2.13.0 开始支持 http:// 和 https:// 协议的远程路径。 */
  6100. source: string
  6101. /** 需要基础库: `2.15.0`
  6102. *
  6103. * 是否不需要音频轨道 */
  6104. abortAudio?: boolean
  6105. /** 需要基础库: `2.15.0`
  6106. *
  6107. * 是否不需要视频轨道 */
  6108. abortVideo?: boolean
  6109. /** 解码模式。0:按 pts 解码;1:以最快速度解码 */
  6110. mode?: number
  6111. }
  6112. interface VideoOnErrorCallbackResult {
  6113. /** 错误信息
  6114. *
  6115. * 可选值:
  6116. * - 'MEDIA_ERR_NETWORK': 当下载时发生错误;
  6117. * - 'MEDIA_ERR_DECODE': 当解码时发生错误;
  6118. * - 'MEDIA_ERR_SRC_NOT_SUPPORTED': video 的 src 属性是不支持的资源类型; */
  6119. errMsg: string
  6120. }
  6121. /** 需要基础库: `2.19.0`
  6122. *
  6123. * WebAudioContext 实例,通过[wx.createWebAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createWebAudioContext.html) 接口获取该实例。
  6124. *
  6125. * **示例代码**
  6126. *
  6127. * ```js
  6128. // 监听状态
  6129. const audioCtx = wx.createWebAudioContext()
  6130. audioCtx.onstatechange = () => {
  6131. console.log(ctx.state)
  6132. }
  6133. setTimeout(audioCtx.suspend, 1000)
  6134. setTimeout(audioCtx.resume, 2000)
  6135. ``` */
  6136. interface WebAudioContext {
  6137. /** 获取当前上下文的时间戳。 */
  6138. currentTime: number
  6139. /** [WebAudioContextNode](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContextNode.html)
  6140. *
  6141. * 当前上下文的最终目标节点,一般是音频渲染设备。 */
  6142. destination: WebAudioContextNode
  6143. /** 空间音频监听器。 */
  6144. listener: AudioListener
  6145. /** 可写属性,开发者可以对该属性设置一个监听函数,当WebAudio状态改变的时候,会触发开发者设置的监听函数。 */
  6146. onstatechange: (...args: any[]) => any
  6147. /** 采样率,通常在8000-96000之间,通常44100hz的采样率最为常见。 */
  6148. sampleRate: number
  6149. /** 当前WebAudio上下文的状态。可能的值如下:suspended(暂停)、running(正在运行)、closed(已关闭)。需要注意的是,不要在 audioContext close后再访问state属性 */
  6150. state: string
  6151. }
  6152. /** 需要基础库: `2.19.0`
  6153. *
  6154. * 一类音频处理模块,不同的Node具备不同的功能,如GainNode(音量调整)等。一个WebAudioContextNode可以通过上下文来创建。
  6155. * 目前已经支持以下Node:
  6156. * IIRFilterNode
  6157. * WaveShaperNode
  6158. * ConstantSourceNode
  6159. * ChannelMergerNode
  6160. * OscillatorNode
  6161. * GainNode
  6162. * BiquadFilterNode
  6163. * PeriodicWaveNode
  6164. * BufferSourceNode
  6165. * ChannelSplitterNode
  6166. * ChannelMergerNode
  6167. * DelayNode
  6168. * DynamicsCompressorNode
  6169. * ScriptProcessorNode
  6170. * PannerNode */
  6171. interface WebAudioContextNode {
  6172. /** 表示监听器的前向系统在同一笛卡尔坐标系中的水平位置,作为位置(位置x,位置和位置和位置)值。 */
  6173. forwardX: number
  6174. /** 表示听众的前向方向在同一笛卡尔坐标系中作为位置(位置x,位置和位置和位置)值的垂直位置。 */
  6175. forwardY: number
  6176. /** 表示与position (positionX、positionY和positionZ)值在同一笛卡尔坐标系下的听者前进方向的纵向(前后)位置。 */
  6177. forwardZ: number
  6178. /** 右手笛卡尔坐标系中X轴的位置。 */
  6179. positionX: number
  6180. /** 右手笛卡尔坐标系中Y轴的位置。 */
  6181. positionY: number
  6182. /** 右手笛卡尔坐标系中Z轴的位置。 */
  6183. positionZ: number
  6184. /** 设置监听器的方向 */
  6185. setOrientation: (...args: any[]) => any
  6186. /** 设置监听器的位置
  6187. *
  6188. * /** */
  6189. setPosition: (...args: any[]) => any
  6190. /** 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向前方向的水平位置。 */
  6191. upX: number
  6192. /** 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向上方向的水平位置。 */
  6193. upY: number
  6194. /** 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向后方向的水平位置。 */
  6195. upZ: number
  6196. }
  6197. /** Worker 实例,主线程中可通过 [wx.createWorker](https://developers.weixin.qq.com/minigame/dev/api/worker/wx.createWorker.html) 接口获取,worker 线程中可通过全局变量 `worker` 获取。
  6198. *
  6199. * **示例代码**
  6200. *
  6201. * 运行以下代码需先进行基础配置,详细请查阅 [小程序多线程](https://developers.weixin.qq.com/miniprogram/dev/framework/workers.html) | [小游戏多线程](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/worker.html) 文档了解基础知识和配置方法。
  6202. *
  6203. * ```js
  6204. const worker = wx.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径,绝对路径
  6205. worker.onMessage(function (res) {
  6206. console.log(res)
  6207. })
  6208. // 监听worker被系统回收事件
  6209. worker.onProcessKilled(function () {
  6210. console.log('worker has been killed')
  6211. // 重新创建一个worker
  6212. // wx.createWorker()
  6213. })
  6214. worker.postMessage({
  6215. msg: 'hello worker'
  6216. })
  6217. worker.terminate()
  6218. ``` */
  6219. interface Worker {
  6220. /** worker内的环境变量 */
  6221. env: WorkerEnv
  6222. }
  6223. /** worker内的环境变量 */
  6224. interface WorkerEnv {
  6225. /** 文件系统中的用户目录路径 (本地路径) */
  6226. USER_DATA_PATH: string
  6227. }
  6228. interface WorkerOnMessageCallbackResult {
  6229. /** 主线程/Worker 线程向当前线程发送的消息 */
  6230. message: IAnyObject
  6231. }
  6232. interface WriteBLECharacteristicValueOption {
  6233. /** 蓝牙特征的 UUID */
  6234. characteristicId: string
  6235. /** 蓝牙设备 id */
  6236. deviceId: string
  6237. /** 蓝牙特征对应服务的 UUID */
  6238. serviceId: string
  6239. /** 蓝牙设备特征对应的二进制值 */
  6240. value: ArrayBuffer
  6241. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6242. complete?: WriteBLECharacteristicValueCompleteCallback
  6243. /** 接口调用失败的回调函数 */
  6244. fail?: WriteBLECharacteristicValueFailCallback
  6245. /** 接口调用成功的回调函数 */
  6246. success?: WriteBLECharacteristicValueSuccessCallback
  6247. }
  6248. interface WriteCharacteristicValueObject {
  6249. /** 蓝牙特征的 UUID */
  6250. characteristicId: string
  6251. /** 是否需要通知主机 value 已更新 */
  6252. needNotify: boolean
  6253. /** 蓝牙特征对应服务的 UUID */
  6254. serviceId: string
  6255. /** characteristic 对应的二进制值 */
  6256. value: ArrayBuffer
  6257. /** 可选,处理回包时使用 */
  6258. callbackId?: number
  6259. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6260. complete?: WriteCharacteristicValueCompleteCallback
  6261. /** 接口调用失败的回调函数 */
  6262. fail?: WriteCharacteristicValueFailCallback
  6263. /** 接口调用成功的回调函数 */
  6264. success?: WriteCharacteristicValueSuccessCallback
  6265. }
  6266. interface WriteFailCallbackResult {
  6267. /** 错误信息
  6268. *
  6269. * 可选值:
  6270. * - 'bad file descriptor': 无效的文件描述符;
  6271. * - 'fail permission denied': 指定的 fd 路径没有写权限;
  6272. * - 'fail sdcard not mounted': android sdcard 挂载失败; */
  6273. errMsg: string
  6274. }
  6275. interface WriteFileFailCallbackResult {
  6276. /** 错误信息
  6277. *
  6278. * 可选值:
  6279. * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
  6280. * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
  6281. * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
  6282. * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
  6283. errMsg: string
  6284. }
  6285. interface WriteFileOption {
  6286. /** 要写入的文本或二进制数据 */
  6287. data: string | ArrayBuffer
  6288. /** 要写入的文件路径 (本地路径) */
  6289. filePath: string
  6290. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6291. complete?: WriteFileCompleteCallback
  6292. /** 指定写入文件的字符编码
  6293. *
  6294. * 可选值:
  6295. * - 'ascii': ;
  6296. * - 'base64': ;
  6297. * - 'binary': ;
  6298. * - 'hex': ;
  6299. * - 'ucs2': 以小端序读取;
  6300. * - 'ucs-2': 以小端序读取;
  6301. * - 'utf16le': 以小端序读取;
  6302. * - 'utf-16le': 以小端序读取;
  6303. * - 'utf-8': ;
  6304. * - 'utf8': ;
  6305. * - 'latin1': ; */
  6306. encoding?:
  6307. | 'ascii'
  6308. | 'base64'
  6309. | 'binary'
  6310. | 'hex'
  6311. | 'ucs2'
  6312. | 'ucs-2'
  6313. | 'utf16le'
  6314. | 'utf-16le'
  6315. | 'utf-8'
  6316. | 'utf8'
  6317. | 'latin1'
  6318. /** 接口调用失败的回调函数 */
  6319. fail?: WriteFileFailCallback
  6320. /** 接口调用成功的回调函数 */
  6321. success?: WriteFileSuccessCallback
  6322. }
  6323. interface WriteOption {
  6324. /** 写入的内容,类型为 String 或 ArrayBuffer */
  6325. data: string | ArrayBuffer
  6326. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  6327. fd: string
  6328. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6329. complete?: WriteCompleteCallback
  6330. /** 只在 data 类型是 String 时有效,指定写入文件的字符编码,默认为 utf8
  6331. *
  6332. * 可选值:
  6333. * - 'ascii': ;
  6334. * - 'base64': ;
  6335. * - 'binary': ;
  6336. * - 'hex': ;
  6337. * - 'ucs2': 以小端序读取;
  6338. * - 'ucs-2': 以小端序读取;
  6339. * - 'utf16le': 以小端序读取;
  6340. * - 'utf-16le': 以小端序读取;
  6341. * - 'utf-8': ;
  6342. * - 'utf8': ;
  6343. * - 'latin1': ; */
  6344. encoding?:
  6345. | 'ascii'
  6346. | 'base64'
  6347. | 'binary'
  6348. | 'hex'
  6349. | 'ucs2'
  6350. | 'ucs-2'
  6351. | 'utf16le'
  6352. | 'utf-16le'
  6353. | 'utf-8'
  6354. | 'utf8'
  6355. | 'latin1'
  6356. /** 接口调用失败的回调函数 */
  6357. fail?: WriteFailCallback
  6358. /** 只在 data 类型是 ArrayBuffer 时有效,指定要写入的字节数,默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 */
  6359. length?: number
  6360. /** 只在 data 类型是 ArrayBuffer 时有效,决定 arrayBuffe 中要被写入的部位,即 arrayBuffer 中的索引,默认0 */
  6361. offset?: number
  6362. /** 指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。 */
  6363. position?: number
  6364. /** 接口调用成功的回调函数 */
  6365. success?: WriteSuccessCallback
  6366. }
  6367. /** 文件写入结果。 通过 [FileSystemManager.writeSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeSync.html) 接口返回 */
  6368. interface WriteResult {
  6369. /** 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同) */
  6370. bytesWritten: number
  6371. }
  6372. interface WriteSuccessCallbackResult {
  6373. /** 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同) */
  6374. bytesWritten: number
  6375. errMsg: string
  6376. }
  6377. interface WriteSyncOption {
  6378. /** 写入的内容,类型为 String 或 ArrayBuffer */
  6379. data: string | ArrayBuffer
  6380. /** 文件描述符。fd 通过 [FileSystemManager.open](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html) 或 [FileSystemManager.openSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html) 接口获得 */
  6381. fd: string
  6382. /** 只在 data 类型是 String 时有效,指定写入文件的字符编码,默认为 utf8
  6383. *
  6384. * 可选值:
  6385. * - 'ascii': ;
  6386. * - 'base64': ;
  6387. * - 'binary': ;
  6388. * - 'hex': ;
  6389. * - 'ucs2': 以小端序读取;
  6390. * - 'ucs-2': 以小端序读取;
  6391. * - 'utf16le': 以小端序读取;
  6392. * - 'utf-16le': 以小端序读取;
  6393. * - 'utf-8': ;
  6394. * - 'utf8': ;
  6395. * - 'latin1': ; */
  6396. encoding?:
  6397. | 'ascii'
  6398. | 'base64'
  6399. | 'binary'
  6400. | 'hex'
  6401. | 'ucs2'
  6402. | 'ucs-2'
  6403. | 'utf16le'
  6404. | 'utf-16le'
  6405. | 'utf-8'
  6406. | 'utf8'
  6407. | 'latin1'
  6408. /** 只在 data 类型是 ArrayBuffer 时有效,指定要写入的字节数,默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 */
  6409. length?: number
  6410. /** 只在 data 类型是 ArrayBuffer 时有效,决定 arrayBuffe 中要被写入的部位,即 arrayBuffer 中的索引,默认0 */
  6411. offset?: number
  6412. /** 指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。 */
  6413. position?: number
  6414. }
  6415. interface WxGetFileInfoOption {
  6416. /** 本地文件路径 (本地路径) */
  6417. filePath: string
  6418. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  6419. complete?: GetFileInfoCompleteCallback
  6420. /** 计算文件摘要的算法
  6421. *
  6422. * 可选值:
  6423. * - 'md5': md5 算法;
  6424. * - 'sha1': sha1 算法; */
  6425. digestAlgorithm?: 'md5' | 'sha1'
  6426. /** 接口调用失败的回调函数 */
  6427. fail?: WxGetFileInfoFailCallback
  6428. /** 接口调用成功的回调函数 */
  6429. success?: WxGetFileInfoSuccessCallback
  6430. }
  6431. interface WxGetFileInfoSuccessCallbackResult {
  6432. /** 按照传入的 digestAlgorithm 计算得出的的文件摘要 */
  6433. digest: string
  6434. /** 文件大小,以字节为单位 */
  6435. size: number
  6436. errMsg: string
  6437. }
  6438. interface WxOnErrorCallbackResult {
  6439. /** 错误 */
  6440. message: string
  6441. /** 错误调用堆栈 */
  6442. stack: string
  6443. }
  6444. /** 文件路径 */
  6445. interface ZipFileItem {
  6446. /** 文件内容 */
  6447. data: string | ArrayBuffer
  6448. /** 错误信息 */
  6449. errMsg: string
  6450. }
  6451. interface AudioBuffer {
  6452. /** [AudioBuffer.copyFromChannel()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.copyFromChannel.html)
  6453. *
  6454. * 从AudioBuffer的指定频道复制到数组终端。 */
  6455. copyFromChannel(): void
  6456. /** [AudioBuffer.copyToChannel(Float32Array source, number channelNumber, number startInChannel)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.copyToChannel.html)
  6457. *
  6458. * 从指定数组复制样本到audioBuffer的特定通道
  6459. *
  6460. * **示例代码**
  6461. *
  6462. * 示例代码参考AudioBuffer.copyFromChannel */
  6463. copyToChannel(
  6464. /** 需要复制的源数组 */
  6465. source: Float32Array,
  6466. /** 需要复制到的目的通道号 */
  6467. channelNumber: number,
  6468. /** 复制偏移数据量 */
  6469. startInChannel: number
  6470. ): void
  6471. /** [Float32Array AudioBuffer.getChannelData(number channel)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.getChannelData.html)
  6472. *
  6473. * 返回一个 Float32Array,包含了带有频道的PCM数据,由频道参数定义(有0代表第一个频道) */
  6474. getChannelData(
  6475. /** 要获取特定通道数据的索引 */
  6476. channel: number
  6477. ): Float32Array
  6478. }
  6479. interface BLEPeripheralServer {
  6480. /** [BLEPeripheralServer.addService(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.addService.html)
  6481. *
  6482. * 需要基础库: `2.10.3`
  6483. *
  6484. * 添加服务。 */
  6485. addService(option: AddServiceOption): void
  6486. /** [BLEPeripheralServer.offCharacteristicReadRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicReadRequest.html)
  6487. *
  6488. * 需要基础库: `2.10.3`
  6489. *
  6490. * 取消监听已连接的设备请求读当前外围设备的特征值事件 */
  6491. offCharacteristicReadRequest(
  6492. /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
  6493. callback?: OffCharacteristicReadRequestCallback
  6494. ): void
  6495. /** [BLEPeripheralServer.offCharacteristicSubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicSubscribed.html)
  6496. *
  6497. * 需要基础库: `2.13.0`
  6498. *
  6499. * 取消监听特征订阅事件 */
  6500. offCharacteristicSubscribed(
  6501. /** 特征订阅事件的回调函数 */
  6502. callback?: OffCharacteristicSubscribedCallback
  6503. ): void
  6504. /** [BLEPeripheralServer.offCharacteristicUnsubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicUnsubscribed.html)
  6505. *
  6506. * 需要基础库: `2.13.0`
  6507. *
  6508. * 取消监听取消特征订阅事件 */
  6509. offCharacteristicUnsubscribed(
  6510. /** 取消特征订阅事件的回调函数 */
  6511. callback?: OffCharacteristicUnsubscribedCallback
  6512. ): void
  6513. /** [BLEPeripheralServer.offCharacteristicWriteRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicWriteRequest.html)
  6514. *
  6515. * 需要基础库: `2.10.3`
  6516. *
  6517. * 取消监听已连接的设备请求写当前外围设备的特征值事件 */
  6518. offCharacteristicWriteRequest(
  6519. /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
  6520. callback?: OffCharacteristicWriteRequestCallback
  6521. ): void
  6522. /** [BLEPeripheralServer.onCharacteristicReadRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicReadRequest.html)
  6523. *
  6524. * 需要基础库: `2.10.3`
  6525. *
  6526. * 监听已连接的设备请求读当前外围设备的特征值事件。收到该消息后需要立刻调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 写回数据,否则主机不会收到响应。 */
  6527. onCharacteristicReadRequest(
  6528. /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
  6529. callback: OnCharacteristicReadRequestCallback
  6530. ): void
  6531. /** [BLEPeripheralServer.onCharacteristicSubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicSubscribed.html)
  6532. *
  6533. * 需要基础库: `2.13.0`
  6534. *
  6535. * 监听特征订阅事件,仅 iOS 支持。 */
  6536. onCharacteristicSubscribed(
  6537. /** 特征订阅事件的回调函数 */
  6538. callback: OnCharacteristicSubscribedCallback
  6539. ): void
  6540. /** [BLEPeripheralServer.onCharacteristicUnsubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicUnsubscribed.html)
  6541. *
  6542. * 需要基础库: `2.13.0`
  6543. *
  6544. * 监听取消特征订阅事件,仅 iOS 支持。 */
  6545. onCharacteristicUnsubscribed(
  6546. /** 取消特征订阅事件的回调函数 */
  6547. callback: OnCharacteristicUnsubscribedCallback
  6548. ): void
  6549. /** [BLEPeripheralServer.onCharacteristicWriteRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicWriteRequest.html)
  6550. *
  6551. * 需要基础库: `2.10.3`
  6552. *
  6553. * 监听已连接的设备请求写当前外围设备的特征值事件。收到该消息后需要立刻调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 写回数据,否则主机不会收到响应。 */
  6554. onCharacteristicWriteRequest(
  6555. /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
  6556. callback: OnCharacteristicWriteRequestCallback
  6557. ): void
  6558. /** [BLEPeripheralServer.removeService(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.removeService.html)
  6559. *
  6560. * 需要基础库: `2.10.3`
  6561. *
  6562. * 移除服务。 */
  6563. removeService(option: RemoveServiceOption): void
  6564. /** [BLEPeripheralServer.startAdvertising(Object Object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.startAdvertising.html)
  6565. *
  6566. * 需要基础库: `2.10.3`
  6567. *
  6568. * 开始广播本地创建的外围设备。
  6569. *
  6570. * **注意**
  6571. *
  6572. * - Android 8.0.9 开始,支持直接使用 16/32/128 位 UUID;
  6573. * - Android 8.0.9 以下版本只支持 128 位 UUID,使用 16/32 位的 UUID 时需要进行补位(系统会自动识别是否属于预分配区间),可以参考[蓝牙指南](#);
  6574. * - iOS 必须直接使用 16 位的 UUID,不能补位到 128 位,否则系统组包时仍会按照 128 位传输。iOS 暂不支持 32 位 UUID。
  6575. * - iOS 同时只能发起一个广播,安卓支持同时发起多个广播。
  6576. * - 传 beacon 参数时,不能同时传入 deviceName,serviceUuids,manufacturerData 参数。 */
  6577. startAdvertising(Object: StartAdvertisingObject): void
  6578. /** [BLEPeripheralServer.stopAdvertising(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.stopAdvertising.html)
  6579. *
  6580. * 需要基础库: `2.10.3`
  6581. *
  6582. * 停止广播。 */
  6583. stopAdvertising(option?: StopAdvertisingOption): void
  6584. /** [BLEPeripheralServer.writeCharacteristicValue(Object Object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html)
  6585. *
  6586. * 需要基础库: `2.10.3`
  6587. *
  6588. * 往指定特征写入二进制数据值,并通知已连接的主机,从机的特征值已发生变化,该接口会处理是走回包还是走订阅。 */
  6589. writeCharacteristicValue(Object: WriteCharacteristicValueObject): void
  6590. }
  6591. interface BannerAd {
  6592. /** [BannerAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.destroy.html)
  6593. *
  6594. * 销毁 banner 广告。 */
  6595. destroy(): void
  6596. /** [BannerAd.hide()](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.hide.html)
  6597. *
  6598. * 隐藏 banner 广告。 */
  6599. hide(): void
  6600. /** [BannerAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.offError.html)
  6601. *
  6602. * 取消监听 banner 广告错误事件 */
  6603. offError(
  6604. /** banner 广告错误事件的回调函数 */
  6605. callback?: BannerAdOffErrorCallback
  6606. ): void
  6607. /** [BannerAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.offLoad.html)
  6608. *
  6609. * 取消监听 banner 广告加载事件 */
  6610. offLoad(
  6611. /** banner 广告加载事件的回调函数 */
  6612. callback?: OffLoadCallback
  6613. ): void
  6614. /** [BannerAd.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.offResize.html)
  6615. *
  6616. * 取消监听 banner 广告尺寸变化事件 */
  6617. offResize(
  6618. /** banner 广告尺寸变化事件的回调函数 */
  6619. callback?: BannerAdOffResizeCallback
  6620. ): void
  6621. /** [BannerAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.onError.html)
  6622. *
  6623. * 监听 banner 广告错误事件。
  6624. *
  6625. * **错误码信息与解决方案表**
  6626. *
  6627. * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
  6628. * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
  6629. *
  6630. * | 代码 | 异常情况 | 理由 | 解决方案 |
  6631. * | ------ | -------------- | --------------- | -------------------------- |
  6632. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  6633. * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
  6634. * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
  6635. * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
  6636. * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  6637. * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  6638. * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  6639. * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
  6640. * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
  6641. onError(
  6642. /** banner 广告错误事件的回调函数 */
  6643. callback: BannerAdOnErrorCallback
  6644. ): void
  6645. /** [BannerAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.onLoad.html)
  6646. *
  6647. * 监听 banner 广告加载事件。 */
  6648. onLoad(
  6649. /** banner 广告加载事件的回调函数 */
  6650. callback: OnLoadCallback
  6651. ): void
  6652. /** [BannerAd.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.onResize.html)
  6653. *
  6654. * 监听 banner 广告尺寸变化事件。 */
  6655. onResize(
  6656. /** banner 广告尺寸变化事件的回调函数 */
  6657. callback: BannerAdOnResizeCallback
  6658. ): void
  6659. /** [Promise BannerAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.show.html)
  6660. *
  6661. * 显示 banner 广告。 */
  6662. show(): Promise<any>
  6663. }
  6664. interface BeaconError {
  6665. /** 错误信息
  6666. *
  6667. * | 错误码 | 错误信息 | 说明 |
  6668. * | - | - | - |
  6669. * | 0 | ok | 正常 |
  6670. * | 11000 | unsupport | 系统或设备不支持 |
  6671. * | 11001 | bluetooth service unavailable | 蓝牙服务不可用 |
  6672. * | 11002 | location service unavailable | 位置服务不可用 |
  6673. * | 11003 | already start | 已经开始搜索 |
  6674. * | 11004 | not startBeaconDiscovery | 还未开始搜索 |
  6675. * | 11005 | system error | 系统错误 |
  6676. * | 11006 | invalid data | 参数不正确 | */ errMsg: string
  6677. /** 错误码
  6678. *
  6679. * | 错误码 | 错误信息 | 说明 |
  6680. * | - | - | - |
  6681. * | 0 | ok | 正常 |
  6682. * | 11000 | unsupport | 系统或设备不支持 |
  6683. * | 11001 | bluetooth service unavailable | 蓝牙服务不可用 |
  6684. * | 11002 | location service unavailable | 位置服务不可用 |
  6685. * | 11003 | already start | 已经开始搜索 |
  6686. * | 11004 | not startBeaconDiscovery | 还未开始搜索 |
  6687. * | 11005 | system error | 系统错误 |
  6688. * | 11006 | invalid data | 参数不正确 | */ errCode: number
  6689. }
  6690. interface BluetoothError {
  6691. /** 错误信息
  6692. *
  6693. * | 错误码 | 错误信息 | 说明 |
  6694. * | - | - | - |
  6695. * | 0 | ok | 正常 |
  6696. * | -1 | already connect | 已连接 |
  6697. * | 10000 | not init | 未初始化蓝牙适配器 |
  6698. * | 10001 | not available | 当前蓝牙适配器不可用 |
  6699. * | 10002 | no device | 没有找到指定设备 |
  6700. * | 10003 | connection fail | 连接失败 |
  6701. * | 10004 | no service | 没有找到指定服务 |
  6702. * | 10005 | no characteristic | 没有找到指定特征 |
  6703. * | 10006 | no connection | 当前连接已断开 |
  6704. * | 10007 | property not support | 当前特征不支持此操作 |
  6705. * | 10008 | system error | 其余所有系统上报的异常 |
  6706. * | 10009 | system not support | Android 系统特有,系统版本低于 4.3 不支持 BLE |
  6707. * | 10012 | operate time out | 连接超时 |
  6708. * | 10013 | invalid_data | 连接 deviceId 为空或者是格式不正确 | */ errMsg: string
  6709. /** 错误码
  6710. *
  6711. * | 错误码 | 错误信息 | 说明 |
  6712. * | - | - | - |
  6713. * | 0 | ok | 正常 |
  6714. * | -1 | already connect | 已连接 |
  6715. * | 10000 | not init | 未初始化蓝牙适配器 |
  6716. * | 10001 | not available | 当前蓝牙适配器不可用 |
  6717. * | 10002 | no device | 没有找到指定设备 |
  6718. * | 10003 | connection fail | 连接失败 |
  6719. * | 10004 | no service | 没有找到指定服务 |
  6720. * | 10005 | no characteristic | 没有找到指定特征 |
  6721. * | 10006 | no connection | 当前连接已断开 |
  6722. * | 10007 | property not support | 当前特征不支持此操作 |
  6723. * | 10008 | system error | 其余所有系统上报的异常 |
  6724. * | 10009 | system not support | Android 系统特有,系统版本低于 4.3 不支持 BLE |
  6725. * | 10012 | operate time out | 连接超时 |
  6726. * | 10013 | invalid_data | 连接 deviceId 为空或者是格式不正确 | */ errCode: number
  6727. }
  6728. interface Camera {
  6729. /** [Camera.closeFrameChange()](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.closeFrameChange.html)
  6730. *
  6731. * 需要基础库: `2.9.0`
  6732. *
  6733. * 关闭监听帧数据 */
  6734. closeFrameChange(): void
  6735. /** [Camera.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.destroy.html)
  6736. *
  6737. * 需要基础库: `2.9.0`
  6738. *
  6739. * 销毁相机 */
  6740. destroy(): void
  6741. /** [Camera.listenFrameChange([Worker](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.html) worker)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.listenFrameChange.html)
  6742. *
  6743. * 需要基础库: `2.9.0`
  6744. *
  6745. * 开启监听帧数据 */
  6746. listenFrameChange(
  6747. /** [Worker](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.html)
  6748. *
  6749. * 在 iOS ExperimentalWorker 内监听摄像头帧数据。详情 [Worker.getCameraFrameData](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.getCameraFrameData.html) */
  6750. worker?: Worker
  6751. ): void
  6752. /** [Camera.onAuthCancel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.onAuthCancel.html)
  6753. *
  6754. * 需要基础库: `2.9.0`
  6755. *
  6756. * 监听用户不允许授权使用摄像头的情况 */
  6757. onAuthCancel(
  6758. /** 事件发生时的回调函数 */
  6759. callback: (...args: any[]) => any
  6760. ): void
  6761. /** [Camera.onCameraFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.onCameraFrame.html)
  6762. *
  6763. * 需要基础库: `2.9.0`
  6764. *
  6765. * 监听摄像头实时帧数据 */
  6766. onCameraFrame(
  6767. /** 摄像头返回实时帧数据的回调函数 */
  6768. callback: OnCameraFrameCallback
  6769. ): void
  6770. /** [Camera.onStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.onStop.html)
  6771. *
  6772. * 需要基础库: `2.9.0`
  6773. *
  6774. * 监听摄像头非正常终止事件,如退出后台等情况 */
  6775. onStop(
  6776. /** 事件发生时的回调函数 */
  6777. callback: (...args: any[]) => any
  6778. ): void
  6779. /** [Promise Camera.startRecord()](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.startRecord.html)
  6780. *
  6781. * 需要基础库: `2.9.0`
  6782. *
  6783. * 开始录像 */
  6784. startRecord(): Promise<any>
  6785. /** [Promise Camera.stopRecord(boolean compressed)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.stopRecord.html)
  6786. *
  6787. * 需要基础库: `2.9.0`
  6788. *
  6789. * 结束录像,成功则返回封面与视频 */
  6790. stopRecord(
  6791. /** 是否压缩录制视频 */
  6792. compressed?: boolean
  6793. ): Promise<any>
  6794. /** [Promise Camera.takePhoto(string quality)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.takePhoto.html)
  6795. *
  6796. * 需要基础库: `2.9.0`
  6797. *
  6798. * 拍照,可指定质量,成功则返回图片 */
  6799. takePhoto(
  6800. /** 拍照质量,值为 high, normal, low */
  6801. quality?: string
  6802. ): Promise<any>
  6803. }
  6804. interface Canvas {
  6805. /** [Canvas.toTempFilePath(Object object)](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toTempFilePath.html)
  6806. *
  6807. * 将当前 Canvas 保存为一个临时文件。**如果使用了开放数据域,则生成后的文件仅能被用于以下接口:`wx.saveImageToPhotosAlbum`、`wx.shareAppMessage`、`wx.onShareAppMessage`** */
  6808. toTempFilePath(option: ToTempFilePathOption): void
  6809. /** [[RenderingContext](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/RenderingContext.html) Canvas.getContext(string contextType, Object contextAttributes)](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.getContext.html)
  6810. *
  6811. * 获取画布对象的绘图上下文 */
  6812. getContext(
  6813. /** 上下文类型
  6814. *
  6815. * 参数 contextType 可选值:
  6816. * - '2d': 2d 绘图上下文;
  6817. * - 'webgl': webgl 绘图上下文; */
  6818. contextType: '2d' | 'webgl',
  6819. /** webgl 上下文属性,仅当 contextType 为 webgl 时有效 */
  6820. contextAttributes?: ContextAttributes
  6821. ): any
  6822. /** [string Canvas.toDataURL()](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toDataURL.html)
  6823. *
  6824. * 把画布上的绘制内容以一个 data URI 的格式返回 */
  6825. toDataURL(): string
  6826. /** [string Canvas.toTempFilePathSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toTempFilePathSync.html)
  6827. *
  6828. * [Canvas.toTempFilePath](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toTempFilePath.html) 的同步版本 */
  6829. toTempFilePathSync(option: ToTempFilePathSyncOption): string
  6830. }
  6831. interface CloseSyncError {
  6832. /** 错误信息
  6833. *
  6834. * | 错误信息 | 说明 |
  6835. * | - | - |
  6836. * | bad file descriptor | 无效的文件描述符 | */ errMsg: string
  6837. /** 错误码
  6838. *
  6839. * | 错误信息 | 说明 |
  6840. * | - | - |
  6841. * | bad file descriptor | 无效的文件描述符 | */ errCode: number
  6842. }
  6843. interface Console {
  6844. /** [console.debug()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.debug.html)
  6845. *
  6846. * 向调试面板中打印 debug 日志 */
  6847. debug(
  6848. /** 日志内容,可以有任意多个。 */
  6849. ...args: any[]
  6850. ): void
  6851. /** [console.error()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.error.html)
  6852. *
  6853. * 向调试面板中打印 error 日志 */
  6854. error(
  6855. /** 日志内容,可以有任意多个。 */
  6856. ...args: any[]
  6857. ): void
  6858. /** [console.group(string label)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.group.html)
  6859. *
  6860. * 在调试面板中创建一个新的分组。随后输出的内容都会被添加一个缩进,表示该内容属于当前分组。调用 [console.groupEnd](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.groupEnd.html)之后分组结束。
  6861. *
  6862. * **注意**
  6863. *
  6864. * 仅在工具中有效,在 vConsole 中为空函数实现。 */
  6865. group(
  6866. /** 分组标记,可选。 */
  6867. label?: string
  6868. ): void
  6869. /** [console.groupEnd()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.groupEnd.html)
  6870. *
  6871. * 结束由 [console.group](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.group.html) 创建的分组
  6872. *
  6873. * **注意**
  6874. *
  6875. * 仅在工具中有效,在 vConsole 中为空函数实现。 */
  6876. groupEnd(): void
  6877. /** [console.info()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.info.html)
  6878. *
  6879. * 向调试面板中打印 info 日志 */
  6880. info(
  6881. /** 日志内容,可以有任意多个。 */
  6882. ...args: any[]
  6883. ): void
  6884. /** [console.log()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.log.html)
  6885. *
  6886. * 向调试面板中打印 log 日志 */
  6887. log(
  6888. /** 日志内容,可以有任意多个。 */
  6889. ...args: any[]
  6890. ): void
  6891. /** [console.warn()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.warn.html)
  6892. *
  6893. * 向调试面板中打印 warn 日志 */
  6894. warn(
  6895. /** 日志内容,可以有任意多个。 */
  6896. ...args: any[]
  6897. ): void
  6898. }
  6899. interface CustomAd {
  6900. /** [CustomAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.destroy.html)
  6901. *
  6902. * 销毁原生模板广告。 */
  6903. destroy(): void
  6904. /** [CustomAd.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offClose.html)
  6905. *
  6906. * 取消监听原生模板广告关闭事件 */
  6907. offClose(
  6908. /** 原生模板广告关闭事件的回调函数 */
  6909. callback?: UDPSocketOffCloseCallback
  6910. ): void
  6911. /** [CustomAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offError.html)
  6912. *
  6913. * 取消监听原生模板广告错误事件 */
  6914. offError(
  6915. /** 原生模板广告错误事件的回调函数 */
  6916. callback?: CustomAdOffErrorCallback
  6917. ): void
  6918. /** [CustomAd.offHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offHide.html)
  6919. *
  6920. * 需要基础库: `2.14.4`
  6921. *
  6922. * 取消监听原生模板广告隐藏事件 */
  6923. offHide(
  6924. /** 原生模板广告隐藏事件的回调函数 */
  6925. callback?: OffHideCallback
  6926. ): void
  6927. /** [CustomAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offLoad.html)
  6928. *
  6929. * 取消监听原生模板广告加载事件 */
  6930. offLoad(
  6931. /** 原生模板广告加载事件的回调函数 */
  6932. callback?: OffLoadCallback
  6933. ): void
  6934. /** [CustomAd.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onClose.html)
  6935. *
  6936. * 监听原生模板广告关闭事件。 */
  6937. onClose(
  6938. /** 原生模板广告关闭事件的回调函数 */
  6939. callback: UDPSocketOnCloseCallback
  6940. ): void
  6941. /** [CustomAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onError.html)
  6942. *
  6943. * 监听原生模板广告错误事件。
  6944. *
  6945. * **错误码信息与解决方案表**
  6946. *
  6947. * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
  6948. * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
  6949. *
  6950. * | 代码 | 异常情况 | 理由 | 解决方案 |
  6951. * | ------ | -------------- | --------------- | -------------------------- |
  6952. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  6953. * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
  6954. * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
  6955. * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
  6956. * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  6957. * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  6958. * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  6959. * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
  6960. * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。|
  6961. * | 2001 | 模板渲染错误 | 渲染过程出现错误 | |
  6962. * | 2002 | 模板为空 | 该广告位的广告能力已经被关闭 | |
  6963. * | 2003 | 模板解析失败 | 该广告位的广告能力已经被关闭 | |
  6964. * | 2004 | 触发频率限制 | 小程序启动一定时间内不允许展示原生模板广告 | |
  6965. * | 2005 | 触发频率限制 | 距离小程序插屏广告或者激励视频广告上次播放时间间隔不足,不允许展示原生模板广告 | | */
  6966. onError(
  6967. /** 原生模板广告错误事件的回调函数 */
  6968. callback: CustomAdOnErrorCallback
  6969. ): void
  6970. /** [CustomAd.onHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onHide.html)
  6971. *
  6972. * 需要基础库: `2.14.4`
  6973. *
  6974. * 监听原生模板广告隐藏事件, 某些模板如矩阵格子模板用户点击关闭时也会触发该事件。 */
  6975. onHide(
  6976. /** 原生模板广告隐藏事件的回调函数 */
  6977. callback: OnHideCallback
  6978. ): void
  6979. /** [CustomAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onLoad.html)
  6980. *
  6981. * 监听原生模板广告加载事件。 */
  6982. onLoad(
  6983. /** 原生模板广告加载事件的回调函数 */
  6984. callback: OnLoadCallback
  6985. ): void
  6986. /** [Promise CustomAd.hide()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.hide.html)
  6987. *
  6988. * 隐藏原生模板广告。(某些模板广告无法隐藏) */
  6989. hide(): Promise<any>
  6990. /** [Promise CustomAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.show.html)
  6991. *
  6992. * 显示原生模板广告。 */
  6993. show(): Promise<any>
  6994. /** [boolean CustomAd.isShow()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.isShow.html)
  6995. *
  6996. * 查询原生模板广告展示状态。 */
  6997. isShow(): boolean
  6998. }
  6999. interface DownloadTask {
  7000. /** [DownloadTask.abort()](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.abort.html)
  7001. *
  7002. * 需要基础库: `1.4.0`
  7003. *
  7004. * 中断下载任务 */
  7005. abort(): void
  7006. /** [DownloadTask.offHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.offHeadersReceived.html)
  7007. *
  7008. * 需要基础库: `2.1.0`
  7009. *
  7010. * 取消监听 HTTP Response Header 事件 */
  7011. offHeadersReceived(
  7012. /** HTTP Response Header 事件的回调函数 */
  7013. callback?: OffHeadersReceivedCallback
  7014. ): void
  7015. /** [DownloadTask.offProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.offProgressUpdate.html)
  7016. *
  7017. * 需要基础库: `2.1.0`
  7018. *
  7019. * 取消监听下载进度变化事件 */
  7020. offProgressUpdate(
  7021. /** 下载进度变化事件的回调函数 */
  7022. callback?: DownloadTaskOffProgressUpdateCallback
  7023. ): void
  7024. /** [DownloadTask.onHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.onHeadersReceived.html)
  7025. *
  7026. * 需要基础库: `2.1.0`
  7027. *
  7028. * 监听 HTTP Response Header 事件。会比请求完成事件更早 */
  7029. onHeadersReceived(
  7030. /** HTTP Response Header 事件的回调函数 */
  7031. callback: OnHeadersReceivedCallback
  7032. ): void
  7033. /** [DownloadTask.onProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.onProgressUpdate.html)
  7034. *
  7035. * 需要基础库: `1.4.0`
  7036. *
  7037. * 监听下载进度变化事件 */
  7038. onProgressUpdate(
  7039. /** 下载进度变化事件的回调函数 */
  7040. callback: DownloadTaskOnProgressUpdateCallback
  7041. ): void
  7042. }
  7043. interface FeedbackButton {
  7044. /** [FeedbackButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.destroy.html)
  7045. *
  7046. * 销毁意见反馈按钮 */
  7047. destroy(): void
  7048. /** [FeedbackButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.hide.html)
  7049. *
  7050. * 隐藏意见反馈按钮。 */
  7051. hide(): void
  7052. /** [FeedbackButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.offTap.html)
  7053. *
  7054. * 取消监听意见反馈按钮的点击事件 */
  7055. offTap(
  7056. /** 意见反馈按钮的点击事件的回调函数 */
  7057. callback?: GameClubButtonOffTapCallback
  7058. ): void
  7059. /** [FeedbackButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.onTap.html)
  7060. *
  7061. * 监听意见反馈按钮的点击事件 */
  7062. onTap(
  7063. /** 意见反馈按钮的点击事件的回调函数 */
  7064. callback: GameClubButtonOnTapCallback
  7065. ): void
  7066. /** [FeedbackButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.show.html)
  7067. *
  7068. * 显示意见反馈按钮 */
  7069. show(): void
  7070. }
  7071. interface FileSystemManager {
  7072. /** [Array.&lt;string&gt; FileSystemManager.readdirSync(string dirPath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readdirSync.html)
  7073. *
  7074. * [FileSystemManager.readdir](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readdir.html) 的同步版本
  7075. *
  7076. * **注意事项</title>
  7077. * - readdir接口无法访问文件系统根路径(wxfile://)。
  7078. * <title>示例代码**
  7079. *
  7080. * ```js
  7081. const fs = wx.getFileSystemManager()
  7082. fs.readdir({
  7083. dirPath: `${wx.env.USER_DATA_PATH}/example`,
  7084. success(res) {
  7085. console.log(res.files)
  7086. },
  7087. fail(res) {
  7088. console.error(res)
  7089. }
  7090. })
  7091. // 同步接口
  7092. try {
  7093. const res = fs.readdirSync(`${wx.env.USER_DATA_PATH}/example`)
  7094. console.log(res)
  7095. } catch(e) {
  7096. console.error(e)
  7097. }
  7098. ``` */
  7099. readdirSync(
  7100. /** 要读取的目录路径 (本地路径) */
  7101. dirPath: string
  7102. ): string[]
  7103. /** [ArrayBuffer FileSystemManager.readCompressedFileSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readCompressedFileSync.html)
  7104. *
  7105. * 需要基础库: `2.21.1`
  7106. *
  7107. * 同步读取指定压缩类型的本地文件内容
  7108. *
  7109. * **示例代码**
  7110. *
  7111. * ```js
  7112. const fs = wx.getFileSystemManager()
  7113. // 异步接口
  7114. fs.readCompressedFile({
  7115. filePath: '${wx.env.USER_DATA_PATH}/hello.br',
  7116. compressionAlgorithm: 'br',
  7117. success(res) {
  7118. console.log(res.data)
  7119. },
  7120. fail(res) {
  7121. console.log('readCompressedFile fail', res)
  7122. }
  7123. })
  7124. // 同步接口
  7125. try {
  7126. const data = fs.readCompressedFileSync({
  7127. filePath: '${wx.env.USER_DATA_PATH}/hello.br',
  7128. compressionAlgorithm: 'br',
  7129. })
  7130. console.log(data)
  7131. } catch (err) {
  7132. console.log(err)
  7133. }
  7134. ``` */
  7135. readCompressedFileSync(
  7136. option: ReadCompressedFileSyncOption
  7137. ): ArrayBuffer
  7138. /** [FileSystemManager.access(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.access.html)
  7139. *
  7140. * 判断文件/目录是否存在
  7141. *
  7142. * **示例代码**
  7143. *
  7144. * ```js
  7145. const fs = wx.getFileSystemManager()
  7146. // 判断文件/目录是否存在
  7147. fs.access({
  7148. path: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7149. success(res) {
  7150. // 文件存在
  7151. console.log(res)
  7152. },
  7153. fail(res) {
  7154. // 文件不存在或其他错误
  7155. console.error(res)
  7156. }
  7157. })
  7158. // 同步接口
  7159. try {
  7160. fs.accessSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
  7161. } catch(e) {
  7162. console.error(e)
  7163. }
  7164. ``` */
  7165. access(option: AccessOption): void
  7166. /** [FileSystemManager.accessSync(string path)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.accessSync.html)
  7167. *
  7168. * [FileSystemManager.access](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.access.html) 的同步版本
  7169. *
  7170. * **示例代码**
  7171. *
  7172. * ```js
  7173. const fs = wx.getFileSystemManager()
  7174. // 判断文件/目录是否存在
  7175. fs.access({
  7176. path: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7177. success(res) {
  7178. // 文件存在
  7179. console.log(res)
  7180. },
  7181. fail(res) {
  7182. // 文件不存在或其他错误
  7183. console.error(res)
  7184. }
  7185. })
  7186. // 同步接口
  7187. try {
  7188. fs.accessSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
  7189. } catch(e) {
  7190. console.error(e)
  7191. }
  7192. ``` */
  7193. accessSync(
  7194. /** 要判断是否存在的文件/目录路径 (本地路径) */
  7195. path: string
  7196. ): void
  7197. /** [FileSystemManager.appendFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.appendFile.html)
  7198. *
  7199. * 需要基础库: `2.1.0`
  7200. *
  7201. * 在文件结尾追加内容
  7202. *
  7203. * **示例代码**
  7204. *
  7205. * ```js
  7206. const fs = wx.getFileSystemManager()
  7207. fs.appendFile({
  7208. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7209. data: 'some text',
  7210. encoding: 'utf8',
  7211. success(res) {
  7212. console.log(res)
  7213. },
  7214. fail(res) {
  7215. console.error(res)
  7216. }
  7217. })
  7218. // 同步接口
  7219. try {
  7220. fs.appendFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'some text', 'utf8')
  7221. } catch(e) {
  7222. console.error(e)
  7223. }
  7224. ``` */
  7225. appendFile(option: AppendFileOption): void
  7226. /** [FileSystemManager.appendFileSync(string filePath, string|ArrayBuffer data, string encoding)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.appendFileSync.html)
  7227. *
  7228. * 需要基础库: `2.1.0`
  7229. *
  7230. * [FileSystemManager.appendFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.appendFile.html) 的同步版本
  7231. *
  7232. * **示例代码**
  7233. *
  7234. * ```js
  7235. const fs = wx.getFileSystemManager()
  7236. fs.appendFile({
  7237. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7238. data: 'some text',
  7239. encoding: 'utf8',
  7240. success(res) {
  7241. console.log(res)
  7242. },
  7243. fail(res) {
  7244. console.error(res)
  7245. }
  7246. })
  7247. // 同步接口
  7248. try {
  7249. fs.appendFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'some text', 'utf8')
  7250. } catch(e) {
  7251. console.error(e)
  7252. }
  7253. ``` */
  7254. appendFileSync(
  7255. /** 要追加内容的文件路径 (本地路径) */
  7256. filePath: string,
  7257. /** 要追加的文本或二进制数据 */
  7258. data: string | ArrayBuffer,
  7259. /** 指定写入文件的字符编码
  7260. *
  7261. * 参数 encoding 可选值:
  7262. * - 'ascii': ;
  7263. * - 'base64': ;
  7264. * - 'binary': ;
  7265. * - 'hex': ;
  7266. * - 'ucs2': 以小端序读取;
  7267. * - 'ucs-2': 以小端序读取;
  7268. * - 'utf16le': 以小端序读取;
  7269. * - 'utf-16le': 以小端序读取;
  7270. * - 'utf-8': ;
  7271. * - 'utf8': ;
  7272. * - 'latin1': ; */
  7273. encoding?:
  7274. | 'ascii'
  7275. | 'base64'
  7276. | 'binary'
  7277. | 'hex'
  7278. | 'ucs2'
  7279. | 'ucs-2'
  7280. | 'utf16le'
  7281. | 'utf-16le'
  7282. | 'utf-8'
  7283. | 'utf8'
  7284. | 'latin1'
  7285. ): void
  7286. /** [FileSystemManager.close(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.close.html)
  7287. *
  7288. * 需要基础库: `2.16.1`
  7289. *
  7290. * 关闭文件
  7291. *
  7292. * **示例代码**
  7293. *
  7294. * ```js
  7295. const fs = wx.getFileSystemManager()
  7296. // 打开文件
  7297. fs.open({
  7298. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7299. flag: 'a+',
  7300. success(res) {
  7301. // 关闭文件
  7302. fs.close({
  7303. fd: res.fd
  7304. })
  7305. }
  7306. })
  7307. ``` */
  7308. close(option: FileSystemManagerCloseOption): void
  7309. /** [FileSystemManager.copyFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.copyFile.html)
  7310. *
  7311. * 复制文件
  7312. *
  7313. * **示例代码**
  7314. *
  7315. * ```js
  7316. const fs = wx.getFileSystemManager()
  7317. fs.copyFile({
  7318. srcPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7319. destPath: `${wx.env.USER_DATA_PATH}/hello_copy.txt`
  7320. success(res) {
  7321. console.log(res)
  7322. },
  7323. fail(res) {
  7324. console.error(res)
  7325. }
  7326. })
  7327. // 同步接口
  7328. try {
  7329. fs.copyFileSync(
  7330. `${wx.env.USER_DATA_PATH}/hello.txt`,
  7331. `${wx.env.USER_DATA_PATH}/hello_copy.txt`
  7332. )
  7333. } catch(e) {
  7334. console.error(e)
  7335. }
  7336. ``` */
  7337. copyFile(option: CopyFileOption): void
  7338. /** [FileSystemManager.copyFileSync(string srcPath, string destPath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.copyFileSync.html)
  7339. *
  7340. * [FileSystemManager.copyFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.copyFile.html) 的同步版本
  7341. *
  7342. * **示例代码**
  7343. *
  7344. * ```js
  7345. const fs = wx.getFileSystemManager()
  7346. fs.copyFile({
  7347. srcPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7348. destPath: `${wx.env.USER_DATA_PATH}/hello_copy.txt`
  7349. success(res) {
  7350. console.log(res)
  7351. },
  7352. fail(res) {
  7353. console.error(res)
  7354. }
  7355. })
  7356. // 同步接口
  7357. try {
  7358. fs.copyFileSync(
  7359. `${wx.env.USER_DATA_PATH}/hello.txt`,
  7360. `${wx.env.USER_DATA_PATH}/hello_copy.txt`
  7361. )
  7362. } catch(e) {
  7363. console.error(e)
  7364. }
  7365. ``` */
  7366. copyFileSync(
  7367. /** 源文件路径,支持本地路径 */
  7368. srcPath: string,
  7369. /** 目标文件路径,支持本地路径 */
  7370. destPath: string
  7371. ): void
  7372. /** [FileSystemManager.fstat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.fstat.html)
  7373. *
  7374. * 需要基础库: `2.16.1`
  7375. *
  7376. * 获取文件的状态信息
  7377. *
  7378. * **示例代码**
  7379. *
  7380. * ```js
  7381. const fs = wx.getFileSystemManager()
  7382. // 打开文件
  7383. fs.open({
  7384. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7385. flag: 'a+',
  7386. success(res) {
  7387. // 获取文件的状态信息
  7388. fs.fstat({
  7389. fd: res.fd,
  7390. success(res) {
  7391. console.log(res.stats)
  7392. }
  7393. })
  7394. }
  7395. })
  7396. ``` */
  7397. fstat(option: FstatOption): void
  7398. /** [FileSystemManager.ftruncate(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.ftruncate.html)
  7399. *
  7400. * 需要基础库: `2.16.1`
  7401. *
  7402. * 对文件内容进行截断操作
  7403. *
  7404. * **示例代码**
  7405. *
  7406. * ```js
  7407. const fs = wx.getFileSystemManager()
  7408. // 打开文件
  7409. fs.open({
  7410. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7411. flag: 'a+',
  7412. success(res) {
  7413. // 对文件内容进行截断操作
  7414. fs.ftruncate({
  7415. fd: res.fd,
  7416. length: 10, // 从第10个字节开始截断文件
  7417. success(res) {
  7418. console.log(res)
  7419. }
  7420. })
  7421. }
  7422. })
  7423. ``` */
  7424. ftruncate(option: FtruncateOption): void
  7425. /** [FileSystemManager.getFileInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.getFileInfo.html)
  7426. *
  7427. * 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 */
  7428. getFileInfo(option: FileSystemManagerGetFileInfoOption): void
  7429. /** [FileSystemManager.getSavedFileList(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.getSavedFileList.html)
  7430. *
  7431. * 获取该小程序下已保存的本地缓存文件列表 */
  7432. getSavedFileList(option?: GetSavedFileListOption): void
  7433. /** [FileSystemManager.mkdir(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.mkdir.html)
  7434. *
  7435. * 创建目录
  7436. *
  7437. * **示例代码**
  7438. *
  7439. * ```js
  7440. const fs = wx.getFileSystemManager()
  7441. fs.mkdir({
  7442. dirPath: `${wx.env.USER_DATA_PATH}/example`,
  7443. recursive: false
  7444. success(res) {
  7445. console.log(res)
  7446. },
  7447. fail(res) {
  7448. console.error(res)
  7449. }
  7450. })
  7451. // 同步接口
  7452. try {
  7453. fs.mkdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
  7454. } catch(e) {
  7455. console.error(e)
  7456. }
  7457. ``` */
  7458. mkdir(option: MkdirOption): void
  7459. /** [FileSystemManager.mkdirSync(string dirPath, boolean recursive)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.mkdirSync.html)
  7460. *
  7461. * [FileSystemManager.mkdir](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.mkdir.html) 的同步版本
  7462. *
  7463. * **示例代码**
  7464. *
  7465. * ```js
  7466. const fs = wx.getFileSystemManager()
  7467. fs.mkdir({
  7468. dirPath: `${wx.env.USER_DATA_PATH}/example`,
  7469. recursive: false
  7470. success(res) {
  7471. console.log(res)
  7472. },
  7473. fail(res) {
  7474. console.error(res)
  7475. }
  7476. })
  7477. // 同步接口
  7478. try {
  7479. fs.mkdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
  7480. } catch(e) {
  7481. console.error(e)
  7482. }
  7483. ``` */
  7484. mkdirSync(
  7485. /** 创建的目录路径 (本地路径) */
  7486. dirPath: string,
  7487. /** 需要基础库: `2.3.0`
  7488. *
  7489. * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 */
  7490. recursive?: boolean
  7491. ): void
  7492. /** [FileSystemManager.open(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html)
  7493. *
  7494. * 需要基础库: `2.16.1`
  7495. *
  7496. * 打开文件,返回文件描述符
  7497. *
  7498. * **示例代码**
  7499. *
  7500. * ```js
  7501. const fs = wx.getFileSystemManager()
  7502. fs.open({
  7503. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7504. flag: 'a+',
  7505. success(res) {
  7506. console.log(res.fd)
  7507. }
  7508. })
  7509. ``` */
  7510. open(option: OpenOption): void
  7511. /** [FileSystemManager.read(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.read.html)
  7512. *
  7513. * 需要基础库: `2.16.1`
  7514. *
  7515. * 读文件
  7516. *
  7517. * **示例代码**
  7518. *
  7519. * ```js
  7520. const fs = wx.getFileSystemManager()
  7521. const ab = new ArrayBuffer(1024)
  7522. // 打开文件
  7523. fs.open({
  7524. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7525. flag: 'a+',
  7526. success(res) {
  7527. // 读取文件到 ArrayBuffer 中
  7528. fs.read({
  7529. fd: res.fd,
  7530. arrayBuffer: ab,
  7531. length: 10,
  7532. success(res) {
  7533. console.log(res)
  7534. }
  7535. })
  7536. }
  7537. })
  7538. ``` */
  7539. read(option: ReadOption): void
  7540. /** [FileSystemManager.readCompressedFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readCompressedFile.html)
  7541. *
  7542. * 需要基础库: `2.21.1`
  7543. *
  7544. * 读取指定压缩类型的本地文件内容
  7545. *
  7546. * **示例代码**
  7547. *
  7548. * ```js
  7549. const fs = wx.getFileSystemManager()
  7550. // 异步接口
  7551. fs.readCompressedFile({
  7552. filePath: '${wx.env.USER_DATA_PATH}/hello.br',
  7553. compressionAlgorithm: 'br',
  7554. success(res) {
  7555. console.log(res.data)
  7556. },
  7557. fail(res) {
  7558. console.log('readCompressedFile fail', res)
  7559. }
  7560. })
  7561. // 同步接口
  7562. const data = fs.readCompressedFileSync({
  7563. filePath: '${wx.env.USER_DATA_PATH}/hello.br',
  7564. compressionAlgorithm: 'br',
  7565. })
  7566. console.log(data)
  7567. ``` */
  7568. readCompressedFile(option: ReadCompressedFileOption): void
  7569. /** [FileSystemManager.readFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readFile.html)
  7570. *
  7571. * 读取本地文件内容
  7572. *
  7573. * **示例代码**
  7574. *
  7575. * ```js
  7576. const fs = wx.getFileSystemManager()
  7577. fs.readFile({
  7578. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7579. encoding: 'utf8',
  7580. position: 0,
  7581. success(res) {
  7582. console.log(res.data)
  7583. },
  7584. fail(res) {
  7585. console.error(res)
  7586. }
  7587. })
  7588. // 同步接口
  7589. try {
  7590. const res = fs.readFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'utf8', 0)
  7591. console.log(res)
  7592. } catch(e) {
  7593. console.error(e)
  7594. }
  7595. ``` */
  7596. readFile(option: ReadFileOption): void
  7597. /** [FileSystemManager.readZipEntry(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readZipEntry.html)
  7598. *
  7599. * 需要基础库: `2.17.3`
  7600. *
  7601. * 读取压缩包内的文件
  7602. *
  7603. * **示例代码**
  7604. *
  7605. * ```js
  7606. const fs = wx.getFileSystemManager()
  7607. // 读取zip内某个或多个文件
  7608. fs.readZipEntry({
  7609. filePath: 'wxfile://from/to.zip',
  7610. entries: [{
  7611. path: 'some_folder/my_file.txt', // zip内文件路径
  7612. encoding: 'utf-8', // 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
  7613. position: 0, // 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte
  7614. length: 10000, // 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte
  7615. }, {
  7616. path: 'other_folder/orther_file.txt', // zip内文件路径
  7617. }],
  7618. success(res) {
  7619. console.log(res.entries)
  7620. // res.entries === {
  7621. // 'some_folder/my_file.txt': {
  7622. // errMsg: 'readZipEntry:ok',
  7623. // data: 'xxxxxx'
  7624. // },
  7625. // 'other_folder/orther_file.txt': {
  7626. // data: (ArrayBuffer)
  7627. // }
  7628. // }
  7629. },
  7630. fail(res) {
  7631. console.log(res.errMsg)
  7632. },
  7633. })
  7634. // 读取zip内所有文件。允许指定统一的encoding。position、length则不再允许指定,分别默认为0和文件长度
  7635. fs.readZipEntry({
  7636. filePath: 'wxfile://from/to.zip',
  7637. entries: 'all'
  7638. encoding: 'utf-8', // 统一指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
  7639. success(res) {
  7640. console.log(res.entries)
  7641. // res.entries === {
  7642. // 'some_folder/my_file.txt': {
  7643. // errMsg: 'readZipEntry:ok',
  7644. // data: 'xxxxxx'
  7645. // },
  7646. // 'other_folder/orther_file.txt': {
  7647. // errMsg: 'readZipEntry:ok',
  7648. // data: 'xxxxxx'
  7649. // }
  7650. // }
  7651. },
  7652. fail(res) {
  7653. console.log(res.errMsg)
  7654. },
  7655. })
  7656. ``` */
  7657. readZipEntry(option: ReadZipEntryOption): void
  7658. /** [FileSystemManager.readdir(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readdir.html)
  7659. *
  7660. * 读取目录内文件列表
  7661. *
  7662. * **注意事项</title>
  7663. * - readdir接口无法访问文件系统根路径(wxfile://)。
  7664. * <title>示例代码**
  7665. *
  7666. * ```js
  7667. const fs = wx.getFileSystemManager()
  7668. fs.readdir({
  7669. dirPath: `${wx.env.USER_DATA_PATH}/example`,
  7670. success(res) {
  7671. console.log(res.files)
  7672. },
  7673. fail(res) {
  7674. console.error(res)
  7675. }
  7676. })
  7677. // 同步接口
  7678. try {
  7679. const res = fs.readdirSync(`${wx.env.USER_DATA_PATH}/example`)
  7680. console.log(res)
  7681. } catch(e) {
  7682. console.error(e)
  7683. }
  7684. ``` */
  7685. readdir(option: ReaddirOption): void
  7686. /** [FileSystemManager.removeSavedFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.removeSavedFile.html)
  7687. *
  7688. * 删除该小程序下已保存的本地缓存文件 */
  7689. removeSavedFile(option: RemoveSavedFileOption): void
  7690. /** [FileSystemManager.rename(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rename.html)
  7691. *
  7692. * 重命名文件。可以把文件从 oldPath 移动到 newPath
  7693. *
  7694. * **示例代码**
  7695. *
  7696. * ```js
  7697. const fs = wx.getFileSystemManager()
  7698. fs.rename({
  7699. oldPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7700. newPath: `${wx.env.USER_DATA_PATH}/hello_new.txt`,
  7701. success(res) {
  7702. console.log(res)
  7703. },
  7704. fail(res) {
  7705. console.error(res)
  7706. }
  7707. })
  7708. // 同步接口
  7709. try {
  7710. const res = fs.renameSync(
  7711. `${wx.env.USER_DATA_PATH}/hello.txt`,
  7712. `${wx.env.USER_DATA_PATH}/hello_new.txt`
  7713. )
  7714. console.log(res)
  7715. } catch(e) {
  7716. console.error(e)
  7717. }
  7718. ``` */
  7719. rename(option: RenameOption): void
  7720. /** [FileSystemManager.renameSync(string oldPath, string newPath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.renameSync.html)
  7721. *
  7722. * [FileSystemManager.rename](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rename.html) 的同步版本
  7723. *
  7724. * **示例代码**
  7725. *
  7726. * ```js
  7727. const fs = wx.getFileSystemManager()
  7728. fs.rename({
  7729. oldPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7730. newPath: `${wx.env.USER_DATA_PATH}/hello_new.txt`,
  7731. success(res) {
  7732. console.log(res)
  7733. },
  7734. fail(res) {
  7735. console.error(res)
  7736. }
  7737. })
  7738. // 同步接口
  7739. try {
  7740. const res = fs.renameSync(
  7741. `${wx.env.USER_DATA_PATH}/hello.txt`,
  7742. `${wx.env.USER_DATA_PATH}/hello_new.txt`
  7743. )
  7744. console.log(res)
  7745. } catch(e) {
  7746. console.error(e)
  7747. }
  7748. ``` */
  7749. renameSync(
  7750. /** 源文件路径,支持本地路径 */
  7751. oldPath: string,
  7752. /** 新文件路径,支持本地路径 */
  7753. newPath: string
  7754. ): void
  7755. /** [FileSystemManager.rmdir(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rmdir.html)
  7756. *
  7757. * 删除目录
  7758. *
  7759. * **示例代码**
  7760. *
  7761. * ```js
  7762. const fs = wx.getFileSystemManager()
  7763. fs.rmdir({
  7764. dirPath: `${wx.env.USER_DATA_PATH}/example`,
  7765. recursive: false,
  7766. success(res) {
  7767. console.log(res)
  7768. },
  7769. fail(res) {
  7770. console.error(res)
  7771. }
  7772. })
  7773. // 同步接口
  7774. try {
  7775. const res = fs.rmdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
  7776. console.log(res)
  7777. } catch(e) {
  7778. console.error(e)
  7779. }
  7780. ``` */
  7781. rmdir(option: RmdirOption): void
  7782. /** [FileSystemManager.rmdirSync(string dirPath, boolean recursive)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rmdirSync.html)
  7783. *
  7784. * [FileSystemManager.rmdir](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rmdir.html) 的同步版本
  7785. *
  7786. * **示例代码**
  7787. *
  7788. * ```js
  7789. const fs = wx.getFileSystemManager()
  7790. fs.rmdir({
  7791. dirPath: `${wx.env.USER_DATA_PATH}/example`,
  7792. recursive: false,
  7793. success(res) {
  7794. console.log(res)
  7795. },
  7796. fail(res) {
  7797. console.error(res)
  7798. }
  7799. })
  7800. // 同步接口
  7801. try {
  7802. const res = fs.rmdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
  7803. console.log(res)
  7804. } catch(e) {
  7805. console.error(e)
  7806. }
  7807. ``` */
  7808. rmdirSync(
  7809. /** 要删除的目录路径 (本地路径) */
  7810. dirPath: string,
  7811. /** 需要基础库: `2.3.0`
  7812. *
  7813. * 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 */
  7814. recursive?: boolean
  7815. ): void
  7816. /** [FileSystemManager.saveFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.saveFile.html)
  7817. *
  7818. * 保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。 */
  7819. saveFile(option: SaveFileOption): void
  7820. /** [FileSystemManager.stat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.stat.html)
  7821. *
  7822. * 获取文件 Stats 对象 */
  7823. stat(option: StatOption): void
  7824. /** [FileSystemManager.truncate(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.truncate.html)
  7825. *
  7826. * 需要基础库: `2.16.1`
  7827. *
  7828. * 对文件内容进行截断操作
  7829. *
  7830. * **示例代码**
  7831. *
  7832. * ```js
  7833. const fs = wx.getFileSystemManager()
  7834. fs.truncate({
  7835. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7836. length: 10, // 从第10个字节开始截断
  7837. success(res) {
  7838. console.log(res)
  7839. }
  7840. })
  7841. ``` */
  7842. truncate(option: TruncateOption): void
  7843. /** [FileSystemManager.unlink(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unlink.html)
  7844. *
  7845. * 删除文件
  7846. *
  7847. * **示例代码**
  7848. *
  7849. * ```js
  7850. const fs = wx.getFileSystemManager()
  7851. fs.unlink({
  7852. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7853. success(res) {
  7854. console.log(res)
  7855. },
  7856. fail(res) {
  7857. console.error(res)
  7858. }
  7859. })
  7860. // 同步接口
  7861. try {
  7862. const res = fs.unlinkSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
  7863. console.log(res)
  7864. } catch(e) {
  7865. console.error(e)
  7866. }
  7867. ``` */
  7868. unlink(option: UnlinkOption): void
  7869. /** [FileSystemManager.unlinkSync(string filePath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unlinkSync.html)
  7870. *
  7871. * [FileSystemManager.unlink](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unlink.html) 的同步版本
  7872. *
  7873. * **示例代码**
  7874. *
  7875. * ```js
  7876. const fs = wx.getFileSystemManager()
  7877. fs.unlink({
  7878. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7879. success(res) {
  7880. console.log(res)
  7881. },
  7882. fail(res) {
  7883. console.error(res)
  7884. }
  7885. })
  7886. // 同步接口
  7887. try {
  7888. const res = fs.unlinkSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
  7889. console.log(res)
  7890. } catch(e) {
  7891. console.error(e)
  7892. }
  7893. ``` */
  7894. unlinkSync(
  7895. /** 要删除的文件路径 (本地路径) */
  7896. filePath: string
  7897. ): void
  7898. /** [FileSystemManager.unzip(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unzip.html)
  7899. *
  7900. * 解压文件
  7901. *
  7902. * **示例代码**
  7903. *
  7904. * ```js
  7905. const fs = wx.getFileSystemManager()
  7906. fs.unzip({
  7907. zipFilePath: `${wx.env.USER_DATA_PATH}/example.zip`,
  7908. targetPath: '${wx.env.USER_DATA_PATH}/example',
  7909. success(res) {
  7910. console.log(res)
  7911. },
  7912. fail(res) {
  7913. console.error(res)
  7914. }
  7915. })
  7916. ``` */
  7917. unzip(option: UnzipOption): void
  7918. /** [FileSystemManager.write(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.write.html)
  7919. *
  7920. * 需要基础库: `2.16.1`
  7921. *
  7922. * 写入文件
  7923. *
  7924. * **示例代码**
  7925. *
  7926. * ```js
  7927. const fs = wx.getFileSystemManager()
  7928. // 打开文件
  7929. fs.open({
  7930. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7931. flag: 'a+',
  7932. success(res) {
  7933. // 写入文件
  7934. fs.write({
  7935. fd: res.fd,
  7936. data: 'some text',
  7937. success(res) {
  7938. console.log(res.bytesWritten)
  7939. }
  7940. })
  7941. }
  7942. })
  7943. ``` */
  7944. write(option: WriteOption): void
  7945. /** [FileSystemManager.writeFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeFile.html)
  7946. *
  7947. * 写文件
  7948. *
  7949. * **示例代码**
  7950. *
  7951. * ```js
  7952. const fs = wx.getFileSystemManager()
  7953. fs.writeFile({
  7954. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7955. data: 'some text or arrayBuffer',
  7956. encoding: 'utf8',
  7957. success(res) {
  7958. console.log(res)
  7959. },
  7960. fail(res) {
  7961. console.error(res)
  7962. }
  7963. })
  7964. // 同步接口
  7965. try {
  7966. const res = fs.writeFileSync(
  7967. `${wx.env.USER_DATA_PATH}/hello.txt`,
  7968. 'some text or arrayBuffer',
  7969. 'utf8'
  7970. )
  7971. console.log(res)
  7972. } catch(e) {
  7973. console.error(e)
  7974. }
  7975. ``` */
  7976. writeFile(option: WriteFileOption): void
  7977. /** [FileSystemManager.writeFileSync(string filePath, string|ArrayBuffer data, string encoding)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeFileSync.html)
  7978. *
  7979. * [FileSystemManager.writeFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeFile.html) 的同步版本
  7980. *
  7981. * **示例代码**
  7982. *
  7983. * ```js
  7984. const fs = wx.getFileSystemManager()
  7985. fs.writeFile({
  7986. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  7987. data: 'some text or arrayBuffer',
  7988. encoding: 'utf8',
  7989. success(res) {
  7990. console.log(res)
  7991. },
  7992. fail(res) {
  7993. console.error(res)
  7994. }
  7995. })
  7996. // 同步接口
  7997. try {
  7998. const res = fs.writeFileSync(
  7999. `${wx.env.USER_DATA_PATH}/hello.txt`,
  8000. 'some text or arrayBuffer',
  8001. 'utf8'
  8002. )
  8003. console.log(res)
  8004. } catch(e) {
  8005. console.error(e)
  8006. }
  8007. ``` */
  8008. writeFileSync(
  8009. /** 要写入的文件路径 (本地路径) */
  8010. filePath: string,
  8011. /** 要写入的文本或二进制数据 */
  8012. data: string | ArrayBuffer,
  8013. /** 指定写入文件的字符编码
  8014. *
  8015. * 参数 encoding 可选值:
  8016. * - 'ascii': ;
  8017. * - 'base64': ;
  8018. * - 'binary': ;
  8019. * - 'hex': ;
  8020. * - 'ucs2': 以小端序读取;
  8021. * - 'ucs-2': 以小端序读取;
  8022. * - 'utf16le': 以小端序读取;
  8023. * - 'utf-16le': 以小端序读取;
  8024. * - 'utf-8': ;
  8025. * - 'utf8': ;
  8026. * - 'latin1': ; */
  8027. encoding?:
  8028. | 'ascii'
  8029. | 'base64'
  8030. | 'binary'
  8031. | 'hex'
  8032. | 'ucs2'
  8033. | 'ucs-2'
  8034. | 'utf16le'
  8035. | 'utf-16le'
  8036. | 'utf-8'
  8037. | 'utf8'
  8038. | 'latin1'
  8039. ): void
  8040. /** [[ReadResult](https://developers.weixin.qq.com/minigame/dev/api/file/ReadResult.html) FileSystemManager.readSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readSync.html)
  8041. *
  8042. * 需要基础库: `2.16.1`
  8043. *
  8044. * 读文件
  8045. *
  8046. * **示例代码**
  8047. *
  8048. * ```js
  8049. const fs = wx.getFileSystemManager()
  8050. const ab = new ArrayBuffer(1024)
  8051. const fd = fs.openSync({
  8052. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8053. flag: 'a+'
  8054. })
  8055. const res = fs.readSync({
  8056. fd: fd,
  8057. arrayBuffer: ab,
  8058. length: 10
  8059. })
  8060. console.log(res)
  8061. ``` */
  8062. readSync(option: ReadSyncOption): ReadResult
  8063. /** [[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html) FileSystemManager.fstatSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.fstatSync.html)
  8064. *
  8065. * 需要基础库: `2.16.1`
  8066. *
  8067. * 同步获取文件的状态信息
  8068. *
  8069. * **示例代码**
  8070. *
  8071. * ```js
  8072. const fs = wx.getFileSystemManager()
  8073. const fd = fs.openSync({
  8074. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8075. flag: 'a+'
  8076. })
  8077. const stats = fs.fstatSync({fd: fd})
  8078. console.log(stats)
  8079. ``` */
  8080. fstatSync(option: FstatSyncOption): Stats
  8081. /** [[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)|Array.&lt;[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)&gt; FileSystemManager.statSync(string path, boolean recursive)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.statSync.html)
  8082. *
  8083. * [FileSystemManager.stat](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.stat.html) 的同步版本 */
  8084. statSync(
  8085. /** 文件/目录路径 (本地路径) */
  8086. path: string,
  8087. /** 需要基础库: `2.3.0`
  8088. *
  8089. * 是否递归获取目录下的每个文件的 Stats 信息 */
  8090. recursive?: boolean
  8091. ): Stats | Stats[]
  8092. /** [[WriteResult](https://developers.weixin.qq.com/minigame/dev/api/file/WriteResult.html) FileSystemManager.writeSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeSync.html)
  8093. *
  8094. * 需要基础库: `2.16.1`
  8095. *
  8096. * 同步写入文件
  8097. *
  8098. * **示例代码**
  8099. *
  8100. * ```js
  8101. const fs = wx.getFileSystemManager()
  8102. const fd = fs.openSync({
  8103. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8104. flag: 'a+'
  8105. })
  8106. const res = fs.writeSync({
  8107. fd: fd,
  8108. data: 'some text'
  8109. })
  8110. console.log(res.bytesWritten)
  8111. ``` */
  8112. writeSync(option: WriteSyncOption): WriteResult
  8113. /** [string FileSystemManager.openSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html)
  8114. *
  8115. * 需要基础库: `2.16.1`
  8116. *
  8117. * 同步打开文件,返回文件描述符
  8118. *
  8119. * **示例代码**
  8120. *
  8121. * ```js
  8122. const fs = wx.getFileSystemManager()
  8123. const fd = fs.openSync({
  8124. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8125. flag: 'a+'
  8126. })
  8127. console.log(fd)
  8128. ``` */
  8129. openSync(option: OpenSyncOption): string
  8130. /** [string FileSystemManager.saveFileSync(string tempFilePath, string filePath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.saveFileSync.html)
  8131. *
  8132. * [FileSystemManager.saveFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.saveFile.html) 的同步版本 */
  8133. saveFileSync(
  8134. /** 临时存储文件路径 (本地路径) */
  8135. tempFilePath: string,
  8136. /** 要存储的文件路径 (本地路径) */
  8137. filePath?: string
  8138. ): string
  8139. /** [string|ArrayBuffer FileSystemManager.readFileSync(string filePath, string encoding, number position, number length)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readFileSync.html)
  8140. *
  8141. * [FileSystemManager.readFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readFile.html) 的同步版本
  8142. *
  8143. * **示例代码**
  8144. *
  8145. * ```js
  8146. const fs = wx.getFileSystemManager()
  8147. fs.readFile({
  8148. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8149. encoding: 'utf8',
  8150. position: 0,
  8151. success(res) {
  8152. console.log(res.data)
  8153. },
  8154. fail(res) {
  8155. console.error(res)
  8156. }
  8157. })
  8158. // 同步接口
  8159. try {
  8160. const res = fs.readFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'utf8', 0)
  8161. console.log(res)
  8162. } catch(e) {
  8163. console.error(e)
  8164. }
  8165. ``` */
  8166. readFileSync(
  8167. /** 要读取的文件的路径 (本地路径) */
  8168. filePath: string,
  8169. /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
  8170. *
  8171. * 参数 encoding 可选值:
  8172. * - 'ascii': ;
  8173. * - 'base64': ;
  8174. * - 'binary': ;
  8175. * - 'hex': ;
  8176. * - 'ucs2': 以小端序读取;
  8177. * - 'ucs-2': 以小端序读取;
  8178. * - 'utf16le': 以小端序读取;
  8179. * - 'utf-16le': 以小端序读取;
  8180. * - 'utf-8': ;
  8181. * - 'utf8': ;
  8182. * - 'latin1': ; */
  8183. encoding?:
  8184. | 'ascii'
  8185. | 'base64'
  8186. | 'binary'
  8187. | 'hex'
  8188. | 'ucs2'
  8189. | 'ucs-2'
  8190. | 'utf16le'
  8191. | 'utf-16le'
  8192. | 'utf-8'
  8193. | 'utf8'
  8194. | 'latin1',
  8195. /** 需要基础库: `2.10.0`
  8196. *
  8197. * 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
  8198. position?: number,
  8199. /** 需要基础库: `2.10.0`
  8200. *
  8201. * 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
  8202. length?: number
  8203. ): string | ArrayBuffer
  8204. /** [undefined FileSystemManager.closeSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.closeSync.html)
  8205. *
  8206. * 需要基础库: `2.16.1`
  8207. *
  8208. * 同步关闭文件
  8209. *
  8210. * **示例代码**
  8211. *
  8212. * ```js
  8213. const fs = wx.getFileSystemManager()
  8214. const fd = fs.openSync({
  8215. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8216. flag: 'a+'
  8217. })
  8218. // 关闭文件
  8219. fs.closeSync({fd: fd})
  8220. ``` */
  8221. closeSync(option: CloseSyncOption): undefined
  8222. /** [undefined FileSystemManager.ftruncateSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.ftruncateSync.html)
  8223. *
  8224. * 需要基础库: `2.16.1`
  8225. *
  8226. * 对文件内容进行截断操作
  8227. *
  8228. * **示例代码**
  8229. *
  8230. * ```js
  8231. const fs = wx.getFileSystemManager()
  8232. const fd = fs.openSync({
  8233. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8234. flag: 'a+'
  8235. })
  8236. fs.ftruncateSync({
  8237. fd: fd,
  8238. length: 10 // 从第10个字节开始截断文件
  8239. })
  8240. ``` */
  8241. ftruncateSync(option: FtruncateSyncOption): undefined
  8242. /** [undefined FileSystemManager.truncateSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.truncateSync.html)
  8243. *
  8244. * 需要基础库: `2.16.1`
  8245. *
  8246. * 对文件内容进行截断操作 (truncate 的同步版本)
  8247. *
  8248. * **示例代码**
  8249. *
  8250. * ```js
  8251. const fs = wx.getFileSystemManager()
  8252. fs.truncateSync({
  8253. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  8254. length: 10, // 从第10个字节开始截断
  8255. })
  8256. ``` */
  8257. truncateSync(option: TruncateSyncOption): undefined
  8258. }
  8259. interface FstatSyncError {
  8260. /** 错误信息
  8261. *
  8262. * | 错误信息 | 说明 |
  8263. * | - | - |
  8264. * | bad file descriptor | 无效的文件描述符 |
  8265. * | fail permission denied | 指定的 fd 路径没有读权限 | */ errMsg: string
  8266. /** 错误码
  8267. *
  8268. * | 错误信息 | 说明 |
  8269. * | - | - |
  8270. * | bad file descriptor | 无效的文件描述符 |
  8271. * | fail permission denied | 指定的 fd 路径没有读权限 | */ errCode: number
  8272. }
  8273. interface FtruncateSyncError {
  8274. /** 错误信息
  8275. *
  8276. * | 错误信息 | 说明 |
  8277. * | - | - |
  8278. * | bad file descriptor | 无效的文件描述符 |
  8279. * | fail permission denied | 指定的 fd 没有写权限 |
  8280. * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
  8281. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
  8282. /** 错误码
  8283. *
  8284. * | 错误信息 | 说明 |
  8285. * | - | - |
  8286. * | bad file descriptor | 无效的文件描述符 |
  8287. * | fail permission denied | 指定的 fd 没有写权限 |
  8288. * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
  8289. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
  8290. }
  8291. interface GameBanner {
  8292. /** [GameBanner.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.offError.html)
  8293. *
  8294. * 取消监听小游戏推荐banner组件加载错误事件 */
  8295. offError(
  8296. /** 小游戏推荐banner组件加载错误事件的回调函数 */
  8297. callback?: GameBannerOffErrorCallback
  8298. ): void
  8299. /** [GameBanner.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.offLoad.html)
  8300. *
  8301. * 取消监听小游戏推荐banner组件加载成功事件 */
  8302. offLoad(
  8303. /** 小游戏推荐banner组件加载成功事件的回调函数 */
  8304. callback?: OffLoadCallback
  8305. ): void
  8306. /** [GameBanner.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.offResize.html)
  8307. *
  8308. * 取消监听小游戏推荐banner组件位置或者尺寸改变事件 */
  8309. offResize(
  8310. /** 小游戏推荐banner组件位置或者尺寸改变事件的回调函数 */
  8311. callback?: GameBannerOffResizeCallback
  8312. ): void
  8313. /** [GameBanner.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.onError.html)
  8314. *
  8315. * 监听小游戏推荐banner组件加载错误事件。
  8316. *
  8317. * **错误码信息与解决方案表**
  8318. *
  8319. * | 代码 | 异常情况 | 理由 | 解决方案 |
  8320. * | ------ | -------------- | --------------- | -------------------------- |
  8321. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  8322. * | 1002 | 推荐位id无效 | 可能是拼写错误、或者误用了其他小游戏的推荐位id | 请重新前往mp.weixin.qq.com确认推荐位id。 |
  8323. * | 1004 | 无适合的推荐 | 推荐不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览推荐 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  8324. * | 1008 | 推荐位已关闭 | 该推荐位的推荐能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应推荐位的展现。| */
  8325. onError(
  8326. /** 小游戏推荐banner组件加载错误事件的回调函数 */
  8327. callback: GameBannerOnErrorCallback
  8328. ): void
  8329. /** [GameBanner.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.onLoad.html)
  8330. *
  8331. * 监听小游戏推荐banner组件加载成功事件。 */
  8332. onLoad(
  8333. /** 小游戏推荐banner组件加载成功事件的回调函数 */
  8334. callback: OnLoadCallback
  8335. ): void
  8336. /** [GameBanner.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.onResize.html)
  8337. *
  8338. * 监听小游戏推荐banner组件位置或者尺寸改变事件。 */
  8339. onResize(
  8340. /** 小游戏推荐banner组件位置或者尺寸改变事件的回调函数 */
  8341. callback: GameBannerOnResizeCallback
  8342. ): void
  8343. /** [Promise GameBanner.destroy()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.destroy.html)
  8344. *
  8345. * 销毁小游戏推荐banner组件,组件销毁后所有方法和事件都将失效。 */
  8346. destroy(): Promise<any>
  8347. /** [Promise GameBanner.hide()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.hide.html)
  8348. *
  8349. * 隐藏小游戏推荐banner组件。 */
  8350. hide(): Promise<any>
  8351. /** [Promise GameBanner.show()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.show.html)
  8352. *
  8353. * 显示小游戏推荐banner组件。 */
  8354. show(): Promise<any>
  8355. }
  8356. interface GameClubButton {
  8357. /** [GameClubButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.destroy.html)
  8358. *
  8359. * 销毁游戏圈按钮 */
  8360. destroy(): void
  8361. /** [GameClubButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.hide.html)
  8362. *
  8363. * 隐藏游戏圈按钮 */
  8364. hide(): void
  8365. /** [GameClubButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.offTap.html)
  8366. *
  8367. * 取消监听游戏圈按钮的点击事件 */
  8368. offTap(
  8369. /** 游戏圈按钮的点击事件的回调函数 */
  8370. callback?: GameClubButtonOffTapCallback
  8371. ): void
  8372. /** [GameClubButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.onTap.html)
  8373. *
  8374. * 监听游戏圈按钮的点击事件 */
  8375. onTap(
  8376. /** 游戏圈按钮的点击事件的回调函数 */
  8377. callback: GameClubButtonOnTapCallback
  8378. ): void
  8379. /** [GameClubButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.show.html)
  8380. *
  8381. * 显示游戏圈按钮 */
  8382. show(): void
  8383. }
  8384. interface GameIcon {
  8385. /** [GameIcon.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.offError.html)
  8386. *
  8387. * 取消监听小游戏推荐icon组件加载错误事件 */
  8388. offError(
  8389. /** 小游戏推荐icon组件加载错误事件的回调函数 */
  8390. callback?: GameBannerOffErrorCallback
  8391. ): void
  8392. /** [GameIcon.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.offLoad.html)
  8393. *
  8394. * 取消监听小游戏推荐icon组件加载成功事件 */
  8395. offLoad(
  8396. /** 小游戏推荐icon组件加载成功事件的回调函数 */
  8397. callback?: OffLoadCallback
  8398. ): void
  8399. /** [GameIcon.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.offResize.html)
  8400. *
  8401. * 取消监听小游戏推荐icon组件位置或者尺寸改变事件 */
  8402. offResize(
  8403. /** 小游戏推荐icon组件位置或者尺寸改变事件的回调函数 */
  8404. callback?: GameBannerOffResizeCallback
  8405. ): void
  8406. /** [GameIcon.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.onError.html)
  8407. *
  8408. * 监听小游戏推荐icon组件加载错误事件。
  8409. *
  8410. * **错误码信息与解决方案表**
  8411. *
  8412. * | 代码 | 异常情况 | 理由 | 解决方案 |
  8413. * | ------ | -------------- | --------------- | -------------------------- |
  8414. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  8415. * | 1002 | 推荐位id无效 | 可能是拼写错误、或者误用了其他小游戏的推荐位id | 请重新前往mp.weixin.qq.com确认推荐位id。 |
  8416. * | 1004 | 无适合的推荐 | 推荐不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览推荐 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  8417. * | 1008 | 推荐位已关闭 | 该推荐位的推荐能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应推荐位的展现。|
  8418. * | 1009 | 推荐位id类型错误| 可能复制了其他类型的推荐位id | 请前往mp.weixin.qq.com 确认推荐位id | */
  8419. onError(
  8420. /** 小游戏推荐icon组件加载错误事件的回调函数 */
  8421. callback: GameBannerOnErrorCallback
  8422. ): void
  8423. /** [GameIcon.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.onLoad.html)
  8424. *
  8425. * 监听小游戏推荐icon组件加载成功事件。 */
  8426. onLoad(
  8427. /** 小游戏推荐icon组件加载成功事件的回调函数 */
  8428. callback: OnLoadCallback
  8429. ): void
  8430. /** [GameIcon.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.onResize.html)
  8431. *
  8432. * 监听小游戏推荐icon组件位置或者尺寸改变事件。回调函数回抛出一个数组,包含被渲染出来的游戏的信息,该数组为组件实例属性icons的子集。 */
  8433. onResize(
  8434. /** 小游戏推荐icon组件位置或者尺寸改变事件的回调函数 */
  8435. callback: GameBannerOnResizeCallback
  8436. ): void
  8437. /** [Promise GameIcon.destroy()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.destroy.html)
  8438. *
  8439. * 销毁小游戏推荐icon组件,组件销毁后所有方法和事件都将失效。 */
  8440. destroy(): Promise<any>
  8441. /** [Promise GameIcon.hide()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.hide.html)
  8442. *
  8443. * 隐藏小游戏推荐icon组件。 */
  8444. hide(): Promise<any>
  8445. /** [Promise GameIcon.load()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.load.html)
  8446. *
  8447. * 小游戏推荐icon组件加载数据接口。 */
  8448. load(): Promise<any>
  8449. /** [Promise GameIcon.show()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.show.html)
  8450. *
  8451. * 显示小游戏推荐icon组件。 */
  8452. show(): Promise<any>
  8453. }
  8454. interface GamePortal {
  8455. /** [GamePortal.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.offClose.html)
  8456. *
  8457. * 取消监听小游戏推荐弹窗组件的关闭事件 */
  8458. offClose(
  8459. /** 小游戏推荐弹窗组件的关闭事件的回调函数 */
  8460. callback?: UDPSocketOffCloseCallback
  8461. ): void
  8462. /** [GamePortal.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.offError.html)
  8463. *
  8464. * 取消监听小游戏推荐弹窗组件加载错误事件 */
  8465. offError(
  8466. /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
  8467. callback?: GamePortalOffErrorCallback
  8468. ): void
  8469. /** [GamePortal.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.offLoad.html)
  8470. *
  8471. * 取消监听小游戏推荐弹窗组件的数据加载成功事件 */
  8472. offLoad(
  8473. /** 小游戏推荐弹窗组件的数据加载成功事件的回调函数 */
  8474. callback?: OffLoadCallback
  8475. ): void
  8476. /** [GamePortal.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.onClose.html)
  8477. *
  8478. * 监听小游戏推荐弹窗组件的关闭事件。 */
  8479. onClose(
  8480. /** 小游戏推荐弹窗组件的关闭事件的回调函数 */
  8481. callback: UDPSocketOnCloseCallback
  8482. ): void
  8483. /** [GamePortal.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.onError.html)
  8484. *
  8485. * 监听小游戏推荐弹窗组件加载错误事件。
  8486. *
  8487. * **错误码信息与解决方案表**
  8488. *
  8489. * | 代码 | 异常情况 | 理由 | 解决方案 |
  8490. * | ------ | -------------- | --------------- | -------------------------- |
  8491. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  8492. * | 1002 | 推荐位id无效 | 可能是拼写错误、或者误用了其他小游戏的推荐位id | 请重新前往mp.weixin.qq.com确认推荐位id。 |
  8493. * | 1004 | 无适合的推荐 | 推荐不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览推荐 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  8494. * | 1008 | 推荐位已关闭 | 该推荐位的推荐能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应推荐位的展现。| */
  8495. onError(
  8496. /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
  8497. callback: GamePortalOnErrorCallback
  8498. ): void
  8499. /** [GamePortal.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.onLoad.html)
  8500. *
  8501. * 监听小游戏推荐弹窗组件的数据加载成功事件。 */
  8502. onLoad(
  8503. /** 小游戏推荐弹窗组件的数据加载成功事件的回调函数 */
  8504. callback: OnLoadCallback
  8505. ): void
  8506. /** [Promise GamePortal.destroy()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.destroy.html)
  8507. *
  8508. * 销毁小游戏推荐弹窗组件,组件销毁后,组件的方法和事件都将失效。 */
  8509. destroy(): Promise<any>
  8510. /** [Promise GamePortal.load()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.load.html)
  8511. *
  8512. * 小游戏推荐弹窗组件加载数据接口。 */
  8513. load(): Promise<any>
  8514. /** [Promise GamePortal.show()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.show.html)
  8515. *
  8516. * 显示小游戏推荐弹窗组件。 */
  8517. show(): Promise<any>
  8518. }
  8519. interface GameRecorder {
  8520. /** [GameRecorder.off(string event, function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.off.html)
  8521. *
  8522. * 需要基础库: `2.8.0`
  8523. *
  8524. * 取消监听录制事件。当对应事件触发时,该回调函数不再执行。 */
  8525. off(
  8526. /** 事件名
  8527. *
  8528. * 参数 event 可选值:
  8529. * - 'start': 录制开始事件。当调用 [GameRecorder.start()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.start.html) 且客户端真正开始了对游戏画面录制时触发该事件。;
  8530. * - 'stop': 录制结束事件。当调用 [GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html) 且客户端真正停止了对游戏画面录制时触发该事件。;
  8531. * - 'pause': 录制暂停事件。当调用 [GameRecorder.pause()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.pause.html) 且客户端真正暂停了对游戏画面录制时触发该事件。;
  8532. * - 'resume': 录制恢复事件。当调用 [GameRecorder.resume()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.resume.html) 且客户端真正恢复了对游戏画面录制时触发该事件。;
  8533. * - 'abort': 录制取消事件。当调用 [GameRecorder.abort()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.abort.html) 且客户端真正取消了对游戏画面录制时触发该事件。;
  8534. * - 'timeUpdate': 录制时间更新事件。在录制过程中触发该事件。;
  8535. * - 'error': 错误事件。当录制和分享过程中发生错误时触发该事件。录制是指当调用 [GameRecorder](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.html) 的接口进行录制;分享是指用户点击 [GameRecorderShareButton](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.html) 发起编辑界面并进行分享的过程。; */
  8536. event:
  8537. | 'start'
  8538. | 'stop'
  8539. | 'pause'
  8540. | 'resume'
  8541. | 'abort'
  8542. | 'timeUpdate'
  8543. | 'error',
  8544. /** 事件触发时不再执行的回调函数 */
  8545. callback: (...args: any[]) => any
  8546. ): void
  8547. /** [GameRecorder.on(string event, function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.on.html)
  8548. *
  8549. * 需要基础库: `2.8.0`
  8550. *
  8551. * 注册监听录制事件的回调函数。当对应事件触发时,回调函数会被执行。
  8552. *
  8553. * **事件参数**
  8554. *
  8555. * 除了 timeUpdate error stop 事件外,其他事件都是无参的
  8556. *
  8557. * __timeUpdate__
  8558. *
  8559. * | 属性 | 类型 | 说明 |
  8560. * | -- | --- | --- |
  8561. * | currentTime | number | 当前视频录制到第几秒 |
  8562. *
  8563. * ```javascript
  8564. const recorder = wx.getGameRecorder()
  8565. recorder.on('timeUpdate', res => {
  8566. console.log(res.currentTime)
  8567. })
  8568. ```
  8569. *
  8570. * __error__
  8571. *
  8572. * | 属性 | 类型 | 说明 |
  8573. * | -- | --- | --- |
  8574. * | code | number | 错误码 |
  8575. * | message | string | 错误信息 |
  8576. *
  8577. * ```javascript
  8578. const recorder = wx.getGameRecorder()
  8579. recorder.on('error', res => {
  8580. console.log('错误码', res.error.code)
  8581. console.log('错误信息', res.error.message)
  8582. // 对错误码进行判断
  8583. if (res.error.code === wx.error.GameRecorder_StartWhileAlreadyStartRecording) {
  8584. }
  8585. })
  8586. ```
  8587. *
  8588. * __stop__
  8589. *
  8590. * | 属性 | 类型 | 说明 |
  8591. * | -- | --- | --- |
  8592. * | duration | number | 视频的时长,单位 ms 毫秒 |
  8593. *
  8594. * ```javascript
  8595. const recorder = wx.getGameRecorder()
  8596. recorder.on('stop', res => {
  8597. console.log('视频时长'), res.duration)
  8598. })
  8599. ``` */
  8600. on(
  8601. /** 事件名
  8602. *
  8603. * 参数 event 可选值:
  8604. * - 'start': 录制开始事件。当调用 [GameRecorder.start()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.start.html) 且客户端真正开始了对游戏画面录制时触发该事件。;
  8605. * - 'stop': 录制结束事件。当调用 [GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html) 且客户端真正停止了对游戏画面录制时触发该事件。;
  8606. * - 'pause': 录制暂停事件。当调用 [GameRecorder.pause()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.pause.html) 且客户端真正暂停了对游戏画面录制时触发该事件。;
  8607. * - 'resume': 录制恢复事件。当调用 [GameRecorder.resume()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.resume.html) 且客户端真正恢复了对游戏画面录制时触发该事件。;
  8608. * - 'abort': 录制取消事件。当调用 [GameRecorder.abort()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.abort.html) 且客户端真正取消了对游戏画面录制时触发该事件。;
  8609. * - 'timeUpdate': 录制时间更新事件。在录制过程中触发该事件。;
  8610. * - 'error': 错误事件。当录制和分享过程中发生错误时触发该事件。录制是指当调用 [GameRecorder](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.html) 的接口进行录制;分享是指用户点击 [GameRecorderShareButton](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.html) 发起编辑界面并进行分享的过程。; */
  8611. event:
  8612. | 'start'
  8613. | 'stop'
  8614. | 'pause'
  8615. | 'resume'
  8616. | 'abort'
  8617. | 'timeUpdate'
  8618. | 'error',
  8619. /** 事件触发时执行的回调函数 */
  8620. callback: (...args: any[]) => any
  8621. ): void
  8622. /** [GameRecorder.start(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.start.html)
  8623. *
  8624. * 需要基础库: `2.8.0`
  8625. *
  8626. * 开始录制游戏画面 */
  8627. start(option: GameRecorderStartOption): void
  8628. /** [Promise GameRecorder.abort()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.abort.html)
  8629. *
  8630. * 需要基础库: `2.8.0`
  8631. *
  8632. * 放弃录制游戏画面。此时已经录制的内容会被丢弃。 */
  8633. abort(): Promise<any>
  8634. /** [Promise GameRecorder.pause()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.pause.html)
  8635. *
  8636. * 需要基础库: `2.8.0`
  8637. *
  8638. * 暂停录制游戏画面。 */
  8639. pause(): Promise<any>
  8640. /** [Promise GameRecorder.resume()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.resume.html)
  8641. *
  8642. * 需要基础库: `2.8.0`
  8643. *
  8644. * 恢复录制游戏画面。 */
  8645. resume(): Promise<any>
  8646. /** [Promise GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html)
  8647. *
  8648. * 需要基础库: `2.8.0`
  8649. *
  8650. * 结束录制游戏画面。结束录制后可以发起分享。 */
  8651. stop(): Promise<any>
  8652. /** [boolean GameRecorder.isAtempoSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isAtempoSupported.html)
  8653. *
  8654. * 需要基础库: `2.10.0`
  8655. *
  8656. * 获取是否支持调节录制视频的播放速率 */
  8657. isAtempoSupported(): boolean
  8658. /** [boolean GameRecorder.isFrameSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isFrameSupported.html)
  8659. *
  8660. * 需要基础库: `2.8.0`
  8661. *
  8662. * 获取是否支持录制游戏画面 */
  8663. isFrameSupported(): boolean
  8664. /** [boolean GameRecorder.isSoundSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isSoundSupported.html)
  8665. *
  8666. * 需要基础库: `2.8.0`
  8667. *
  8668. * 获取是否在录制游戏画面的同时支持录制游戏音频的信息 */
  8669. isSoundSupported(): boolean
  8670. /** [boolean GameRecorder.isVolumeSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isVolumeSupported.html)
  8671. *
  8672. * 需要基础库: `2.10.0`
  8673. *
  8674. * 获取是否支持调节录制视频的音量 */
  8675. isVolumeSupported(): boolean
  8676. }
  8677. interface GameRecorderError {
  8678. /** 错误信息
  8679. *
  8680. * | 错误码 | 错误信息 | 说明 |
  8681. * | - | - | - |
  8682. * | wx.error.GameRecorder_UnknownError | unknown error | 未知错误,没有被归纳到的错误 |
  8683. * | wx.error.GameRecorder_InternalFailed | internal failed | 游戏画面录制 SDK 内部错误 |
  8684. * | wx.error.GameRecorder_NotSupported | frame not supported | 当前设备不支持录制游戏画面 |
  8685. * | wx.error.GameRecorder_StartDurationInvalid | duration invalid | duration 参数不合法 |
  8686. * | wx.error.GameRecorder_StartBitRateInvalid | bitrate invalid | bitrate 参数不合法 |
  8687. * | wx.error.GameRecorder_StartFPSInvalid | fps invalid | fps 参数不合法 |
  8688. * | wx.error.GameRecorder_StartGOPInvalid | gop invalid | gop 参数不合法 |
  8689. * | wx.error.GameRecorder_StartWhileAlreadyStartRecording | start while already start recording | 在已经开始录制的情况下调用 start |
  8690. * | wx.error.GameRecorder_StartWhilePaused | start while already paused | 在已经暂停录制的情况下调用 start,此时只能调用 resume 恢复录制 |
  8691. * | wx.error.GameRecorder_PauseWhileNotStartRecording | pause while not start recording | 在还没有开始录制的情况下调用 pause |
  8692. * | wx.error.GameRecorder_PauseWhileAlreadyPaused | pause while already paused | 在已经暂停录制的情况下调用 pause |
  8693. * | wx.error.GameRecorder_ResumeWhileNotStartRecording | resume while not start recording | 在还没有开始录制的情况下调用 resume |
  8694. * | wx.error.GameRecorder_ResumeWhileRecording | resume while recording | 在录制中调用 resume,调用 resume 只能在暂停状态下 |
  8695. * | wx.error.GameRecorder_AbortWhileNotStartRecording | abort while not start recording | 在还没有开始录制的情况下调用 abort |
  8696. * | wx.error.GameRecorder_StopWhileNotStartRecording | stop while not start recording | 在还没有开始录制的情况下调用 stop |
  8697. * | wx.error.GameRecorder_NoVideo | no recorded video | 在还没有一个录制好的对局回放的情况下发起分享 |
  8698. * | wx.error.GameRecorder_BGMNotFound | bgm not found | share.bgm 指定的额背景音乐不存在 |
  8699. * | wx.error.GameRecorder_TimeRangeInvalid | time range invalid | share.timeRange 不合法 |
  8700. * | wx.error.GameRecorder_EditDurationOutOfLimit | duration out of limit | share.timeRange 的所有片段的总和超出上限 |
  8701. * | wx.error.GameRecorder_TimeRangeTooShort | time range too short.It should be longer than 2s | share.timeRange 太短 | */ errMsg: string
  8702. /** 错误码
  8703. *
  8704. * | 错误码 | 错误信息 | 说明 |
  8705. * | - | - | - |
  8706. * | wx.error.GameRecorder_UnknownError | unknown error | 未知错误,没有被归纳到的错误 |
  8707. * | wx.error.GameRecorder_InternalFailed | internal failed | 游戏画面录制 SDK 内部错误 |
  8708. * | wx.error.GameRecorder_NotSupported | frame not supported | 当前设备不支持录制游戏画面 |
  8709. * | wx.error.GameRecorder_StartDurationInvalid | duration invalid | duration 参数不合法 |
  8710. * | wx.error.GameRecorder_StartBitRateInvalid | bitrate invalid | bitrate 参数不合法 |
  8711. * | wx.error.GameRecorder_StartFPSInvalid | fps invalid | fps 参数不合法 |
  8712. * | wx.error.GameRecorder_StartGOPInvalid | gop invalid | gop 参数不合法 |
  8713. * | wx.error.GameRecorder_StartWhileAlreadyStartRecording | start while already start recording | 在已经开始录制的情况下调用 start |
  8714. * | wx.error.GameRecorder_StartWhilePaused | start while already paused | 在已经暂停录制的情况下调用 start,此时只能调用 resume 恢复录制 |
  8715. * | wx.error.GameRecorder_PauseWhileNotStartRecording | pause while not start recording | 在还没有开始录制的情况下调用 pause |
  8716. * | wx.error.GameRecorder_PauseWhileAlreadyPaused | pause while already paused | 在已经暂停录制的情况下调用 pause |
  8717. * | wx.error.GameRecorder_ResumeWhileNotStartRecording | resume while not start recording | 在还没有开始录制的情况下调用 resume |
  8718. * | wx.error.GameRecorder_ResumeWhileRecording | resume while recording | 在录制中调用 resume,调用 resume 只能在暂停状态下 |
  8719. * | wx.error.GameRecorder_AbortWhileNotStartRecording | abort while not start recording | 在还没有开始录制的情况下调用 abort |
  8720. * | wx.error.GameRecorder_StopWhileNotStartRecording | stop while not start recording | 在还没有开始录制的情况下调用 stop |
  8721. * | wx.error.GameRecorder_NoVideo | no recorded video | 在还没有一个录制好的对局回放的情况下发起分享 |
  8722. * | wx.error.GameRecorder_BGMNotFound | bgm not found | share.bgm 指定的额背景音乐不存在 |
  8723. * | wx.error.GameRecorder_TimeRangeInvalid | time range invalid | share.timeRange 不合法 |
  8724. * | wx.error.GameRecorder_EditDurationOutOfLimit | duration out of limit | share.timeRange 的所有片段的总和超出上限 |
  8725. * | wx.error.GameRecorder_TimeRangeTooShort | time range too short.It should be longer than 2s | share.timeRange 太短 | */ errCode: number
  8726. }
  8727. interface GameRecorderShareButton {
  8728. /** [GameRecorderShareButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.hide.html)
  8729. *
  8730. * 需要基础库: `2.8.0`
  8731. *
  8732. * 隐藏游戏对局回放分享按钮 */
  8733. hide(): void
  8734. /** [GameRecorderShareButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.offTap.html)
  8735. *
  8736. * 需要基础库: `2.8.0`
  8737. *
  8738. * 取消监听游戏对局回放分享按钮的点击事件 */
  8739. offTap(
  8740. /** 游戏对局回放分享按钮的点击事件的回调函数 */
  8741. callback?: GameClubButtonOffTapCallback
  8742. ): void
  8743. /** [GameRecorderShareButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.onTap.html)
  8744. *
  8745. * 需要基础库: `2.8.0`
  8746. *
  8747. * 监听游戏对局回放分享按钮的点击事件。只有当分享由于非用户取消的原因失败时,该事件的回调函数才会执行。 */
  8748. onTap(
  8749. /** 游戏对局回放分享按钮的点击事件的回调函数 */
  8750. callback: GameClubButtonOnTapCallback
  8751. ): void
  8752. /** [GameRecorderShareButton.show()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.show.html)
  8753. *
  8754. * 需要基础库: `2.8.0`
  8755. *
  8756. * 显示游戏对局回放分享按钮 */
  8757. show(): void
  8758. }
  8759. interface GameServerManager {
  8760. /** [GameServerManager.getFriendsStateData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getFriendsStateData.html)
  8761. *
  8762. * 需要基础库: `2.9.4`
  8763. *
  8764. * 获取所有好友的在线状态及信息。该接口需要用户授权,且只在开放数据域下可用。 */
  8765. getFriendsStateData(option?: GetFriendsStateDataOption): void
  8766. /** [GameServerManager.offBeKickedOut(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offBeKickedOut.html)
  8767. *
  8768. * 取消监听自己被踢出当前房间 */
  8769. offBeKickedOut(
  8770. /** 的回调函数 */
  8771. callback?: OffBeKickedOutCallback
  8772. ): void
  8773. /** [GameServerManager.offBroadcast(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offBroadcast.html)
  8774. *
  8775. * 取消监听收到同个房间内的广播消息 */
  8776. offBroadcast(
  8777. /** 的回调函数 */
  8778. callback?: OffBroadcastCallback
  8779. ): void
  8780. /** [GameServerManager.offDisconnect(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offDisconnect.html)
  8781. *
  8782. * 取消监听断开连接,收到此事件 */
  8783. offDisconnect(
  8784. /** 断开连接,收到此事件的回调函数 */
  8785. callback?: OffDisconnectCallback
  8786. ): void
  8787. /** [GameServerManager.offGameEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offGameEnd.html)
  8788. *
  8789. * 取消监听帧同步游戏结束 */
  8790. offGameEnd(
  8791. /** 的回调函数 */
  8792. callback?: OffGameEndCallback
  8793. ): void
  8794. /** [GameServerManager.offGameStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offGameStart.html)
  8795. *
  8796. * 取消监听帧同步游戏开始 */
  8797. offGameStart(
  8798. /** 的回调函数 */
  8799. callback?: OffGameStartCallback
  8800. ): void
  8801. /** [GameServerManager.offInvite(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offInvite.html)
  8802. *
  8803. * 需要基础库: `2.9.4`
  8804. *
  8805. * 取消监听接收邀请,当用户确认邀请之后会收到此事件 */
  8806. offInvite(
  8807. /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
  8808. callback?: OffInviteCallback
  8809. ): void
  8810. /** [GameServerManager.offLockStepError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offLockStepError.html)
  8811. *
  8812. * 需要基础库: `2.11.2`
  8813. *
  8814. * 取消监听帧同步出错 */
  8815. offLockStepError(
  8816. /** 的回调函数 */
  8817. callback?: OffLockStepErrorCallback
  8818. ): void
  8819. /** [GameServerManager.offLogout(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offLogout.html)
  8820. *
  8821. * 取消监听用户登出游戏服务事件 */
  8822. offLogout(
  8823. /** 用户登出游戏服务事件的回调函数 */
  8824. callback?: OffLogoutCallback
  8825. ): void
  8826. /** [GameServerManager.offMatch(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offMatch.html)
  8827. *
  8828. * 需要基础库: `2.14.4`
  8829. *
  8830. * 取消监听游戏匹配成功的事件 */
  8831. offMatch(
  8832. /** 游戏匹配成功的事件的回调函数 */
  8833. callback?: OffMatchCallback
  8834. ): void
  8835. /** [GameServerManager.offRoomInfoChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offRoomInfoChange.html)
  8836. *
  8837. * 取消监听房间信息更新 */
  8838. offRoomInfoChange(
  8839. /** 的回调函数 */
  8840. callback?: OffRoomInfoChangeCallback
  8841. ): void
  8842. /** [GameServerManager.offStateUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offStateUpdate.html)
  8843. *
  8844. * 需要基础库: `2.9.4`
  8845. *
  8846. * 取消监听好友在线状态变更(该接口需要在开放数据域使用) */
  8847. offStateUpdate(
  8848. /** 的回调函数 */
  8849. callback?: OffStateUpdateCallback
  8850. ): void
  8851. /** [GameServerManager.offSyncFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offSyncFrame.html)
  8852. *
  8853. * 取消监听收到同个房间的帧同步消息 */
  8854. offSyncFrame(
  8855. /** 的回调函数 */
  8856. callback?: OffSyncFrameCallback
  8857. ): void
  8858. /** [GameServerManager.onBeKickedOut(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onBeKickedOut.html)
  8859. *
  8860. * 监听自己被踢出当前房间 */
  8861. onBeKickedOut(
  8862. /** 的回调函数 */
  8863. callback: OnBeKickedOutCallback
  8864. ): void
  8865. /** [GameServerManager.onBroadcast(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onBroadcast.html)
  8866. *
  8867. * 监听收到同个房间内的广播消息 */
  8868. onBroadcast(
  8869. /** 的回调函数 */
  8870. callback: OnBroadcastCallback
  8871. ): void
  8872. /** [GameServerManager.onDisconnect(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onDisconnect.html)
  8873. *
  8874. * 监听断开连接,收到此事件后,需要调用 `GameServerManager.reconnect` 进行重连 */
  8875. onDisconnect(
  8876. /** 断开连接,收到此事件的回调函数 */
  8877. callback: OnDisconnectCallback
  8878. ): void
  8879. /** [GameServerManager.onGameEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onGameEnd.html)
  8880. *
  8881. * 监听帧同步游戏结束 */
  8882. onGameEnd(
  8883. /** 的回调函数 */
  8884. callback: OnGameEndCallback
  8885. ): void
  8886. /** [GameServerManager.onGameStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onGameStart.html)
  8887. *
  8888. * 监听帧同步游戏开始 */
  8889. onGameStart(
  8890. /** 的回调函数 */
  8891. callback: OnGameStartCallback
  8892. ): void
  8893. /** [GameServerManager.onInvite(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onInvite.html)
  8894. *
  8895. * 需要基础库: `2.9.4`
  8896. *
  8897. * 监听接收邀请,当用户确认邀请之后会收到此事件 */
  8898. onInvite(
  8899. /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
  8900. callback: OnInviteCallback
  8901. ): void
  8902. /** [GameServerManager.onLockStepError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onLockStepError.html)
  8903. *
  8904. * 需要基础库: `2.11.2`
  8905. *
  8906. * 监听帧同步出错 */
  8907. onLockStepError(
  8908. /** 的回调函数 */
  8909. callback: OnLockStepErrorCallback
  8910. ): void
  8911. /** [GameServerManager.onLogout(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onLogout.html)
  8912. *
  8913. * 监听用户登出游戏服务事件,可能是主动登出也可能是其他原因被动登出 */
  8914. onLogout(
  8915. /** 用户登出游戏服务事件的回调函数 */
  8916. callback: OnLogoutCallback
  8917. ): void
  8918. /** [GameServerManager.onMatch(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onMatch.html)
  8919. *
  8920. * 需要基础库: `2.14.4`
  8921. *
  8922. * 监听游戏匹配成功的事件 */
  8923. onMatch(
  8924. /** 游戏匹配成功的事件的回调函数 */
  8925. callback: OnMatchCallback
  8926. ): void
  8927. /** [GameServerManager.onRoomInfoChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onRoomInfoChange.html)
  8928. *
  8929. * 监听房间信息更新 */
  8930. onRoomInfoChange(
  8931. /** 的回调函数 */
  8932. callback: OnRoomInfoChangeCallback
  8933. ): void
  8934. /** [GameServerManager.onStateUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onStateUpdate.html)
  8935. *
  8936. * 需要基础库: `2.9.4`
  8937. *
  8938. * 监听好友在线状态变更(该接口需要在开放数据域使用) */
  8939. onStateUpdate(
  8940. /** 的回调函数 */
  8941. callback: OnStateUpdateCallback
  8942. ): void
  8943. /** [GameServerManager.onSyncFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onSyncFrame.html)
  8944. *
  8945. * 监听收到同个房间的帧同步消息 */
  8946. onSyncFrame(
  8947. /** 的回调函数 */
  8948. callback: OnSyncFrameCallback
  8949. ): void
  8950. /** [GameServerManager.startGame(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.startGame.html)
  8951. *
  8952. * 启动帧同步 */
  8953. startGame(option?: StartGameOption): void
  8954. /** [Promise GameServerManager.broadcastInRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.broadcastInRoom.html)
  8955. *
  8956. * 在房间内广播 */
  8957. broadcastInRoom(option: BroadcastInRoomOption): Promise<any>
  8958. /** [Promise GameServerManager.cancelMatch(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.cancelMatch.html)
  8959. *
  8960. * 需要基础库: `2.14.4`
  8961. *
  8962. * 取消游戏匹配 */
  8963. cancelMatch(option: CancelMatchOption): Promise<any>
  8964. /** [Promise GameServerManager.changeSeat(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.changeSeat.html)
  8965. *
  8966. * 玩家换座位 */
  8967. changeSeat(option: ChangeSeatOption): Promise<any>
  8968. /** [Promise GameServerManager.createRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.createRoom.html)
  8969. *
  8970. * 创建游戏房间 */
  8971. createRoom(option: CreateRoomOption): Promise<any>
  8972. /** [Promise GameServerManager.endGame(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.endGame.html)
  8973. *
  8974. * 结束帧同步 */
  8975. endGame(option?: EndGameOption): Promise<any>
  8976. /** [Promise GameServerManager.endStateService(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.endStateService.html)
  8977. *
  8978. * 结束游戏状态同步服务 */
  8979. endStateService(option?: EndStateServiceOption): Promise<any>
  8980. /** [Promise GameServerManager.getLastRoomInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getLastRoomInfo.html)
  8981. *
  8982. * 获取最近参与房间的 accessInfo */
  8983. getLastRoomInfo(option?: GetLastRoomInfoOption): Promise<any>
  8984. /** [Promise GameServerManager.getLostFrames(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getLostFrames.html)
  8985. *
  8986. * 补帧,补帧区间为 [beginFrameId, endFrameId),即左闭右合。 */
  8987. getLostFrames(option: GetLostFramesOption): Promise<any>
  8988. /** [Promise GameServerManager.getRoomInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getRoomInfo.html)
  8989. *
  8990. * 获取房间详情 */
  8991. getRoomInfo(option?: GetRoomInfoOption): Promise<any>
  8992. /** [Promise GameServerManager.inviteFriend(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.inviteFriend.html)
  8993. *
  8994. * 需要基础库: `2.9.4`
  8995. *
  8996. * 邀请好友,该好友的系统状态必须为在线(该接口需要在开放数据域使用) */
  8997. inviteFriend(option: InviteFriendOption): Promise<any>
  8998. /** [Promise GameServerManager.joinRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.joinRoom.html)
  8999. *
  9000. * 加入游戏房间 */
  9001. joinRoom(option: JoinRoomOption): Promise<any>
  9002. /** [Promise GameServerManager.kickoutMember(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.kickoutMember.html)
  9003. *
  9004. * 把一名玩家踢出房间(仅房主有权限) */
  9005. kickoutMember(option: KickoutMemberOption): Promise<any>
  9006. /** [Promise GameServerManager.login()](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.login.html)
  9007. *
  9008. * 登录游戏服务 */
  9009. login(): Promise<any>
  9010. /** [Promise GameServerManager.logout()](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.logout.html)
  9011. *
  9012. * 登出游戏服务 */
  9013. logout(): Promise<any>
  9014. /** [Promise GameServerManager.memberLeaveRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.memberLeaveRoom.html)
  9015. *
  9016. * 普通成员退出房间 */
  9017. memberLeaveRoom(option: MemberLeaveRoomOption): Promise<any>
  9018. /** [Promise GameServerManager.ownerLeaveRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.ownerLeaveRoom.html)
  9019. *
  9020. * 房主退出房间,`assign_owner_to_pos_num` 参数被优先处理,其次是 `assign_to_min_pos_num`,如果二者都没有被设置,则房主退出且房间销毁。 */
  9021. ownerLeaveRoom(option: OwnerLeaveRoomOption): Promise<any>
  9022. /** [Promise GameServerManager.reconnect(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.reconnect.html)
  9023. *
  9024. * 重连游戏服务。如果此时连接并未断开或游戏未开始,会直接成功;如果游戏已开始并且连接已断开,会进行重连,并返回此时服务器的最大帧号。 */
  9025. reconnect(option: ReconnectOption): Promise<any>
  9026. /** [Promise GameServerManager.restart(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.restart.html)
  9027. *
  9028. * 重启游戏并进入"组队中"的状态。如果当前房间游戏已结束,调用可进入"组队中"状态并重置所有玩家的准备状态;如果当前房间已经在"组队中"状态,调用不改变状态;如果当前房间游戏进行中,调用失败。 */
  9029. restart(option?: RestartOption): Promise<any>
  9030. /** [Promise GameServerManager.setState(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.setState.html)
  9031. *
  9032. * 需要基础库: `2.9.4`
  9033. *
  9034. * 更新玩家状态信息 */
  9035. setState(option: SetStateOption): Promise<any>
  9036. /** [Promise GameServerManager.startMatch(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.startMatch.html)
  9037. *
  9038. * 需要基础库: `2.14.4`
  9039. *
  9040. * 开始游戏匹配 */
  9041. startMatch(option: StartMatchOption): Promise<any>
  9042. /** [Promise GameServerManager.startStateService(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.startStateService.html)
  9043. *
  9044. * 需要基础库: `2.9.4`
  9045. *
  9046. * 开启状态管理服务,只有开启状态管理服务,才能获取在线好友列表以及接收好友邀请 */
  9047. startStateService(option: StartStateServiceOption): Promise<any>
  9048. /** [Promise GameServerManager.updateReadyStatus(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.updateReadyStatus.html)
  9049. *
  9050. * 更新玩家准备信息 */
  9051. updateReadyStatus(option: UpdateReadyStatusOption): Promise<any>
  9052. /** [Promise GameServerManager.uploadFrame(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.uploadFrame.html)
  9053. *
  9054. * 上传游戏帧 */
  9055. uploadFrame(option: UploadFrameOption): Promise<any>
  9056. /** [boolean GameServerManager.setInviteData(string data)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.setInviteData.html)
  9057. *
  9058. * 需要基础库: `2.9.4`
  9059. *
  9060. * 设置邀请好友附带的数据 */
  9061. setInviteData(
  9062. /** 需要设置的字符串数据 */
  9063. data: string
  9064. ): boolean
  9065. }
  9066. interface GameServerManagerError {
  9067. /** 错误信息
  9068. *
  9069. * | 错误码 | 错误信息 | 说明 |
  9070. * | - | - | - |
  9071. * | 1001 | has not logged in to server | 未登录到服务器就调用接口 |
  9072. * | 2100 | | 登录帧同步服务器超时 |
  9073. * | 2101 | | 重连帧同步服务器超时 |
  9074. * | 2200 | | 登录帧同步服务器错误或失败导致的disconnect |
  9075. * | 2201 | | 长期未收到帧导致的disconnect |
  9076. * | 2202 | | 长期未收到心跳导致的disconnect |
  9077. * | 2203 | | 断线过久,无法重连导致的disconnect |
  9078. * | 2204 | | UDPconnectionfail导致的disconnect |
  9079. * | 2300 | | UDPsocketerror |
  9080. * | 2301 | | UDPsystemerror |
  9081. * | 2303 | | UDPaddresserror |
  9082. * | 2304 | | UDPporterror |
  9083. * | 2305 | | UDPsenderror |
  9084. * | 2401 | | 登录帧同步服务器成功之前发送帧 |
  9085. * | 2402 | | frame长度超过MTU |
  9086. * | 4001 | system error | 系统错误 |
  9087. * | 4002 | record not exist | 访问记录不存在 |
  9088. * | 4003 | invalid req | 非法请求 |
  9089. * | 4005 | invalid room state | 房间状态异常 |
  9090. * | 4006 | reach room member limit | 房间到达人数上限,无法加入 |
  9091. * | 4009 | headimg and nickname is not authorized by the user | 该房间需要用户头像昵称,但用户未授权 |
  9092. * | 4010 | fail to start game | 启动游戏失败 |
  9093. * | 4011 | fail to broadcast | 广播消息失败 |
  9094. * | 4013 | buffer overflow | 自定义 buffer 超过指定大小(matchInfo 和 extInfo) |
  9095. * | 200000 | | 无效的请求参数 |
  9096. * | 200006 | | matchid此时为未打开状态 |
  9097. * | 500001 | | 用户已经在匹配队列中 |
  9098. * | 500003 | | 用户未在匹配队列中 |
  9099. * | 500005 | | 无效的match_id |
  9100. * | 500009 | | 路由到错误的服务器 | */ errMsg: string
  9101. /** 错误码
  9102. *
  9103. * | 错误码 | 错误信息 | 说明 |
  9104. * | - | - | - |
  9105. * | 1001 | has not logged in to server | 未登录到服务器就调用接口 |
  9106. * | 2100 | | 登录帧同步服务器超时 |
  9107. * | 2101 | | 重连帧同步服务器超时 |
  9108. * | 2200 | | 登录帧同步服务器错误或失败导致的disconnect |
  9109. * | 2201 | | 长期未收到帧导致的disconnect |
  9110. * | 2202 | | 长期未收到心跳导致的disconnect |
  9111. * | 2203 | | 断线过久,无法重连导致的disconnect |
  9112. * | 2204 | | UDPconnectionfail导致的disconnect |
  9113. * | 2300 | | UDPsocketerror |
  9114. * | 2301 | | UDPsystemerror |
  9115. * | 2303 | | UDPaddresserror |
  9116. * | 2304 | | UDPporterror |
  9117. * | 2305 | | UDPsenderror |
  9118. * | 2401 | | 登录帧同步服务器成功之前发送帧 |
  9119. * | 2402 | | frame长度超过MTU |
  9120. * | 4001 | system error | 系统错误 |
  9121. * | 4002 | record not exist | 访问记录不存在 |
  9122. * | 4003 | invalid req | 非法请求 |
  9123. * | 4005 | invalid room state | 房间状态异常 |
  9124. * | 4006 | reach room member limit | 房间到达人数上限,无法加入 |
  9125. * | 4009 | headimg and nickname is not authorized by the user | 该房间需要用户头像昵称,但用户未授权 |
  9126. * | 4010 | fail to start game | 启动游戏失败 |
  9127. * | 4011 | fail to broadcast | 广播消息失败 |
  9128. * | 4013 | buffer overflow | 自定义 buffer 超过指定大小(matchInfo 和 extInfo) |
  9129. * | 200000 | | 无效的请求参数 |
  9130. * | 200006 | | matchid此时为未打开状态 |
  9131. * | 500001 | | 用户已经在匹配队列中 |
  9132. * | 500003 | | 用户未在匹配队列中 |
  9133. * | 500005 | | 无效的match_id |
  9134. * | 500009 | | 路由到错误的服务器 | */ errCode: number
  9135. }
  9136. interface GridAd {
  9137. /** [GridAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.destroy.html)
  9138. *
  9139. * 销毁 grid(格子) 广告。 */
  9140. destroy(): void
  9141. /** [GridAd.hide()](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.hide.html)
  9142. *
  9143. * 隐藏 grid(格子) 广告。 */
  9144. hide(): void
  9145. /** [GridAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.offError.html)
  9146. *
  9147. * 取消监听 grid(格子) 广告错误事件 */
  9148. offError(
  9149. /** grid(格子) 广告错误事件的回调函数 */
  9150. callback?: BannerAdOffErrorCallback
  9151. ): void
  9152. /** [GridAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.offLoad.html)
  9153. *
  9154. * 取消监听 grid(格子) 广告加载事件 */
  9155. offLoad(
  9156. /** grid(格子) 广告加载事件的回调函数 */
  9157. callback?: OffLoadCallback
  9158. ): void
  9159. /** [GridAd.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.offResize.html)
  9160. *
  9161. * 取消监听 grid(格子) 广告尺寸变化事件 */
  9162. offResize(
  9163. /** grid(格子) 广告尺寸变化事件的回调函数 */
  9164. callback?: BannerAdOffResizeCallback
  9165. ): void
  9166. /** [GridAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.onError.html)
  9167. *
  9168. * 监听 grid(格子) 广告错误事件。
  9169. *
  9170. * **错误码信息与解决方案表**
  9171. *
  9172. * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
  9173. * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
  9174. *
  9175. * | 代码 | 异常情况 | 理由 | 解决方案 |
  9176. * | ------ | -------------- | --------------- | -------------------------- |
  9177. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  9178. * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
  9179. * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
  9180. * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
  9181. * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  9182. * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  9183. * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  9184. * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
  9185. * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
  9186. onError(
  9187. /** grid(格子) 广告错误事件的回调函数 */
  9188. callback: BannerAdOnErrorCallback
  9189. ): void
  9190. /** [GridAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.onLoad.html)
  9191. *
  9192. * 监听 grid(格子) 广告加载事件。 */
  9193. onLoad(
  9194. /** grid(格子) 广告加载事件的回调函数 */
  9195. callback: OnLoadCallback
  9196. ): void
  9197. /** [GridAd.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.onResize.html)
  9198. *
  9199. * 监听 grid(格子) 广告尺寸变化事件。 */
  9200. onResize(
  9201. /** grid(格子) 广告尺寸变化事件的回调函数 */
  9202. callback: BannerAdOnResizeCallback
  9203. ): void
  9204. /** [Promise GridAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.show.html)
  9205. *
  9206. * 显示 grid(格子) 广告。 */
  9207. show(): Promise<any>
  9208. }
  9209. interface InnerAudioContext {
  9210. /** [InnerAudioContext.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.destroy.html)
  9211. *
  9212. * 销毁当前实例 */
  9213. destroy(): void
  9214. /** [InnerAudioContext.offCanplay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offCanplay.html)
  9215. *
  9216. * 需要基础库: `1.9.0`
  9217. *
  9218. * 取消监听音频进入可以播放状态的事件 */
  9219. offCanplay(
  9220. /** 音频进入可以播放状态的事件的回调函数 */
  9221. callback?: OffCanplayCallback
  9222. ): void
  9223. /** [InnerAudioContext.offEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offEnded.html)
  9224. *
  9225. * 需要基础库: `1.9.0`
  9226. *
  9227. * 取消监听音频自然播放至结束的事件 */
  9228. offEnded(
  9229. /** 音频自然播放至结束的事件的回调函数 */
  9230. callback?: OffEndedCallback
  9231. ): void
  9232. /** [InnerAudioContext.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offError.html)
  9233. *
  9234. * 需要基础库: `1.9.0`
  9235. *
  9236. * 取消监听音频播放错误事件 */
  9237. offError(
  9238. /** 音频播放错误事件的回调函数 */
  9239. callback?: InnerAudioContextOffErrorCallback
  9240. ): void
  9241. /** [InnerAudioContext.offPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offPause.html)
  9242. *
  9243. * 需要基础库: `1.9.0`
  9244. *
  9245. * 取消监听音频暂停事件 */
  9246. offPause(
  9247. /** 音频暂停事件的回调函数 */
  9248. callback?: OffPauseCallback
  9249. ): void
  9250. /** [InnerAudioContext.offPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offPlay.html)
  9251. *
  9252. * 需要基础库: `1.9.0`
  9253. *
  9254. * 取消监听音频播放事件 */
  9255. offPlay(
  9256. /** 音频播放事件的回调函数 */
  9257. callback?: OffPlayCallback
  9258. ): void
  9259. /** [InnerAudioContext.offSeeked(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offSeeked.html)
  9260. *
  9261. * 需要基础库: `1.9.0`
  9262. *
  9263. * 取消监听音频完成跳转操作的事件 */
  9264. offSeeked(
  9265. /** 音频完成跳转操作的事件的回调函数 */
  9266. callback?: OffSeekedCallback
  9267. ): void
  9268. /** [InnerAudioContext.offSeeking(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offSeeking.html)
  9269. *
  9270. * 需要基础库: `1.9.0`
  9271. *
  9272. * 取消监听音频进行跳转操作的事件 */
  9273. offSeeking(
  9274. /** 音频进行跳转操作的事件的回调函数 */
  9275. callback?: OffSeekingCallback
  9276. ): void
  9277. /** [InnerAudioContext.offStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offStop.html)
  9278. *
  9279. * 需要基础库: `1.9.0`
  9280. *
  9281. * 取消监听音频停止事件 */
  9282. offStop(
  9283. /** 音频停止事件的回调函数 */
  9284. callback?: OffStopCallback
  9285. ): void
  9286. /** [InnerAudioContext.offTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offTimeUpdate.html)
  9287. *
  9288. * 需要基础库: `1.9.0`
  9289. *
  9290. * 取消监听音频播放进度更新事件 */
  9291. offTimeUpdate(
  9292. /** 音频播放进度更新事件的回调函数 */
  9293. callback?: InnerAudioContextOffTimeUpdateCallback
  9294. ): void
  9295. /** [InnerAudioContext.offWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offWaiting.html)
  9296. *
  9297. * 需要基础库: `1.9.0`
  9298. *
  9299. * 取消监听音频加载中事件 */
  9300. offWaiting(
  9301. /** 音频加载中事件的回调函数 */
  9302. callback?: OffWaitingCallback
  9303. ): void
  9304. /** [InnerAudioContext.onCanplay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onCanplay.html)
  9305. *
  9306. * 监听音频进入可以播放状态的事件。但不保证后面可以流畅播放 */
  9307. onCanplay(
  9308. /** 音频进入可以播放状态的事件的回调函数 */
  9309. callback: OnCanplayCallback
  9310. ): void
  9311. /** [InnerAudioContext.onEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onEnded.html)
  9312. *
  9313. * 监听音频自然播放至结束的事件 */
  9314. onEnded(
  9315. /** 音频自然播放至结束的事件的回调函数 */
  9316. callback: OnEndedCallback
  9317. ): void
  9318. /** [InnerAudioContext.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onError.html)
  9319. *
  9320. * 监听音频播放错误事件
  9321. *
  9322. * **Tips**
  9323. *
  9324. * 1. errCode=100001 时,如若 errMsg 中有 INNERCODE -11828 ,请先检查 response header 是否缺少 Content-Length
  9325. * 2. errCode=100001 时,如若 errMsg 中有 systemErrCode:200333420,请检查文件编码格式和 fileExtension 是否一致 */
  9326. onError(
  9327. /** 音频播放错误事件的回调函数 */
  9328. callback: InnerAudioContextOnErrorCallback
  9329. ): void
  9330. /** [InnerAudioContext.onPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onPause.html)
  9331. *
  9332. * 监听音频暂停事件 */
  9333. onPause(
  9334. /** 音频暂停事件的回调函数 */
  9335. callback: OnPauseCallback
  9336. ): void
  9337. /** [InnerAudioContext.onPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onPlay.html)
  9338. *
  9339. * 监听音频播放事件 */
  9340. onPlay(
  9341. /** 音频播放事件的回调函数 */
  9342. callback: OnPlayCallback
  9343. ): void
  9344. /** [InnerAudioContext.onSeeked(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onSeeked.html)
  9345. *
  9346. * 监听音频完成跳转操作的事件 */
  9347. onSeeked(
  9348. /** 音频完成跳转操作的事件的回调函数 */
  9349. callback: OnSeekedCallback
  9350. ): void
  9351. /** [InnerAudioContext.onSeeking(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onSeeking.html)
  9352. *
  9353. * 监听音频进行跳转操作的事件 */
  9354. onSeeking(
  9355. /** 音频进行跳转操作的事件的回调函数 */
  9356. callback: OnSeekingCallback
  9357. ): void
  9358. /** [InnerAudioContext.onStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onStop.html)
  9359. *
  9360. * 监听音频停止事件 */
  9361. onStop(
  9362. /** 音频停止事件的回调函数 */
  9363. callback: InnerAudioContextOnStopCallback
  9364. ): void
  9365. /** [InnerAudioContext.onTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onTimeUpdate.html)
  9366. *
  9367. * 监听音频播放进度更新事件 */
  9368. onTimeUpdate(
  9369. /** 音频播放进度更新事件的回调函数 */
  9370. callback: InnerAudioContextOnTimeUpdateCallback
  9371. ): void
  9372. /** [InnerAudioContext.onWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onWaiting.html)
  9373. *
  9374. * 监听音频加载中事件。当音频因为数据不足,需要停下来加载时会触发 */
  9375. onWaiting(
  9376. /** 音频加载中事件的回调函数 */
  9377. callback: OnWaitingCallback
  9378. ): void
  9379. /** [InnerAudioContext.pause()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.pause.html)
  9380. *
  9381. * 暂停。暂停后的音频再播放会从暂停处开始播放 */
  9382. pause(): void
  9383. /** [InnerAudioContext.play()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.play.html)
  9384. *
  9385. * 播放 */
  9386. play(): void
  9387. /** [InnerAudioContext.seek(number position)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.seek.html)
  9388. *
  9389. * 跳转到指定位置 */
  9390. seek(
  9391. /** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
  9392. position: number
  9393. ): void
  9394. /** [InnerAudioContext.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.stop.html)
  9395. *
  9396. * 停止。停止后的音频再播放会从头开始播放。 */
  9397. stop(): void
  9398. }
  9399. interface InterstitialAd {
  9400. /** [InterstitialAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.destroy.html)
  9401. *
  9402. * 需要基础库: `2.8.0`
  9403. *
  9404. * 销毁插屏广告实例。 */
  9405. destroy(): void
  9406. /** [InterstitialAd.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.offClose.html)
  9407. *
  9408. * 取消监听插屏广告关闭事件 */
  9409. offClose(
  9410. /** 插屏广告关闭事件的回调函数 */
  9411. callback?: UDPSocketOffCloseCallback
  9412. ): void
  9413. /** [InterstitialAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.offError.html)
  9414. *
  9415. * 取消监听插屏错误事件 */
  9416. offError(
  9417. /** 插屏错误事件的回调函数 */
  9418. callback?: InterstitialAdOffErrorCallback
  9419. ): void
  9420. /** [InterstitialAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.offLoad.html)
  9421. *
  9422. * 取消监听插屏广告加载事件 */
  9423. offLoad(
  9424. /** 插屏广告加载事件的回调函数 */
  9425. callback?: OffLoadCallback
  9426. ): void
  9427. /** [InterstitialAd.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.onClose.html)
  9428. *
  9429. * 监听插屏广告关闭事件。 */
  9430. onClose(
  9431. /** 插屏广告关闭事件的回调函数 */
  9432. callback: UDPSocketOnCloseCallback
  9433. ): void
  9434. /** [InterstitialAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.onError.html)
  9435. *
  9436. * 监听插屏错误事件。
  9437. *
  9438. * **错误码信息与解决方案表**
  9439. *
  9440. * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
  9441. * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
  9442. *
  9443. * | 代码 | 异常情况 | 理由 | 解决方案 |
  9444. * | ------ | -------------- | --------------- | -------------------------- |
  9445. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  9446. * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
  9447. * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
  9448. * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
  9449. * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  9450. * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  9451. * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  9452. * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
  9453. * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
  9454. onError(
  9455. /** 插屏错误事件的回调函数 */
  9456. callback: InterstitialAdOnErrorCallback
  9457. ): void
  9458. /** [InterstitialAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.onLoad.html)
  9459. *
  9460. * 监听插屏广告加载事件。 */
  9461. onLoad(
  9462. /** 插屏广告加载事件的回调函数 */
  9463. callback: OnLoadCallback
  9464. ): void
  9465. /** [Promise InterstitialAd.load()](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.load.html)
  9466. *
  9467. * 需要基础库: `2.8.0`
  9468. *
  9469. * 加载插屏广告。 */
  9470. load(): Promise<any>
  9471. /** [Promise InterstitialAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.show.html)
  9472. *
  9473. * 显示插屏广告。
  9474. *
  9475. * **错误码信息表**
  9476. *
  9477. * 如果插屏广告显示失败,InterstitialAd.show() 方法会返回一个rejected Promise,开发者可以获取到错误码及对应的错误信息。
  9478. *
  9479. * | 代码 | 异常情况 | 理由 |
  9480. * | ------ | -------------- | -------------------------- |
  9481. * | 2001 | 触发频率限制 | 小程序启动一定时间内不允许展示插屏广告 |
  9482. * | 2002 | 触发频率限制 | 距离小程序插屏广告或者激励视频广告上次播放时间间隔不足,不允许展示插屏广告 |
  9483. * | 2003 | 触发频率限制 | 当前正在播放激励视频广告或者插屏广告,不允许再次展示插屏广告 |
  9484. * | 2004 | 广告渲染失败 | 该项错误不是开发者的异常情况,或因小程序页面切换导致广告渲染失败 |
  9485. * | 2005 | 广告调用异常 | 插屏广告实例不允许跨页面调用 | */
  9486. show(): Promise<any>
  9487. }
  9488. interface JoinVoIPChatError {
  9489. /** 错误信息
  9490. *
  9491. * | 错误码 | 错误信息 | 说明 |
  9492. * | - | - | - |
  9493. * | -1 | 当前已在房间内 | |
  9494. * | -2 | 录音设备被占用,可能是当前正在使用微信内语音通话或系统通话 | |
  9495. * | -3 | 加入会话期间退出(可能是用户主动退出,或者退后台、来电等原因),因此加入失败 | |
  9496. * | -1000 | 系统错误 | | */ errMsg: string
  9497. /** 错误码
  9498. *
  9499. * | 错误码 | 错误信息 | 说明 |
  9500. * | - | - | - |
  9501. * | -1 | 当前已在房间内 | |
  9502. * | -2 | 录音设备被占用,可能是当前正在使用微信内语音通话或系统通话 | |
  9503. * | -3 | 加入会话期间退出(可能是用户主动退出,或者退后台、来电等原因),因此加入失败 | |
  9504. * | -1000 | 系统错误 | | */ errCode: number
  9505. }
  9506. interface LoadSubpackageTask {
  9507. /** [LoadSubpackageTask.onProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/subpackage/LoadSubpackageTask.onProgressUpdate.html)
  9508. *
  9509. * 需要基础库: `2.1.0`
  9510. *
  9511. * 监听分包加载进度变化事件 */
  9512. onProgressUpdate(
  9513. /** 分包加载进度变化事件的回调函数 */
  9514. callback: LoadSubpackageTaskOnProgressUpdateCallback
  9515. ): void
  9516. }
  9517. interface LogManager {
  9518. /** [LogManager.debug()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.debug.html)
  9519. *
  9520. * 写 debug 日志 */
  9521. debug(
  9522. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
  9523. ...args: any[]
  9524. ): void
  9525. /** [LogManager.info()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.info.html)
  9526. *
  9527. * 写 info 日志 */
  9528. info(
  9529. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
  9530. ...args: any[]
  9531. ): void
  9532. /** [LogManager.log()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.log.html)
  9533. *
  9534. * 写 log 日志 */
  9535. log(
  9536. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
  9537. ...args: any[]
  9538. ): void
  9539. /** [LogManager.warn()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.warn.html)
  9540. *
  9541. * 写 warn 日志 */
  9542. warn(
  9543. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
  9544. ...args: any[]
  9545. ): void
  9546. }
  9547. interface MediaAudioPlayer {
  9548. /** [Promise MediaAudioPlayer.addAudioSource([VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html) source)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.addAudioSource.html)
  9549. *
  9550. * 添加音频源 */
  9551. addAudioSource(
  9552. /** [VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html)
  9553. *
  9554. * 视频解码器实例。作为音频源添加到音频播放器中 */
  9555. source: VideoDecoder
  9556. ): Promise<any>
  9557. /** [Promise MediaAudioPlayer.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.destroy.html)
  9558. *
  9559. * 销毁播放器 */
  9560. destroy(): Promise<any>
  9561. /** [Promise MediaAudioPlayer.removeAudioSource([VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html) source)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.removeAudioSource.html)
  9562. *
  9563. * 移除音频源 */
  9564. removeAudioSource(
  9565. /** [VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html)
  9566. *
  9567. * 视频解码器实例 */
  9568. source: VideoDecoder
  9569. ): Promise<any>
  9570. /** [Promise MediaAudioPlayer.start()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.start.html)
  9571. *
  9572. * 启动播放器 */
  9573. start(): Promise<any>
  9574. /** [Promise MediaAudioPlayer.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.stop.html)
  9575. *
  9576. * 停止播放器 */
  9577. stop(): Promise<any>
  9578. }
  9579. interface MidasFriendPaymentError {
  9580. /** 错误信息
  9581. *
  9582. * | 错误码 | 错误信息 | 说明 |
  9583. * | - | - | - |
  9584. * | 1000 | | mode错误 |
  9585. * | -15005 | | 索要权限被封禁(索要功能不可用) |
  9586. * | -10073011 | | 参数错误(具体错误见errMsg) |
  9587. * | -10073003 | | outTradeNo业务单号重复 |
  9588. * | -10073012 | | 索要单已支付 |
  9589. * | -10073013 | | 索要单已超时 |
  9590. * | -10073014 | | 签名错误 |
  9591. * | -10073015 | | 索要功能不可用 | */ errMsg: string
  9592. /** 错误码
  9593. *
  9594. * | 错误码 | 错误信息 | 说明 |
  9595. * | - | - | - |
  9596. * | 1000 | | mode错误 |
  9597. * | -15005 | | 索要权限被封禁(索要功能不可用) |
  9598. * | -10073011 | | 参数错误(具体错误见errMsg) |
  9599. * | -10073003 | | outTradeNo业务单号重复 |
  9600. * | -10073012 | | 索要单已支付 |
  9601. * | -10073013 | | 索要单已超时 |
  9602. * | -10073014 | | 签名错误 |
  9603. * | -10073015 | | 索要功能不可用 | */ errCode: number
  9604. }
  9605. interface MidasPaymentError {
  9606. /** 错误信息
  9607. *
  9608. * | 错误码 | 错误信息 | 说明 |
  9609. * | - | - | - |
  9610. * | -1 | | 系统失败 |
  9611. * | -2 | | 支付取消 |
  9612. * | -15001 | | 虚拟支付接口错误码,缺少参数 |
  9613. * | -15002 | | 虚拟支付接口错误码,参数不合法 |
  9614. * | -15003 | | 虚拟支付接口错误码,订单重复 |
  9615. * | -15004 | | 虚拟支付接口错误码,后台错误 |
  9616. * | -15005 | | 虚拟支付接口错误码,appId权限被封禁 |
  9617. * | -15006 | | 虚拟支付接口错误码,货币类型不支持 |
  9618. * | -15007 | | 虚拟支付接口错误码,订单已支付 |
  9619. * | -15009 | | 虚拟支付接口错误码,由于健康系统限制,本次支付已超过限额(这种错误情况会有默认弹窗提示) |
  9620. * | 1 | | 虚拟支付接口错误码,用户取消支付 |
  9621. * | 2 | | 虚拟支付接口错误码,客户端错误,判断到小程序在用户处于支付中时,又发起了一笔支付请求 |
  9622. * | 3 | | 虚拟支付接口错误码,Android独有错误:用户使用GooglePlay支付,而手机未安装GooglePlay |
  9623. * | 4 | | 虚拟支付接口错误码,用户操作系统支付状态异常 |
  9624. * | 5 | | 虚拟支付接口错误码,操作系统错误 |
  9625. * | 6 | | 虚拟支付接口错误码,其他错误 |
  9626. * | 1000 | | 参数错误 |
  9627. * | 1003 | | 米大师Portal错误 | */ errMsg: string
  9628. /** 错误码
  9629. *
  9630. * | 错误码 | 错误信息 | 说明 |
  9631. * | - | - | - |
  9632. * | -1 | | 系统失败 |
  9633. * | -2 | | 支付取消 |
  9634. * | -15001 | | 虚拟支付接口错误码,缺少参数 |
  9635. * | -15002 | | 虚拟支付接口错误码,参数不合法 |
  9636. * | -15003 | | 虚拟支付接口错误码,订单重复 |
  9637. * | -15004 | | 虚拟支付接口错误码,后台错误 |
  9638. * | -15005 | | 虚拟支付接口错误码,appId权限被封禁 |
  9639. * | -15006 | | 虚拟支付接口错误码,货币类型不支持 |
  9640. * | -15007 | | 虚拟支付接口错误码,订单已支付 |
  9641. * | -15009 | | 虚拟支付接口错误码,由于健康系统限制,本次支付已超过限额(这种错误情况会有默认弹窗提示) |
  9642. * | 1 | | 虚拟支付接口错误码,用户取消支付 |
  9643. * | 2 | | 虚拟支付接口错误码,客户端错误,判断到小程序在用户处于支付中时,又发起了一笔支付请求 |
  9644. * | 3 | | 虚拟支付接口错误码,Android独有错误:用户使用GooglePlay支付,而手机未安装GooglePlay |
  9645. * | 4 | | 虚拟支付接口错误码,用户操作系统支付状态异常 |
  9646. * | 5 | | 虚拟支付接口错误码,操作系统错误 |
  9647. * | 6 | | 虚拟支付接口错误码,其他错误 |
  9648. * | 1000 | | 参数错误 |
  9649. * | 1003 | | 米大师Portal错误 | */ errCode: number
  9650. }
  9651. interface OpenDataContext {
  9652. /** [OpenDataContext.postMessage(Object message)](https://developers.weixin.qq.com/minigame/dev/api/open-api/context/OpenDataContext.postMessage.html)
  9653. *
  9654. * 向开放数据域发送消息 */
  9655. postMessage(
  9656. /** 要发送的消息,message 中及嵌套对象中 key 的 value 只能是 primitive value。即 number、string、boolean、null、undefined。 */
  9657. message: IAnyObject
  9658. ): void
  9659. }
  9660. interface OpenSettingButton {
  9661. /** [OpenSettingButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.destroy.html)
  9662. *
  9663. * 销毁打开设置页面按钮 */
  9664. destroy(): void
  9665. /** [OpenSettingButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.hide.html)
  9666. *
  9667. * 隐藏打开设置页面按钮。 */
  9668. hide(): void
  9669. /** [OpenSettingButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.offTap.html)
  9670. *
  9671. * 取消监听设置页面按钮的点击事件 */
  9672. offTap(
  9673. /** 设置页面按钮的点击事件的回调函数 */
  9674. callback?: GameClubButtonOffTapCallback
  9675. ): void
  9676. /** [OpenSettingButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.onTap.html)
  9677. *
  9678. * 监听设置页面按钮的点击事件 */
  9679. onTap(
  9680. /** 设置页面按钮的点击事件的回调函数 */
  9681. callback: GameClubButtonOnTapCallback
  9682. ): void
  9683. /** [OpenSettingButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.show.html)
  9684. *
  9685. * 显示打开设置页面按钮 */
  9686. show(): void
  9687. }
  9688. interface OpenSyncError {
  9689. /** 错误信息
  9690. *
  9691. * | 错误信息 | 说明 |
  9692. * | - | - |
  9693. * | fail no such file or directory "${filePath}" | 上级目录不存在 | */ errMsg: string
  9694. /** 错误码
  9695. *
  9696. * | 错误信息 | 说明 |
  9697. * | - | - |
  9698. * | fail no such file or directory "${filePath}" | 上级目录不存在 | */ errCode: number
  9699. }
  9700. interface Performance {
  9701. /** [number Performance.now()](https://developers.weixin.qq.com/minigame/dev/api/base/performance/Performance.now.html)
  9702. *
  9703. * 可以获取当前时间以微秒为单位的时间戳 */
  9704. now(): number
  9705. }
  9706. interface ReadCompressedFileSyncError {
  9707. /** 错误信息
  9708. *
  9709. * | 错误信息 | 说明 |
  9710. * | - | - |
  9711. * | fail decompress fail | 指定的 compressionAlgorithm 与文件实际压缩格式不符 |
  9712. * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
  9713. * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有读权限 | */ errMsg: string
  9714. /** 错误码
  9715. *
  9716. * | 错误信息 | 说明 |
  9717. * | - | - |
  9718. * | fail decompress fail | 指定的 compressionAlgorithm 与文件实际压缩格式不符 |
  9719. * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
  9720. * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有读权限 | */ errCode: number
  9721. }
  9722. interface ReadSyncError {
  9723. /** 错误信息
  9724. *
  9725. * | 错误信息 | 说明 |
  9726. * | - | - |
  9727. * | bad file descriptor | 无效的文件描述符 |
  9728. * | fail permission denied | 指定的 fd 路径没有读权限 |
  9729. * | fail the value of "offset" is out of range | 传入的 offset 不合法 |
  9730. * | fail the value of "length" is out of range | 传入的 length 不合法 |
  9731. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
  9732. /** 错误码
  9733. *
  9734. * | 错误信息 | 说明 |
  9735. * | - | - |
  9736. * | bad file descriptor | 无效的文件描述符 |
  9737. * | fail permission denied | 指定的 fd 路径没有读权限 |
  9738. * | fail the value of "offset" is out of range | 传入的 offset 不合法 |
  9739. * | fail the value of "length" is out of range | 传入的 length 不合法 |
  9740. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
  9741. }
  9742. interface RealtimeLogManager {
  9743. /** [RealtimeLogManager.addFilterMsg(string msg)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.addFilterMsg.html)
  9744. *
  9745. * 需要基础库: `2.14.4`
  9746. *
  9747. * 添加过滤关键字,暂不支持在插件使用 */
  9748. addFilterMsg(
  9749. /** 是setFilterMsg的添加接口。用于设置多个过滤关键字。 */
  9750. msg: string
  9751. ): void
  9752. /** [RealtimeLogManager.error()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.error.html)
  9753. *
  9754. * 需要基础库: `2.14.4`
  9755. *
  9756. * 写 error 日志,暂不支持在插件使用 */
  9757. error(
  9758. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb */
  9759. ...args: any[]
  9760. ): void
  9761. /** [RealtimeLogManager.info()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.info.html)
  9762. *
  9763. * 需要基础库: `2.14.4`
  9764. *
  9765. * 写 info 日志,暂不支持在插件使用 */
  9766. info(
  9767. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb */
  9768. ...args: any[]
  9769. ): void
  9770. /** [RealtimeLogManager.setFilterMsg(string msg)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.setFilterMsg.html)
  9771. *
  9772. * 需要基础库: `2.14.4`
  9773. *
  9774. * 设置过滤关键字,暂不支持在插件使用 */
  9775. setFilterMsg(
  9776. /** 过滤关键字,最多不超过1Kb,可以在小程序管理后台根据设置的内容搜索得到对应的日志。 */
  9777. msg: string
  9778. ): void
  9779. /** [RealtimeLogManager.warn()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.warn.html)
  9780. *
  9781. * 需要基础库: `2.14.4`
  9782. *
  9783. * 写 warn 日志,暂不支持在插件使用 */
  9784. warn(
  9785. /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb */
  9786. ...args: any[]
  9787. ): void
  9788. }
  9789. interface RecorderManager {
  9790. /** [RecorderManager.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onError.html)
  9791. *
  9792. * 监听录音错误事件 */
  9793. onError(
  9794. /** 录音错误事件的回调函数 */
  9795. callback: UDPSocketOnErrorCallback
  9796. ): void
  9797. /** [RecorderManager.onFrameRecorded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onFrameRecorded.html)
  9798. *
  9799. * 监听已录制完指定帧大小的文件事件。如果设置了 frameSize,则会回调此事件。 */
  9800. onFrameRecorded(
  9801. /** 已录制完指定帧大小的文件事件的回调函数 */
  9802. callback: OnFrameRecordedCallback
  9803. ): void
  9804. /** [RecorderManager.onInterruptionBegin(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onInterruptionBegin.html)
  9805. *
  9806. * 需要基础库: `2.3.0`
  9807. *
  9808. * 监听录音因为受到系统占用而被中断开始事件。以下场景会触发此事件:微信语音聊天、微信视频聊天。此事件触发后,录音会被暂停。pause 事件在此事件后触发 */
  9809. onInterruptionBegin(
  9810. /** 录音因为受到系统占用而被中断开始事件的回调函数 */
  9811. callback: OnInterruptionBeginCallback
  9812. ): void
  9813. /** [RecorderManager.onInterruptionEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onInterruptionEnd.html)
  9814. *
  9815. * 需要基础库: `2.3.0`
  9816. *
  9817. * 监听录音中断结束事件。在收到 interruptionBegin 事件之后,小程序内所有录音会暂停,收到此事件之后才可再次录音成功。 */
  9818. onInterruptionEnd(
  9819. /** 录音中断结束事件的回调函数 */
  9820. callback: OnInterruptionEndCallback
  9821. ): void
  9822. /** [RecorderManager.onPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onPause.html)
  9823. *
  9824. * 监听录音暂停事件 */
  9825. onPause(
  9826. /** 录音暂停事件的回调函数 */
  9827. callback: OnPauseCallback
  9828. ): void
  9829. /** [RecorderManager.onResume(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onResume.html)
  9830. *
  9831. * 监听录音继续事件 */
  9832. onResume(
  9833. /** 录音继续事件的回调函数 */
  9834. callback: OnResumeCallback
  9835. ): void
  9836. /** [RecorderManager.onStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onStart.html)
  9837. *
  9838. * 监听录音开始事件 */
  9839. onStart(
  9840. /** 录音开始事件的回调函数 */
  9841. callback: OnStartCallback
  9842. ): void
  9843. /** [RecorderManager.onStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onStop.html)
  9844. *
  9845. * 监听录音结束事件 */
  9846. onStop(
  9847. /** 录音结束事件的回调函数 */
  9848. callback: RecorderManagerOnStopCallback
  9849. ): void
  9850. /** [RecorderManager.pause()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.pause.html)
  9851. *
  9852. * 暂停录音 */
  9853. pause(): void
  9854. /** [RecorderManager.resume()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.resume.html)
  9855. *
  9856. * 继续录音 */
  9857. resume(): void
  9858. /** [RecorderManager.start(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.start.html)
  9859. *
  9860. * 开始录音
  9861. *
  9862. * **采样率与编码码率限制**
  9863. *
  9864. * 每种采样率有对应的编码码率范围有效值,设置不合法的采样率或编码码率会导致录音失败,具体对应关系如下表。
  9865. *
  9866. * | 采样率 | 编码码率 |
  9867. * | ------ | -------------- |
  9868. * | 8000 | 16000 ~ 48000 |
  9869. * | 11025 | 16000 ~ 48000 |
  9870. * | 12000 | 24000 ~ 64000 |
  9871. * | 16000 | 24000 ~ 96000 |
  9872. * | 22050 | 32000 ~ 128000 |
  9873. * | 24000 | 32000 ~ 128000 |
  9874. * | 32000 | 48000 ~ 192000 |
  9875. * | 44100 | 64000 ~ 320000 |
  9876. * | 48000 | 64000 ~ 320000 | */
  9877. start(option: RecorderManagerStartOption): void
  9878. /** [RecorderManager.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.stop.html)
  9879. *
  9880. * 停止录音 */
  9881. stop(): void
  9882. }
  9883. interface RequestTask {
  9884. /** [RequestTask.abort()](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.abort.html)
  9885. *
  9886. * 需要基础库: `1.4.0`
  9887. *
  9888. * 中断请求任务 */
  9889. abort(): void
  9890. /** [RequestTask.offChunkReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.offChunkReceived.html)
  9891. *
  9892. * 需要基础库: `2.20.1`
  9893. *
  9894. * 取消监听 Transfer-Encoding Chunk Received 事件 */
  9895. offChunkReceived(
  9896. /** Transfer-Encoding Chunk Received 事件的回调函数 */
  9897. callback?: OffChunkReceivedCallback
  9898. ): void
  9899. /** [RequestTask.offHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.offHeadersReceived.html)
  9900. *
  9901. * 需要基础库: `2.1.0`
  9902. *
  9903. * 取消监听 HTTP Response Header 事件 */
  9904. offHeadersReceived(
  9905. /** HTTP Response Header 事件的回调函数 */
  9906. callback?: OffHeadersReceivedCallback
  9907. ): void
  9908. /** [RequestTask.onChunkReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.onChunkReceived.html)
  9909. *
  9910. * 需要基础库: `2.20.1`
  9911. *
  9912. * 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。 */
  9913. onChunkReceived(
  9914. /** Transfer-Encoding Chunk Received 事件的回调函数 */
  9915. callback: OnChunkReceivedCallback
  9916. ): void
  9917. /** [RequestTask.onHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.onHeadersReceived.html)
  9918. *
  9919. * 需要基础库: `2.1.0`
  9920. *
  9921. * 监听 HTTP Response Header 事件。会比请求完成事件更早 */
  9922. onHeadersReceived(
  9923. /** HTTP Response Header 事件的回调函数 */
  9924. callback: OnHeadersReceivedCallback
  9925. ): void
  9926. }
  9927. interface RewardedVideoAd {
  9928. /** [Promise RewardedVideoAd.load()](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.load.html)
  9929. *
  9930. * 加载激励视频广告。 */
  9931. load(): Promise<any>
  9932. /** [Promise RewardedVideoAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.show.html)
  9933. *
  9934. * 显示激励视频广告。激励视频广告将从屏幕下方推入。 */
  9935. show(): Promise<any>
  9936. /** [RewardedVideoAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.destroy.html)
  9937. *
  9938. * 需要基础库: `2.8.0`
  9939. *
  9940. * 销毁激励视频广告实例。 */
  9941. destroy(): void
  9942. /** [RewardedVideoAd.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.offClose.html)
  9943. *
  9944. * 取消监听用户点击 `关闭广告` 按钮的事件 */
  9945. offClose(
  9946. /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
  9947. callback?: RewardedVideoAdOffCloseCallback
  9948. ): void
  9949. /** [RewardedVideoAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.offError.html)
  9950. *
  9951. * 取消监听激励视频错误事件 */
  9952. offError(
  9953. /** 激励视频错误事件的回调函数 */
  9954. callback?: BannerAdOffErrorCallback
  9955. ): void
  9956. /** [RewardedVideoAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.offLoad.html)
  9957. *
  9958. * 取消监听激励视频广告加载事件 */
  9959. offLoad(
  9960. /** 激励视频广告加载事件的回调函数 */
  9961. callback?: OffLoadCallback
  9962. ): void
  9963. /** [RewardedVideoAd.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.onClose.html)
  9964. *
  9965. * 监听用户点击 `关闭广告` 按钮的事件。 */
  9966. onClose(
  9967. /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
  9968. callback: RewardedVideoAdOnCloseCallback
  9969. ): void
  9970. /** [RewardedVideoAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.onError.html)
  9971. *
  9972. * 监听激励视频错误事件。
  9973. *
  9974. * **错误码信息与解决方案表**
  9975. *
  9976. * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
  9977. * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
  9978. *
  9979. * | 代码 | 异常情况 | 理由 | 解决方案 |
  9980. * | ------ | -------------- | --------------- | -------------------------- |
  9981. * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
  9982. * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
  9983. * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
  9984. * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
  9985. * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
  9986. * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  9987. * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
  9988. * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
  9989. * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
  9990. onError(
  9991. /** 激励视频错误事件的回调函数 */
  9992. callback: BannerAdOnErrorCallback
  9993. ): void
  9994. /** [RewardedVideoAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.onLoad.html)
  9995. *
  9996. * 监听激励视频广告加载事件。 */
  9997. onLoad(
  9998. /** 激励视频广告加载事件的回调函数 */
  9999. callback: OnLoadCallback
  10000. ): void
  10001. }
  10002. interface SocketTask {
  10003. /** [SocketTask.close(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.close.html)
  10004. *
  10005. * 关闭 WebSocket 连接 */
  10006. close(option: SocketTaskCloseOption): void
  10007. /** [SocketTask.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onClose.html)
  10008. *
  10009. * 监听 WebSocket 连接关闭事件 */
  10010. onClose(
  10011. /** WebSocket 连接关闭事件的回调函数 */
  10012. callback: SocketTaskOnCloseCallback
  10013. ): void
  10014. /** [SocketTask.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onError.html)
  10015. *
  10016. * 监听 WebSocket 错误事件 */
  10017. onError(
  10018. /** WebSocket 错误事件的回调函数 */
  10019. callback: UDPSocketOnErrorCallback
  10020. ): void
  10021. /** [SocketTask.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onMessage.html)
  10022. *
  10023. * 监听 WebSocket 接受到服务器的消息事件 */
  10024. onMessage(
  10025. /** WebSocket 接受到服务器的消息事件的回调函数 */
  10026. callback: SocketTaskOnMessageCallback
  10027. ): void
  10028. /** [SocketTask.onOpen(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onOpen.html)
  10029. *
  10030. * 监听 WebSocket 连接打开事件 */
  10031. onOpen(
  10032. /** WebSocket 连接打开事件的回调函数 */
  10033. callback: OnOpenCallback
  10034. ): void
  10035. /** [SocketTask.send(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.send.html)
  10036. *
  10037. * 通过 WebSocket 连接发送数据 */
  10038. send(option: SocketTaskSendOption): void
  10039. }
  10040. interface Stats {
  10041. /** [boolean Stats.isDirectory()](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.isDirectory.html)
  10042. *
  10043. * 判断当前文件是否一个目录 */
  10044. isDirectory(): boolean
  10045. /** [boolean Stats.isFile()](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.isFile.html)
  10046. *
  10047. * 判断当前文件是否一个普通文件 */
  10048. isFile(): boolean
  10049. }
  10050. interface TruncateSyncError {
  10051. /** 错误信息
  10052. *
  10053. * | 错误信息 | 说明 |
  10054. * | - | - |
  10055. * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
  10056. * | fail illegal operation on a directory, open "${filePath}" | 指定的 filePath 是一个已经存在的目录 |
  10057. * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有写权限 |
  10058. * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
  10059. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
  10060. /** 错误码
  10061. *
  10062. * | 错误信息 | 说明 |
  10063. * | - | - |
  10064. * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
  10065. * | fail illegal operation on a directory, open "${filePath}" | 指定的 filePath 是一个已经存在的目录 |
  10066. * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有写权限 |
  10067. * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
  10068. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
  10069. }
  10070. interface UDPSocket {
  10071. /** [UDPSocket.close()](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.close.html)
  10072. *
  10073. * 关闭 UDP Socket 实例,相当于销毁。 在关闭之后,UDP Socket 实例不能再发送消息,每次调用 `UDPSocket.send` 将会触发错误事件,并且 message 事件回调函数也不会再也执行。在 `UDPSocket` 实例被创建后将被 Native 强引用,保证其不被 GC。在 `UDPSocket.close` 后将解除对其的强引用,让 UDPSocket 实例遵从 GC。 */
  10074. close(): void
  10075. /** [UDPSocket.connect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.connect.html)
  10076. *
  10077. * 需要基础库: `2.15.0`
  10078. *
  10079. * 预先连接到指定的 IP 和 port,需要配合 write 方法一起使用 */
  10080. connect(option: ConnectOption): void
  10081. /** [UDPSocket.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offClose.html)
  10082. *
  10083. * 取消监听关闭事件 */
  10084. offClose(
  10085. /** 关闭事件的回调函数 */
  10086. callback?: UDPSocketOffCloseCallback
  10087. ): void
  10088. /** [UDPSocket.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offError.html)
  10089. *
  10090. * 取消监听错误事件 */
  10091. offError(
  10092. /** 错误事件的回调函数 */
  10093. callback?: UDPSocketOffErrorCallback
  10094. ): void
  10095. /** [UDPSocket.offListening(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offListening.html)
  10096. *
  10097. * 取消监听开始监听数据包消息的事件 */
  10098. offListening(
  10099. /** 开始监听数据包消息的事件的回调函数 */
  10100. callback?: OffListeningCallback
  10101. ): void
  10102. /** [UDPSocket.offMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offMessage.html)
  10103. *
  10104. * 取消监听收到消息的事件 */
  10105. offMessage(
  10106. /** 收到消息的事件的回调函数 */
  10107. callback?: OffMessageCallback
  10108. ): void
  10109. /** [UDPSocket.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onClose.html)
  10110. *
  10111. * 监听关闭事件 */
  10112. onClose(
  10113. /** 关闭事件的回调函数 */
  10114. callback: UDPSocketOnCloseCallback
  10115. ): void
  10116. /** [UDPSocket.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onError.html)
  10117. *
  10118. * 监听错误事件 */
  10119. onError(
  10120. /** 错误事件的回调函数 */
  10121. callback: UDPSocketOnErrorCallback
  10122. ): void
  10123. /** [UDPSocket.onListening(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onListening.html)
  10124. *
  10125. * 监听开始监听数据包消息的事件 */
  10126. onListening(
  10127. /** 开始监听数据包消息的事件的回调函数 */
  10128. callback: OnListeningCallback
  10129. ): void
  10130. /** [UDPSocket.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onMessage.html)
  10131. *
  10132. * 监听收到消息的事件 */
  10133. onMessage(
  10134. /** 收到消息的事件的回调函数 */
  10135. callback: UDPSocketOnMessageCallback
  10136. ): void
  10137. /** [UDPSocket.send(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.send.html)
  10138. *
  10139. * 向指定的 IP 和 port 发送消息。基础库 2.9.0 起支持广播 (指定地址为 255.255.255.255)。 */
  10140. send(option: UDPSocketSendOption): void
  10141. /** [UDPSocket.setTTL(number ttl)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.setTTL.html)
  10142. *
  10143. * 需要基础库: `2.18.0`
  10144. *
  10145. * 设置 IP_TTL 套接字选项,用于设置一个 IP 数据包传输时允许的最大跳步数 */
  10146. setTTL(
  10147. /** ttl 参数可以是 0 到 255 之间 */
  10148. ttl: number
  10149. ): void
  10150. /** [UDPSocket.write()](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.write.html)
  10151. *
  10152. * 需要基础库: `2.15.0`
  10153. *
  10154. * 用法与 send 方法相同,如果没有预先调用 connect 则与 send 无差异(注意即使调用了 connect 也需要在本接口填入地址和端口参数) */
  10155. write(): void
  10156. /** [number UDPSocket.bind(number port)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.bind.html)
  10157. *
  10158. * 绑定一个系统随机分配的可用端口,或绑定一个指定的端口号 */
  10159. bind(
  10160. /** 需要基础库: `2.9.0`
  10161. *
  10162. * 指定要绑定的端口号,不传则返回系统随机分配的可用端口 */
  10163. port?: number
  10164. ): number
  10165. }
  10166. interface UpdateManager {
  10167. /** [UpdateManager.applyUpdate()](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.applyUpdate.html)
  10168. *
  10169. * 强制小程序重启并使用新版本。在小程序新版本下载完成后(即收到 `onUpdateReady` 回调)调用。
  10170. *
  10171. * **示例代码**
  10172. *
  10173. * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
  10174. applyUpdate(): void
  10175. /** [UpdateManager.onCheckForUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.onCheckForUpdate.html)
  10176. *
  10177. * 监听向微信后台请求检查更新结果事件。微信在小程序冷启动时自动检查更新,不需由开发者主动触发。
  10178. *
  10179. * **示例代码**
  10180. *
  10181. * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
  10182. onCheckForUpdate(
  10183. /** 向微信后台请求检查更新结果事件的回调函数 */
  10184. callback: OnCheckForUpdateCallback
  10185. ): void
  10186. /** [UpdateManager.onUpdateFailed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.onUpdateFailed.html)
  10187. *
  10188. * 监听小程序更新失败事件。小程序有新版本,客户端主动触发下载(无需开发者触发),下载失败(可能是网络原因等)后回调
  10189. *
  10190. * **示例代码**
  10191. *
  10192. * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
  10193. onUpdateFailed(
  10194. /** 小程序更新失败事件的回调函数 */
  10195. callback: OnUpdateFailedCallback
  10196. ): void
  10197. /** [UpdateManager.onUpdateReady(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.onUpdateReady.html)
  10198. *
  10199. * 监听小程序有版本更新事件。客户端主动触发下载(无需开发者触发),下载成功后回调
  10200. *
  10201. * **示例代码**
  10202. *
  10203. * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
  10204. onUpdateReady(
  10205. /** 小程序有版本更新事件的回调函数 */
  10206. callback: OnUpdateReadyCallback
  10207. ): void
  10208. }
  10209. interface UploadTask {
  10210. /** [UploadTask.abort()](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.abort.html)
  10211. *
  10212. * 需要基础库: `1.4.0`
  10213. *
  10214. * 中断上传任务 */
  10215. abort(): void
  10216. /** [UploadTask.offHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.offHeadersReceived.html)
  10217. *
  10218. * 需要基础库: `2.1.0`
  10219. *
  10220. * 取消监听 HTTP Response Header 事件 */
  10221. offHeadersReceived(
  10222. /** HTTP Response Header 事件的回调函数 */
  10223. callback?: OffHeadersReceivedCallback
  10224. ): void
  10225. /** [UploadTask.offProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.offProgressUpdate.html)
  10226. *
  10227. * 需要基础库: `2.1.0`
  10228. *
  10229. * 取消监听上传进度变化事件 */
  10230. offProgressUpdate(
  10231. /** 上传进度变化事件的回调函数 */
  10232. callback?: UploadTaskOffProgressUpdateCallback
  10233. ): void
  10234. /** [UploadTask.onHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.onHeadersReceived.html)
  10235. *
  10236. * 需要基础库: `2.1.0`
  10237. *
  10238. * 监听 HTTP Response Header 事件。会比请求完成事件更早 */
  10239. onHeadersReceived(
  10240. /** HTTP Response Header 事件的回调函数 */
  10241. callback: OnHeadersReceivedCallback
  10242. ): void
  10243. /** [UploadTask.onProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.onProgressUpdate.html)
  10244. *
  10245. * 需要基础库: `1.4.0`
  10246. *
  10247. * 监听上传进度变化事件 */
  10248. onProgressUpdate(
  10249. /** 上传进度变化事件的回调函数 */
  10250. callback: UploadTaskOnProgressUpdateCallback
  10251. ): void
  10252. }
  10253. interface UserCryptoManager {
  10254. /** [UserCryptoManager.getLatestUserKey(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/crypto/UserCryptoManager.getLatestUserKey.html)
  10255. *
  10256. * 需要基础库: `2.17.3`
  10257. *
  10258. * 获取最新的用户加密密钥
  10259. *
  10260. * **示例代码**
  10261. *
  10262. * ```js
  10263. const userCryptoManager = wx.getUserCryptoManager()
  10264. userCryptoManager.getLatestUserKey({
  10265. success: res => {
  10266. const {encryptKey, iv, version, expireTime} = res
  10267. console.log(encryptKey, iv, version, expireTime)
  10268. }
  10269. })
  10270. ``` */
  10271. getLatestUserKey(option?: GetLatestUserKeyOption): void
  10272. /** [UserCryptoManager.getRandomValues(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/crypto/UserCryptoManager.getRandomValues.html)
  10273. *
  10274. * 需要基础库: `2.17.3`
  10275. *
  10276. * 获取密码学安全随机数
  10277. *
  10278. * **示例代码**
  10279. *
  10280. * ```js
  10281. wx.getRandomValues({
  10282. length: 6 // 生成 6 个字节长度的随机数,
  10283. success: res => {
  10284. console.log(wx.arrayBufferToBase64(res.randomValues)) // 转换为 base64 字符串后打印
  10285. }
  10286. })
  10287. ``` */
  10288. getRandomValues(option: GetRandomValuesOption): void
  10289. }
  10290. interface UserInfoButton {
  10291. /** [UserInfoButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.destroy.html)
  10292. *
  10293. * 销毁用户信息按钮 */
  10294. destroy(): void
  10295. /** [UserInfoButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.hide.html)
  10296. *
  10297. * 隐藏用户信息按钮。 */
  10298. hide(): void
  10299. /** [UserInfoButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.offTap.html)
  10300. *
  10301. * 取消监听用户信息按钮的点击事件 */
  10302. offTap(
  10303. /** 用户信息按钮的点击事件的回调函数 */
  10304. callback?: UserInfoButtonOffTapCallback
  10305. ): void
  10306. /** [UserInfoButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.onTap.html)
  10307. *
  10308. * 监听用户信息按钮的点击事件 */
  10309. onTap(
  10310. /** 用户信息按钮的点击事件的回调函数 */
  10311. callback: UserInfoButtonOnTapCallback
  10312. ): void
  10313. /** [UserInfoButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.show.html)
  10314. *
  10315. * 显示用户信息按钮 */
  10316. show(): void
  10317. }
  10318. interface Video {
  10319. /** [Promise Video.exitFullScreen()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.exitFullScreen.html)
  10320. *
  10321. * 视频退出全屏 */
  10322. exitFullScreen(): Promise<any>
  10323. /** [Promise Video.pause()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.pause.html)
  10324. *
  10325. * 暂停视频 */
  10326. pause(): Promise<any>
  10327. /** [Promise Video.play()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.play.html)
  10328. *
  10329. * 播放视频 */
  10330. play(): Promise<any>
  10331. /** [Promise Video.requestFullScreen(number direction)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.requestFullScreen.html)
  10332. *
  10333. * 视频全屏 */
  10334. requestFullScreen(
  10335. /** 设置全屏时视频的方向
  10336. *
  10337. * 参数 direction 可选值:
  10338. * - 0: 正常竖向;
  10339. * - 90: 屏幕逆时针90度;
  10340. * - -90: 屏幕顺时针90度; */
  10341. direction: 0 | 90 | -90
  10342. ): Promise<any>
  10343. /** [Promise Video.seek(number time)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.seek.html)
  10344. *
  10345. * 视频跳转 */
  10346. seek(
  10347. /** 视频跳转到指定位置,单位为 s 秒 */
  10348. time: number
  10349. ): Promise<any>
  10350. /** [Promise Video.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.stop.html)
  10351. *
  10352. * 停止视频 */
  10353. stop(): Promise<any>
  10354. /** [Video.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.destroy.html)
  10355. *
  10356. * 销毁视频 */
  10357. destroy(): void
  10358. /** [Video.offEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offEnded.html)
  10359. *
  10360. * 取消监听视频播放到末尾事件 */
  10361. offEnded(
  10362. /** 视频播放到末尾事件的回调函数 */
  10363. callback?: OffEndedCallback
  10364. ): void
  10365. /** [Video.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offError.html)
  10366. *
  10367. * 取消监听视频错误事件 */
  10368. offError(
  10369. /** 视频错误事件的回调函数 */
  10370. callback?: VideoOffErrorCallback
  10371. ): void
  10372. /** [Video.offPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offPause.html)
  10373. *
  10374. * 取消监听视频暂停事件 */
  10375. offPause(
  10376. /** 视频暂停事件的回调函数 */
  10377. callback?: OffPauseCallback
  10378. ): void
  10379. /** [Video.offPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offPlay.html)
  10380. *
  10381. * 取消监听视频播放事件 */
  10382. offPlay(
  10383. /** 视频播放事件的回调函数 */
  10384. callback?: OffPlayCallback
  10385. ): void
  10386. /** [Video.offProgress(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offProgress.html)
  10387. *
  10388. * 取消监听视频下载(缓冲)事件 */
  10389. offProgress(
  10390. /** 视频下载(缓冲)事件的回调函数 */
  10391. callback?: OffProgressCallback
  10392. ): void
  10393. /** [Video.offTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offTimeUpdate.html)
  10394. *
  10395. * 取消监听视频播放进度更新事件 */
  10396. offTimeUpdate(
  10397. /** 视频播放进度更新事件的回调函数 */
  10398. callback?: VideoOffTimeUpdateCallback
  10399. ): void
  10400. /** [Video.offWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offWaiting.html)
  10401. *
  10402. * 取消监听视频由于需要缓冲下一帧而停止时触发 */
  10403. offWaiting(
  10404. /** 的回调函数 */
  10405. callback?: OffWaitingCallback
  10406. ): void
  10407. /** [Video.onEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onEnded.html)
  10408. *
  10409. * 监听视频播放到末尾事件 */
  10410. onEnded(
  10411. /** 视频播放到末尾事件的回调函数 */
  10412. callback: OnEndedCallback
  10413. ): void
  10414. /** [Video.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onError.html)
  10415. *
  10416. * 监听视频错误事件 */
  10417. onError(
  10418. /** 视频错误事件的回调函数 */
  10419. callback: VideoOnErrorCallback
  10420. ): void
  10421. /** [Video.onPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onPause.html)
  10422. *
  10423. * 监听视频暂停事件 */
  10424. onPause(
  10425. /** 视频暂停事件的回调函数 */
  10426. callback: OnPauseCallback
  10427. ): void
  10428. /** [Video.onPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onPlay.html)
  10429. *
  10430. * 监听视频播放事件 */
  10431. onPlay(
  10432. /** 视频播放事件的回调函数 */
  10433. callback: OnPlayCallback
  10434. ): void
  10435. /** [Video.onProgress(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onProgress.html)
  10436. *
  10437. * 监听视频下载(缓冲)事件 */
  10438. onProgress(
  10439. /** 视频下载(缓冲)事件的回调函数 */
  10440. callback: OnProgressCallback
  10441. ): void
  10442. /** [Video.onTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onTimeUpdate.html)
  10443. *
  10444. * 监听视频播放进度更新事件 */
  10445. onTimeUpdate(
  10446. /** 视频播放进度更新事件的回调函数 */
  10447. callback: VideoOnTimeUpdateCallback
  10448. ): void
  10449. /** [Video.onWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onWaiting.html)
  10450. *
  10451. * 监听视频由于需要缓冲下一帧而停止时触发 */
  10452. onWaiting(
  10453. /** 的回调函数 */
  10454. callback: OnWaitingCallback
  10455. ): void
  10456. }
  10457. interface VideoDecoder {
  10458. /** [Object VideoDecoder.getFrameData()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.getFrameData.html)
  10459. *
  10460. * 需要基础库: `2.11.1`
  10461. *
  10462. * 获取下一帧的解码数据 */
  10463. getFrameData(): FrameDataOptions
  10464. /** [Promise VideoDecoder.remove()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.remove.html)
  10465. *
  10466. * 需要基础库: `2.11.1`
  10467. *
  10468. * 移除解码器 */
  10469. remove(): Promise<any>
  10470. /** [Promise VideoDecoder.seek(number position)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.seek.html)
  10471. *
  10472. * 需要基础库: `2.11.1`
  10473. *
  10474. * 跳到某个时间点解码 */
  10475. seek(
  10476. /** 跳转的解码位置,单位 ms */
  10477. position: number
  10478. ): Promise<any>
  10479. /** [Promise VideoDecoder.start(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.start.html)
  10480. *
  10481. * 需要基础库: `2.11.1`
  10482. *
  10483. * 开始解码 */
  10484. start(option: VideoDecoderStartOption): Promise<any>
  10485. /** [Promise VideoDecoder.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.stop.html)
  10486. *
  10487. * 需要基础库: `2.11.1`
  10488. *
  10489. * 停止解码 */
  10490. stop(): Promise<any>
  10491. /** [VideoDecoder.off(string eventName, function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.off.html)
  10492. *
  10493. * 需要基础库: `2.11.1`
  10494. *
  10495. * 取消监听录制事件。当对应事件触发时,该回调函数不再执行 */
  10496. off(
  10497. /** 事件名 */
  10498. eventName: string,
  10499. /** 事件触发时执行的回调函数 */
  10500. callback: (...args: any[]) => any
  10501. ): void
  10502. /** [VideoDecoder.on(string eventName, function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.on.html)
  10503. *
  10504. * 需要基础库: `2.11.1`
  10505. *
  10506. * 注册监听录制事件的回调函数。当对应事件触发时,回调函数会被执行 */
  10507. on(
  10508. /** 事件名
  10509. *
  10510. * 参数 eventName 可选值:
  10511. * - 'start': 开始事件。返回 {width, height};
  10512. * - 'stop': 结束事件。;
  10513. * - 'seek': seek 完成事件。;
  10514. * - 'bufferchange': 缓冲区变化事件。;
  10515. * - 'ended': 解码结束事件。; */
  10516. eventName: 'start' | 'stop' | 'seek' | 'bufferchange' | 'ended',
  10517. /** 事件触发时执行的回调函数 */
  10518. callback: (...args: any[]) => any
  10519. ): void
  10520. }
  10521. interface WebAudioContext {
  10522. /** [BiquadFilterNode WebAudioContext.createBiquadFilter()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createBiquadFilter.html)
  10523. *
  10524. * 创建一个BiquadFilterNode */
  10525. createBiquadFilter(): BiquadFilterNode
  10526. /** [BufferSourceNode WebAudioContext.createBufferSource()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createBufferSource.html)
  10527. *
  10528. * 创建一个BufferSourceNode实例,通过AudioBuffer对象来播放音频数据。 */
  10529. createBufferSource(): BufferSourceNode
  10530. /** [ChannelMergerNode WebAudioContext.createChannelMerger(number numberOfInputs)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createChannelMerger.html)
  10531. *
  10532. * 创建一个ChannelMergerNode */
  10533. createChannelMerger(
  10534. /** 输出流中需要保持的输入流的个数 */
  10535. numberOfInputs: number
  10536. ): ChannelMergerNode
  10537. /** [ChannelSplitterNode WebAudioContext.createChannelSplitter(number numberOfOutputs)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createChannelSplitter.html)
  10538. *
  10539. * 创建一个ChannelSplitterNode */
  10540. createChannelSplitter(
  10541. /** 要分别输出的输入音频流中的通道数 */
  10542. numberOfOutputs: number
  10543. ): ChannelSplitterNode
  10544. /** [ConstantSourceNode WebAudioContext.createConstantSource()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createConstantSource.html)
  10545. *
  10546. * 创建一个ConstantSourceNode */
  10547. createConstantSource(): ConstantSourceNode
  10548. /** [DelayNode WebAudioContext.createDelay(number maxDelayTime)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createDelay.html)
  10549. *
  10550. * 创建一个DelayNode */
  10551. createDelay(
  10552. /** 最大延迟时间 */
  10553. maxDelayTime: number
  10554. ): DelayNode
  10555. /** [DynamicsCompressorNode WebAudioContext.createDynamicsCompressor()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createDynamicsCompressor.html)
  10556. *
  10557. * 创建一个DynamicsCompressorNode */
  10558. createDynamicsCompressor(): DynamicsCompressorNode
  10559. /** [GainNode WebAudioContext.createGain()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createGain.html)
  10560. *
  10561. * 创建一个GainNode */
  10562. createGain(): GainNode
  10563. /** [IIRFilterNode WebAudioContext.createIIRFilter(Array.&lt;number&gt; feedforward, Array.&lt;number&gt; feedback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createIIRFilter.html)
  10564. *
  10565. * 创建一个IIRFilterNode */
  10566. createIIRFilter(
  10567. /** 一个浮点值数组,指定IIR滤波器传递函数的前馈(分子)系数。 */
  10568. feedforward: number[],
  10569. /** 一个浮点值数组,指定IIR滤波器传递函数的反馈(分母)系数。 */
  10570. feedback: number[]
  10571. ): IIRFilterNode
  10572. /** [OscillatorNode WebAudioContext.createOscillator()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createOscillator.html)
  10573. *
  10574. * 创建一个OscillatorNode */
  10575. createOscillator(): OscillatorNode
  10576. /** [PannerNode WebAudioContext.createPanner()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createPanner.html)
  10577. *
  10578. * 创建一个PannerNode */
  10579. createPanner(): PannerNode
  10580. /** [PeriodicWaveNode WebAudioContext.createPeriodicWave(Float32Array real, Float32Array imag, object constraints)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createPeriodicWave.html)
  10581. *
  10582. * 创建一个PeriodicWaveNode
  10583. *
  10584. * **注意**
  10585. *
  10586. * `real`和`imag`数组必须拥有一样的长度,否则抛出错误
  10587. * ```js
  10588. const real = new Float32Array(2)
  10589. const imag = new Float32Array(2)
  10590. real[0] = 0
  10591. imag[0] = 0
  10592. real[1] = 1
  10593. imag[1] = 0
  10594. const waveNode = audioContext.createPeriodicWave(real, imag, {disableNormalization: true})
  10595. ``` */
  10596. createPeriodicWave(
  10597. /** 一组余弦项(传统上是A项) */
  10598. real: Float32Array,
  10599. /** 一组余弦项(传统上是A项) */
  10600. imag: Float32Array,
  10601. /** 一个字典对象,它指定是否应该禁用规范化(默认启用规范化) */
  10602. constraints: Constraints
  10603. ): PeriodicWaveNode
  10604. /** [Promise WebAudioContext.close()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.close.html)
  10605. *
  10606. * 关闭WebAudioContext
  10607. *
  10608. * **注意事项**
  10609. *
  10610. * 同步关闭对应的WebAudio上下文。close后会立即释放当前上下文的资源,<b>不要在close后再次访问state属性。</b>
  10611. * ```js
  10612. const audioCtx = wx.createWebAudioContext()
  10613. audioCtx.close().then(() => {
  10614. console.log(audioCtx.state) // bad case:不应该在close后再访问state
  10615. })
  10616. ``` */
  10617. close(): Promise<any>
  10618. /** [Promise WebAudioContext.resume()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.resume.html)
  10619. *
  10620. * 同步恢复已经被暂停的WebAudioContext上下文 */
  10621. resume(): Promise<any>
  10622. /** [Promise WebAudioContext.suspend()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.suspend.html)
  10623. *
  10624. * 同步暂停WebAudioContext上下文 */
  10625. suspend(): Promise<any>
  10626. /** [ScriptProcessorNode WebAudioContext.createScriptProcessor(number bufferSize, number numberOfInputChannels, number numberOfOutputChannels)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createScriptProcessor.html)
  10627. *
  10628. * 创建一个ScriptProcessorNode */
  10629. createScriptProcessor(
  10630. /** 缓冲区大小,以样本帧为单位 */
  10631. bufferSize: number,
  10632. /** 用于指定输入node的声道的数量 */
  10633. numberOfInputChannels: number,
  10634. /** 用于指定输出node的声道的数量 */
  10635. numberOfOutputChannels: number
  10636. ): ScriptProcessorNode
  10637. /** [WaveShaperNode WebAudioContext.createWaveShaper()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createWaveShaper.html)
  10638. *
  10639. * 创建一个WaveShaperNode */
  10640. createWaveShaper(): WaveShaperNode
  10641. /** [[AudioBuffer](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.html) WebAudioContext.createBuffer(number numOfChannels, number length, number sampleRate)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createBuffer.html)
  10642. *
  10643. * 创建一个AudioBuffer,代表着一段驻留在内存中的短音频 */
  10644. createBuffer(
  10645. /** 定义了 buffer 中包含的声频通道数量的整数 */
  10646. numOfChannels: number,
  10647. /** 代表 buffer 中的样本帧数的整数 */
  10648. length: number,
  10649. /** 线性音频样本的采样率,即每一秒包含的关键帧的个数 */
  10650. sampleRate: number
  10651. ): AudioBuffer
  10652. /** [[AudioBuffer](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.html) WebAudioContext.decodeAudioData()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.decodeAudioData.html)
  10653. *
  10654. * 异步解码一段资源为AudioBuffer。 */
  10655. decodeAudioData(): AudioBuffer
  10656. }
  10657. interface WebGLRenderingContext {
  10658. /** [WebGLRenderingContext.wxBindCanvasTexture(number texture, [Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html) canvas)](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/WebGLRenderingContext.wxBindCanvasTexture.html)
  10659. *
  10660. * 需要基础库: `2.0.0`
  10661. *
  10662. * 将一个 Canvas 对应的 Texture 绑定到 WebGL 上下文。
  10663. * - 仅 iOS 支持 wxBindCanvasTexture 接口,其他平台可使用示例代码中的替代方法
  10664. *
  10665. * **示例代码**
  10666. *
  10667. * 使用 wxBindCanvasTexture
  10668. *
  10669. * ```javascript
  10670. gl.wxBindCanvasTexture(gl.TEXTURE_2D, canvas)
  10671. ```
  10672. * 等同于
  10673. *
  10674. * ```javascript
  10675. const texture = gl.createTexture()
  10676. gl.bindTexture(gl.TEXTURE_2D, texture)
  10677. // ......
  10678. gl.texImage2D(target, level, internalformat, format, type, canvas)
  10679. ``` */
  10680. wxBindCanvasTexture(
  10681. /** WebGL 的纹理类型枚举值 */
  10682. texture: number,
  10683. /** [Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html)
  10684. *
  10685. * 需要绑定为 Texture 的 Canvas */
  10686. canvas: Canvas
  10687. ): void
  10688. }
  10689. interface Worker {
  10690. /** [Worker.getCameraFrameData()](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.getCameraFrameData.html)
  10691. *
  10692. * 获取摄像头当前帧图像,返回ArrayBuffer数据。仅限在 worker 线程中使用。
  10693. * ## 注意事项
  10694. * - 接口仅在小游戏中可用
  10695. * - 接口仅在 iOS 上可用
  10696. * - 接口仅在 worker 线程中可用
  10697. * - 接口仅在 useExperimentalWorker 为 true 时可用
  10698. * - 使用前需要先在主线程调用 Camera.listenFrameChange(worker)
  10699. * - 该接口的目的是借助 iOS ExperimentalWorker 的JS高运行性能,配合摄像头帧数据实现 VR 游戏场景
  10700. * - 由于安卓主线程本身已经支持JIT,因此安卓上可以直接在主线程使用 Camera.onCameraFrame 接口实现 VR 场景
  10701. *
  10702. * **示例代码**
  10703. *
  10704. * ```js
  10705. // game.js
  10706. const worker = wx.createWorker('workers/index.js', {
  10707. useExperimentalWorker: true
  10708. })
  10709. const camera = wx.createCamera({
  10710. success() {
  10711. camera.listenFrameChange(worker)
  10712. }
  10713. })
  10714. ```
  10715. *
  10716. * ```js
  10717. // workers/index.js
  10718. const data = worker.getCameraFrameData()
  10719. console.log(data)
  10720. ``` */
  10721. getCameraFrameData(): void
  10722. /** [Worker.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.onMessage.html)
  10723. *
  10724. * 监听主线程/Worker 线程向当前线程发送的消息的事件。 */
  10725. onMessage(
  10726. /** 主线程/Worker 线程向当前线程发送的消息的事件的回调函数 */
  10727. callback: WorkerOnMessageCallback
  10728. ): void
  10729. /** [Worker.onProcessKilled(function callback)](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.onProcessKilled.html)
  10730. *
  10731. * 监听 worker线程被系统回收事件(当iOS系统资源紧张时,worker线程存在被系统回收的可能,开发者可监听此事件并重新创建一个worker)。仅限在主线程 worker 对象上调用。 */
  10732. onProcessKilled(
  10733. /** worker线程被系统回收事件的回调函数 */
  10734. callback: OnProcessKilledCallback
  10735. ): void
  10736. /** [Worker.postMessage(Object message)](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.postMessage.html)
  10737. *
  10738. * 向主线程/Worker 线程发送的消息。
  10739. *
  10740. * **示例代码**
  10741. *
  10742. * worker 线程中
  10743. * ```js
  10744. worker.postMessage({
  10745. msg: 'hello from worker'
  10746. })
  10747. ```
  10748. *
  10749. * 主线程中
  10750. * ```js
  10751. const worker = wx.createWorker('workers/request/index.js')
  10752. worker.postMessage({
  10753. msg: 'hello from main'
  10754. })
  10755. ```
  10756. *
  10757. * **提醒**
  10758. *
  10759. * 在基础库版本2.20.2之前,postMessage仅支持传递可序列化的key-value对象。
  10760. * 在基础库2.20.2之后,postMessage支持传递任意类型的数据。 */
  10761. postMessage(
  10762. /** 需要发送的消息。 */
  10763. message: IAnyObject
  10764. ): void
  10765. /** [Worker.terminate()](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.terminate.html)
  10766. *
  10767. * 结束当前 Worker 线程。仅限在主线程 worker 对象上调用。 */
  10768. terminate(): void
  10769. }
  10770. interface WriteSyncError {
  10771. /** 错误信息
  10772. *
  10773. * | 错误信息 | 说明 |
  10774. * | - | - |
  10775. * | bad file descriptor | 无效的文件描述符 |
  10776. * | fail permission denied | 指定的 fd 路径没有写权限 |
  10777. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
  10778. /** 错误码
  10779. *
  10780. * | 错误信息 | 说明 |
  10781. * | - | - |
  10782. * | bad file descriptor | 无效的文件描述符 |
  10783. * | fail permission denied | 指定的 fd 路径没有写权限 |
  10784. * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
  10785. }
  10786. interface Wx {
  10787. /** [ArrayBuffer wx.encode(Object object)](https://developers.weixin.qq.com/minigame/dev/api/util/wx.encode.html)
  10788. *
  10789. * 将字符串按照指定的编码格式编码成 ArrayBuffer */
  10790. encode(option: EncodeOption): ArrayBuffer
  10791. /** [Boolean wx.setHandoffQuery(String query)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.setHandoffQuery.html)
  10792. *
  10793. * 需要基础库: `2.14.4`
  10794. *
  10795. * 设置接力参数,该接口需要在游戏域调用 */
  10796. setHandoffQuery(
  10797. /** 需要传递给接力设备的参数,格式 为querystring */
  10798. query: string
  10799. ): boolean
  10800. /** [Object wx.getAccountInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/open-api/account-info/wx.getAccountInfoSync.html)
  10801. *
  10802. * 需要基础库: `2.11.2`
  10803. *
  10804. * 获取当前帐号信息。线上小程序版本号仅支持在正式版小程序中获取,开发版和体验版中无法获取。
  10805. *
  10806. * **示例代码**
  10807. *
  10808. * ```js
  10809. const accountInfo = wx.getAccountInfoSync();
  10810. console.log(accountInfo.miniProgram.appId) // 小程序 appId
  10811. console.log(accountInfo.plugin.appId) // 插件 appId
  10812. console.log(accountInfo.plugin.version) // 插件版本号, 'a.b.c' 这样的形式
  10813. ``` */
  10814. getAccountInfoSync(): AccountInfo
  10815. /** [Object wx.getBatteryInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfoSync.html)
  10816. *
  10817. * [wx.getBatteryInfo](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfo.html) 的同步版本 */
  10818. getBatteryInfoSync(): GetBatteryInfoSyncResult
  10819. /** [Object wx.getEnterOptionsSync()](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.getEnterOptionsSync.html)
  10820. *
  10821. * 需要基础库: `2.13.2`
  10822. *
  10823. * 获取小游戏打开的参数(包括冷启动和热启动)
  10824. *
  10825. * **返回有效 referrerInfo 的场景**
  10826. *
  10827. * | 场景值 | 场景 | appId含义 |
  10828. * | ------ | ------------------------------- | ---------- |
  10829. * | 1020 | 公众号 profile 页相关小程序列表 | 来源公众号 |
  10830. * | 1035 | 公众号自定义菜单 | 来源公众号 |
  10831. * | 1036 | App 分享消息卡片 | 来源App |
  10832. * | 1037 | 小程序打开小程序 | 来源小程序 |
  10833. * | 1038 | 从另一个小程序返回 | 来源小程序 |
  10834. * | 1043 | 公众号模板消息 | 来源公众号 |
  10835. *
  10836. * **注意**
  10837. *
  10838. * 部分版本在无`referrerInfo`的时候会返回 `undefined`,建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 */
  10839. getEnterOptionsSync(): EnterOptionsGame
  10840. /** [Object wx.getExptInfoSync(Array.&lt;string&gt; keys)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.getExptInfoSync.html)
  10841. *
  10842. * 需要基础库: `2.17.0`
  10843. *
  10844. * 给定实验参数数组,获取对应的实验参数值
  10845. *
  10846. * **提示**
  10847. *
  10848. * 假设实验参数有 `color`, `size`
  10849. * 调用 wx.getExptInfoSync() 会返回 `{color:'#fff',size:20}` 类似的结果
  10850. * 而 wx.getExptInfoSync(['color']) 则只会返回 `{color:'#fff'}` */
  10851. getExptInfoSync(
  10852. /** 实验参数数组,不填则获取所有实验参数 */
  10853. keys?: string[]
  10854. ): IAnyObject
  10855. /** [Object wx.getExtConfigSync()](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfigSync.html)
  10856. *
  10857. * 需要基础库: `2.8.3`
  10858. *
  10859. * [wx.getExtConfig](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfig.html) 的同步版本。
  10860. *
  10861. * **Tips**
  10862. *
  10863. * 1. 本接口暂时无法通过 [wx.canIUse](#) 判断是否兼容,开发者需要自行判断 [wx.getExtConfigSync](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfigSync.html) 是否存在来兼容
  10864. *
  10865. * ****
  10866. *
  10867. * ```js
  10868. let extConfig = wx.getExtConfigSync? wx.getExtConfigSync(): {}
  10869. console.log(extConfig)
  10870. ``` */
  10871. getExtConfigSync(): IAnyObject
  10872. /** [Object wx.getLaunchOptionsSync()](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html)
  10873. *
  10874. * 获取小游戏冷启动时的参数。热启动参数通过 [wx.onShow](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onShow.html) 接口获取。
  10875. *
  10876. * **返回有效 referrerInfo 的场景**
  10877. *
  10878. * | 场景值 | 场景 | appId含义 |
  10879. * | ------ | ------------------------------- | ---------- |
  10880. * | 1020 | 公众号 profile 页相关小程序列表 | 来源公众号 |
  10881. * | 1035 | 公众号自定义菜单 | 来源公众号 |
  10882. * | 1036 | App 分享消息卡片 | 来源App |
  10883. * | 1037 | 小程序打开小程序 | 来源小程序 |
  10884. * | 1038 | 从另一个小程序返回 | 来源小程序 |
  10885. * | 1043 | 公众号模板消息 | 来源公众号 |
  10886. *
  10887. * **注意**
  10888. *
  10889. * 部分版本在无`referrerInfo`的时候会返回 `undefined`,
  10890. * 建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 */
  10891. getLaunchOptionsSync(): LaunchOptionsGame
  10892. /** [Object wx.getMenuButtonBoundingClientRect()](https://developers.weixin.qq.com/minigame/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html)
  10893. *
  10894. * 需要基础库: `2.1.0`
  10895. *
  10896. * 获取菜单按钮(右上角胶囊按钮)的布局位置信息。坐标信息以屏幕左上角为原点。
  10897. *
  10898. * **示例代码**
  10899. *
  10900. * ```js
  10901. const res = wx.getMenuButtonBoundingClientRect()
  10902. console.log(res.width)
  10903. console.log(res.height)
  10904. console.log(res.top)
  10905. console.log(res.right)
  10906. console.log(res.bottom)
  10907. console.log(res.left)
  10908. ``` */
  10909. getMenuButtonBoundingClientRect(): ClientRect
  10910. /** [Object wx.getStorageInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageInfoSync.html)
  10911. *
  10912. * [wx.getStorageInfo](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageInfo.html) 的同步版本
  10913. *
  10914. * **示例代码**
  10915. *
  10916. * ```js
  10917. wx.getStorageInfo({
  10918. success (res) {
  10919. console.log(res.keys)
  10920. console.log(res.currentSize)
  10921. console.log(res.limitSize)
  10922. }
  10923. })
  10924. ```
  10925. *
  10926. * ```js
  10927. try {
  10928. const res = wx.getStorageInfoSync()
  10929. console.log(res.keys)
  10930. console.log(res.currentSize)
  10931. console.log(res.limitSize)
  10932. } catch (e) {
  10933. // Do something when catch error
  10934. }
  10935. ``` */
  10936. getStorageInfoSync(): GetStorageInfoSyncOption
  10937. /** [Object wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html)
  10938. *
  10939. * [wx.getSystemInfo](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfo.html) 的同步版本
  10940. *
  10941. * **示例代码**
  10942. *
  10943. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/WkUCgXmS7mqO)
  10944. *
  10945. * ```js
  10946. wx.getSystemInfo({
  10947. success (res) {
  10948. console.log(res.model)
  10949. console.log(res.pixelRatio)
  10950. console.log(res.windowWidth)
  10951. console.log(res.windowHeight)
  10952. console.log(res.language)
  10953. console.log(res.version)
  10954. console.log(res.platform)
  10955. }
  10956. })
  10957. ```
  10958. *
  10959. * ```js
  10960. try {
  10961. const res = wx.getSystemInfoSync()
  10962. console.log(res.model)
  10963. console.log(res.pixelRatio)
  10964. console.log(res.windowWidth)
  10965. console.log(res.windowHeight)
  10966. console.log(res.language)
  10967. console.log(res.version)
  10968. console.log(res.platform)
  10969. } catch (e) {
  10970. // Do something when catch error
  10971. }
  10972. ``` */
  10973. getSystemInfoSync(): SystemInfo
  10974. /** [[BannerAd](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.html) wx.createBannerAd(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createBannerAd.html)
  10975. *
  10976. * 需要基础库: `2.0.4`
  10977. *
  10978. * 创建 banner 广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.0.4 后再使用该 API。每次调用该方法创建 banner 广告都会返回一个全新的实例。 */
  10979. createBannerAd(option: CreateBannerAdOption): BannerAd
  10980. /** [[Camera](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.html) wx.createCamera(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/wx.createCamera.html)
  10981. *
  10982. * 需要基础库: `2.9.0`
  10983. *
  10984. * 创建相机 */
  10985. createCamera(option: CreateCameraOption): Camera
  10986. /** [[Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html) wx.createCanvas()](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/wx.createCanvas.html)
  10987. *
  10988. * 创建一个画布对象。首次调用创建的是显示在屏幕上的画布,之后调用创建的都是离屏画布。 */
  10989. createCanvas(): Canvas
  10990. /** [[Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html) wx.getSharedCanvas()](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getSharedCanvas.html)
  10991. *
  10992. * 获取主域和开放数据域共享的 sharedCanvas。**只有开放数据域能调用。** */
  10993. getSharedCanvas(): Canvas
  10994. /** [[DownloadTask](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.html) wx.downloadFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/download/wx.downloadFile.html)
  10995. *
  10996. * 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径),单次下载允许的最大文件为 200MB。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。
  10997. *
  10998. * 注意:请在服务端响应的 header 中指定合理的 `Content-Type` 字段,以保证客户端正确处理文件类型。
  10999. *
  11000. * **示例代码**
  11001. *
  11002. * ```js
  11003. wx.downloadFile({
  11004. url: 'https://example.com/audio/123', //仅为示例,并非真实的资源
  11005. success (res) {
  11006. // 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
  11007. if (res.statusCode === 200) {
  11008. wx.playVoice({
  11009. filePath: res.tempFilePath
  11010. })
  11011. }
  11012. }
  11013. })
  11014. ``` */
  11015. downloadFile(option: DownloadFileOption): DownloadTask
  11016. /** [[FeedbackButton](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.html) wx.createFeedbackButton(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/wx.createFeedbackButton.html)
  11017. *
  11018. * 需要基础库: `2.1.2`
  11019. *
  11020. * 创建打开意见反馈页面的按钮 */
  11021. createFeedbackButton(
  11022. option: CreateOpenSettingButtonOption
  11023. ): FeedbackButton
  11024. /** [[FileSystemManager](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.html) wx.getFileSystemManager()](https://developers.weixin.qq.com/minigame/dev/api/file/wx.getFileSystemManager.html)
  11025. *
  11026. * 获取全局唯一的文件管理器 */
  11027. getFileSystemManager(): FileSystemManager
  11028. /** [[GameBanner](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.html) wx.createGameBanner(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/wx.createGameBanner.html)
  11029. *
  11030. * 需要基础库: `2.7.5`
  11031. * @deprecated 基础库版本 [2.18.1](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
  11032. *
  11033. * 创建小游戏推荐banner组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.7.5 后再使用该 API。每次调用该方法都会返回一个全新的实例。 */
  11034. createGameBanner(option: CreateGameBannerOption): GameBanner
  11035. /** [[GameClubButton](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.html) wx.createGameClubButton(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/wx.createGameClubButton.html)
  11036. *
  11037. * 需要基础库: `2.0.3`
  11038. *
  11039. * 创建游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈。更多关于游戏圈的信息见 [游戏圈使用指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/game-club.html) */
  11040. createGameClubButton(option: CreateGameClubButtonOption): GameClubButton
  11041. /** [[GameIcon](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.html) wx.createGameIcon(Object object, Object styleItem)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/wx.createGameIcon.html)
  11042. *
  11043. * 需要基础库: `2.8.3`
  11044. * @deprecated 基础库版本 [2.18.1](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
  11045. *
  11046. * 创建小游戏推荐icon组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.8.2 后再使用该 API。每次调用该方法都会返回一个全新的实例。 */
  11047. createGameIcon(
  11048. option: CreateGameIconOption,
  11049. /** 单个游戏icon的位置和样式信息 */
  11050. styleItem: StyleItem
  11051. ): GameIcon
  11052. /** [[GamePortal](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.html) wx.createGamePortal(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/wx.createGamePortal.html)
  11053. *
  11054. * 需要基础库: `2.7.5`
  11055. * @deprecated 基础库版本 [2.18.1](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
  11056. *
  11057. * 创建小游戏推荐弹窗组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.7.5 后再使用该 API。每次调用该方法都会返回一个全新的实例。 */
  11058. createGamePortal(option: CreateGamePortalOption): GamePortal
  11059. /** [[GameRecorderShareButton](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.html) wx.createGameRecorderShareButton(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/wx.createGameRecorderShareButton.html)
  11060. *
  11061. * 需要基础库: `2.8.0`
  11062. *
  11063. * 创建游戏对局回放分享按钮,返回一个单例对象。按钮在被用户点击后会发起对最近一次录制完成的游戏对局回放的分享。 */
  11064. createGameRecorderShareButton(
  11065. option: CreateGameRecorderShareButtonOption
  11066. ): GameRecorderShareButton
  11067. /** [[GameRecorder](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.html) wx.getGameRecorder()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/wx.getGameRecorder.html)
  11068. *
  11069. * 需要基础库: `2.8.0`
  11070. *
  11071. * 获取全局唯一的游戏画面录制对象 */
  11072. getGameRecorder(): GameRecorder
  11073. /** [[GameServerManager](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.html) wx.getGameServerManager()](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/wx.getGameServerManager.html)
  11074. *
  11075. * 需要基础库: `2.8.0`
  11076. *
  11077. * 获取 **全局唯一** 的游戏服务管理器。 */
  11078. getGameServerManager(): GameServerManager
  11079. /** [[GridAd](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.html) wx.createGridAd(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createGridAd.html)
  11080. *
  11081. * 需要基础库: `2.9.2`
  11082. *
  11083. * 创建 grid(格子) 广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.9.2 后再使用该 API。每次调用该方法创建 grid(格子) 广告都会返回一个全新的实例。 */
  11084. createGridAd(option: CreateGridAdOption): GridAd
  11085. /** [[Image](https://developers.weixin.qq.com/minigame/dev/api/render/image/Image.html) wx.createImage()](https://developers.weixin.qq.com/minigame/dev/api/render/image/wx.createImage.html)
  11086. *
  11087. * 创建一个图片对象 */
  11088. createImage(): Image
  11089. /** [[InnerAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.html) wx.createInnerAudioContext(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createInnerAudioContext.html)
  11090. *
  11091. * 需要基础库: `1.6.0`
  11092. *
  11093. * 创建内部 [audio](#) 上下文 [InnerAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.html) 对象。 */
  11094. createInnerAudioContext(
  11095. option?: CreateInnerAudioContextOption
  11096. ): InnerAudioContext
  11097. /** [[InterstitialAd](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.html) wx.createInterstitialAd(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createInterstitialAd.html)
  11098. *
  11099. * 需要基础库: `2.6.0`
  11100. *
  11101. * 创建插屏广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用)。 */
  11102. createInterstitialAd(option: CreateInterstitialAdOption): InterstitialAd
  11103. /** [[LoadSubpackageTask](https://developers.weixin.qq.com/minigame/dev/api/base/subpackage/LoadSubpackageTask.html) wx.loadSubpackage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/subpackage/wx.loadSubpackage.html)
  11104. *
  11105. * 需要基础库: `2.1.0`
  11106. *
  11107. * 触发分包加载,详见 [分包加载](#) */
  11108. loadSubpackage(option: LoadSubpackageOption): LoadSubpackageTask
  11109. /** [[LogManager](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.html) wx.getLogManager(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/wx.getLogManager.html)
  11110. *
  11111. * 需要基础库: `2.1.0`
  11112. *
  11113. * 获取日志管理器对象。
  11114. *
  11115. * **示例代码**
  11116. *
  11117. * ```js
  11118. const logger = wx.getLogManager({level: 1})
  11119. logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3])
  11120. logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
  11121. logger.debug({str: 'hello world'}, 'debug log', 100, [1, 2, 3])
  11122. logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
  11123. ``` */
  11124. getLogManager(option: GetLogManagerOption): LogManager
  11125. /** [[MediaAudioPlayer](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.html) wx.createMediaAudioPlayer()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createMediaAudioPlayer.html)
  11126. *
  11127. * 需要基础库: `2.13.0`
  11128. *
  11129. * 创建媒体音频播放器对象 [MediaAudioPlayer](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.html) 对象,可用于播放视频解码器 [VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html) 输出的音频。
  11130. *
  11131. * **示例代码**
  11132. *
  11133. * ```js
  11134. // 创建视频解码器,具体参数见 createVideoDecoder 文档
  11135. const videoDecoder = wx.createVideoDecoder()
  11136. // 创建媒体音频播放器
  11137. const mediaAudioPlayer = wx.createMediaAudioPlayer()
  11138. // 启动视频解码器
  11139. videoDecoder.start()
  11140. // 启动播放器
  11141. mediaAudioPlayer.start().then(() => {
  11142. // 添加播放器音频来源
  11143. mediaAudioPlayer.addAudioSource(videoDecoder).then(res => {
  11144. videoDecoder.getFrameData() // 建议在 requestAnimationFrame 里获取每一帧视频数据
  11145. console.log(res)
  11146. })
  11147. // 移除播放器音频来源
  11148. mediaAudioPlayer.removeAudioSource(videoDecoder).then()
  11149. // 停止播放器
  11150. mediaAudioPlayer.stop().then()
  11151. // 销毁播放器
  11152. mediaAudioPlayer.destroy().then()
  11153. // 设置播放器音量
  11154. mediaAudioPlayer.volume = 0.5
  11155. })
  11156. ```
  11157. *
  11158. * **完整demo(小游戏)**
  11159. *
  11160. * - https://developers.weixin.qq.com/s/SF2duHmb7MjI */
  11161. createMediaAudioPlayer(): MediaAudioPlayer
  11162. /** [[OpenDataContext](https://developers.weixin.qq.com/minigame/dev/api/open-api/context/OpenDataContext.html) wx.getOpenDataContext()](https://developers.weixin.qq.com/minigame/dev/api/open-api/context/wx.getOpenDataContext.html)
  11163. *
  11164. * 需要基础库: `1.9.92`
  11165. *
  11166. * 获取开放数据域 */
  11167. getOpenDataContext(): OpenDataContext
  11168. /** [[OpenSettingButton](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.html) wx.createOpenSettingButton(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.createOpenSettingButton.html)
  11169. *
  11170. * 需要基础库: `2.0.7`
  11171. *
  11172. * 创建打开设置页面的按钮 */
  11173. createOpenSettingButton(
  11174. option: CreateOpenSettingButtonOption
  11175. ): OpenSettingButton
  11176. /** [[Performance](https://developers.weixin.qq.com/minigame/dev/api/base/performance/Performance.html) wx.getPerformance()](https://developers.weixin.qq.com/minigame/dev/api/base/performance/wx.getPerformance.html)
  11177. *
  11178. * 获取性能管理器 */
  11179. getPerformance(): Performance
  11180. /** [[RealtimeLogManager](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.html) wx.getRealtimeLogManager()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/wx.getRealtimeLogManager.html)
  11181. *
  11182. * 需要基础库: `2.14.4`
  11183. *
  11184. * 获取实时日志管理器对象。
  11185. *
  11186. * **示例代码**
  11187. *
  11188. * ```js
  11189. // 小程序端
  11190. const logger = wx.getRealtimeLogManager()
  11191. logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
  11192. logger.error({str: 'hello world'}, 'error log', 100, [1, 2, 3])
  11193. logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
  11194. // 插件端,基础库 2.16.0 版本后支持,只允许采用 key-value 的新格式上报
  11195. const logManager = wx.getRealtimeLogManager()
  11196. const logger = logManager.tag('plugin-log1')
  11197. logger.info('key1', 'value1')
  11198. logger.error('key2', {str: 'value2'})
  11199. logger.warn('key3', 'value3')
  11200. ``` */
  11201. getRealtimeLogManager(): RealtimeLogManager
  11202. /** [[RecorderManager](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.html) wx.getRecorderManager()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/wx.getRecorderManager.html)
  11203. *
  11204. * 需要基础库: `1.6.0`
  11205. *
  11206. * 获取**全局唯一**的录音管理器 RecorderManager */
  11207. getRecorderManager(): RecorderManager
  11208. /** [[RequestTask](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.html) wx.request(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/request/wx.request.html)
  11209. *
  11210. * 发起 HTTPS 网络请求。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。
  11211. *
  11212. * **data 参数说明**
  11213. *
  11214. * 最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String 。转换规则如下:
  11215. * - 对于 `GET` 方法的数据,会将数据转换成 query string(`encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...`)
  11216. * - 对于 `POST` 方法且 `header['content-type']` 为 `application/json` 的数据,会对数据进行 JSON 序列化
  11217. * - 对于 `POST` 方法且 `header['content-type']` 为 `application/x-www-form-urlencoded` 的数据,会将数据转换成 query string `(encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)`
  11218. *
  11219. * **示例代码**
  11220. *
  11221. * ```js
  11222. wx.request({
  11223. url: 'example.php', //仅为示例,并非真实的接口地址
  11224. data: {
  11225. x: '',
  11226. y: ''
  11227. },
  11228. header: {
  11229. 'content-type': 'application/json' // 默认值
  11230. },
  11231. success (res) {
  11232. console.log(res.data)
  11233. }
  11234. })
  11235. ``` */
  11236. request<
  11237. T extends string | IAnyObject | ArrayBuffer =
  11238. | string
  11239. | IAnyObject
  11240. | ArrayBuffer
  11241. >(
  11242. option: RequestOption<T>
  11243. ): RequestTask
  11244. /** [[RewardedVideoAd](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.html) wx.createRewardedVideoAd(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createRewardedVideoAd.html)
  11245. *
  11246. * 需要基础库: `2.0.4`
  11247. *
  11248. * 创建激励视频广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号后再使用该 API(小游戏端要求 >= 2.0.4, 小程序端要求 >= 2.6.0)。调用该方法创建的激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用)。 */
  11249. createRewardedVideoAd(
  11250. option: CreateRewardedVideoAdOption
  11251. ): RewardedVideoAd
  11252. /** [[SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) wx.connectSocket(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.connectSocket.html)
  11253. *
  11254. * 创建一个 WebSocket 连接。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。**
  11255. *
  11256. * **并发数**
  11257. *
  11258. * - 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接。
  11259. * - 1.7.0 以下版本,一个小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。
  11260. *
  11261. * **示例代码**
  11262. *
  11263. * ```js
  11264. wx.connectSocket({
  11265. url: 'wss://example.qq.com',
  11266. header:{
  11267. 'content-type': 'application/json'
  11268. },
  11269. protocols: ['protocol1']
  11270. })
  11271. ``` */
  11272. connectSocket(option: ConnectSocketOption): SocketTask
  11273. /** [[UDPSocket](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.html) wx.createUDPSocket()](https://developers.weixin.qq.com/minigame/dev/api/network/udp/wx.createUDPSocket.html)
  11274. *
  11275. * 需要基础库: `2.7.0`
  11276. *
  11277. * 创建一个 UDP Socket 实例。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。 */
  11278. createUDPSocket(): UDPSocket
  11279. /** [[UpdateManager](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html) wx.getUpdateManager()](https://developers.weixin.qq.com/minigame/dev/api/base/update/wx.getUpdateManager.html)
  11280. *
  11281. * 需要基础库: `1.9.90`
  11282. *
  11283. * 获取**全局唯一**的版本更新管理器,用于管理小程序更新。关于小程序的更新机制,可以查看[运行机制](https://developers.weixin.qq.com/minigame/dev/guide/runtime/operating-mechanism.html)文档。
  11284. *
  11285. * **示例代码**
  11286. *
  11287. * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
  11288. getUpdateManager(): UpdateManager
  11289. /** [[UploadTask](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.html) wx.uploadFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/wx.uploadFile.html)
  11290. *
  11291. * 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 `content-type` 为 `multipart/form-data`。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。
  11292. *
  11293. * **示例代码**
  11294. *
  11295. * ```js
  11296. wx.chooseImage({
  11297. success (res) {
  11298. const tempFilePaths = res.tempFilePaths
  11299. wx.uploadFile({
  11300. url: 'https://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
  11301. filePath: tempFilePaths[0],
  11302. name: 'file',
  11303. formData: {
  11304. 'user': 'test'
  11305. },
  11306. success (res){
  11307. const data = res.data
  11308. //do something
  11309. }
  11310. })
  11311. }
  11312. })
  11313. ``` */
  11314. uploadFile(option: UploadFileOption): UploadTask
  11315. /** [[UserCryptoManager](https://developers.weixin.qq.com/minigame/dev/api/base/crypto/UserCryptoManager.html) wx.getUserCryptoManager()](https://developers.weixin.qq.com/minigame/dev/api/base/crypto/wx.getUserCryptoManager.html)
  11316. *
  11317. * 需要基础库: `2.17.3`
  11318. *
  11319. * 获取用户加密模块 */
  11320. getUserCryptoManager(): UserCryptoManager
  11321. /** [[UserInfoButton](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.html) wx.createUserInfoButton(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.createUserInfoButton.html)
  11322. *
  11323. * 需要基础库: `2.0.1`
  11324. *
  11325. * 创建用户信息按钮 */
  11326. createUserInfoButton(option: CreateUserInfoButtonOption): UserInfoButton
  11327. /** [[VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html) wx.createVideoDecoder()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/wx.createVideoDecoder.html)
  11328. *
  11329. * 需要基础库: `2.11.1`
  11330. *
  11331. * 创建视频解码器,可逐帧获取解码后的数据 */
  11332. createVideoDecoder(): VideoDecoder
  11333. /** [[Video](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.html) wx.createVideo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/video/wx.createVideo.html)
  11334. *
  11335. * 创建视频 */
  11336. createVideo(option: CreateVideoOption): Video
  11337. /** [[WebAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.html) wx.createWebAudioContext()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createWebAudioContext.html)
  11338. *
  11339. * 需要基础库: `2.19.0`
  11340. *
  11341. * 创建 WebAudio 上下文。 */
  11342. createWebAudioContext(): WebAudioContext
  11343. /** [[Worker](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.html) wx.createWorker(string scriptPath, object options)](https://developers.weixin.qq.com/minigame/dev/api/worker/wx.createWorker.html)
  11344. *
  11345. * 需要基础库: `1.9.90`
  11346. *
  11347. * 创建一个 Worker 线程
  11348. *
  11349. * **示例代码**
  11350. *
  11351. * ```js
  11352. // 创建普通worker
  11353. wx.createWorker('workers/index.js')
  11354. ```
  11355. * ```js
  11356. function createNewWorker() {
  11357. const worker = wx.createWorker('workers/index.js', {
  11358. useExperimentalWorker: true
  11359. })
  11360. // 监听worker被系统回收事件
  11361. worker.onProcessKilled(() => {
  11362. // 重新创建一个worker
  11363. createNewWorker()
  11364. })
  11365. }
  11366. // 创建实验worker
  11367. createNewWorker()
  11368. ``` */
  11369. createWorker(
  11370. /** worker 入口文件的**绝对路径** */
  11371. scriptPath: string,
  11372. /** 可选参数 */
  11373. options?: CreateWorkerOption
  11374. ): Worker
  11375. /** [any wx.getStorageSync(string key, Boolean encrypt)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageSync.html)
  11376. *
  11377. * [wx.getStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorage.html) 的同步版本
  11378. *
  11379. * **示例代码**
  11380. *
  11381. * ```js
  11382. wx.getStorage({
  11383. key: 'key',
  11384. success (res) {
  11385. console.log(res.data)
  11386. }
  11387. })
  11388. ```
  11389. *
  11390. * ```js
  11391. try {
  11392. var value = wx.getStorageSync('key')
  11393. if (value) {
  11394. // Do something with return value
  11395. }
  11396. } catch (e) {
  11397. // Do something when catch error
  11398. }
  11399. ```
  11400. *
  11401. * ```js
  11402. // 开启加密存储
  11403. wx.setStorage({
  11404. key: "key",
  11405. data: "value",
  11406. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  11407. success() {
  11408. wx.getStorage({
  11409. key: "key",
  11410. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  11411. success(res) {
  11412. console.log(res.data)
  11413. }
  11414. })
  11415. }
  11416. })
  11417. ``` */
  11418. getStorageSync<T = any>(
  11419. /** 本地缓存中指定的 key */
  11420. key: string,
  11421. /** 需要基础库: `2.21.3`
  11422. *
  11423. * 是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true */
  11424. encrypt?: boolean
  11425. ): T
  11426. /** [boolean wx.setCursor(string path, number x, number y)](https://developers.weixin.qq.com/minigame/dev/api/render/cursor/wx.setCursor.html)
  11427. *
  11428. * 需要基础库: `2.10.1`
  11429. *
  11430. * 加载自定义光标,仅支持 PC 平台
  11431. *
  11432. * **注意**
  11433. *
  11434. * - 传入图片太大可能会导致设置无效,推荐图标大小 32x32
  11435. * - 基础库 v2.16.0 后,支持更多图片格式以及关键字种类(参考 CSS 标准) */
  11436. setCursor(
  11437. /** 代码包或本地路径,支持 ico 和 cur 格式,传入 'default' 代表恢复系统默认 */
  11438. path: string,
  11439. /** 需要基础库: `2.19.0`
  11440. *
  11441. * 横向偏移量 */
  11442. x?: number,
  11443. /** 需要基础库: `2.19.0`
  11444. *
  11445. * 纵向偏移量 */
  11446. y?: number
  11447. ): boolean
  11448. /** [boolean wx.setMessageToFriendQuery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.setMessageToFriendQuery.html)
  11449. *
  11450. * 设置 wx.shareMessageToFriend 接口 query 字段的值 */
  11451. setMessageToFriendQuery(option: SetMessageToFriendQueryOption): boolean
  11452. /** [number wx.getTextLineHeight(Object object)](https://developers.weixin.qq.com/minigame/dev/api/render/font/wx.getTextLineHeight.html)
  11453. *
  11454. * 获取一行文本的行高 */
  11455. getTextLineHeight(option: GetTextLineHeightOption): number
  11456. /** [string wx.decode(Object object)](https://developers.weixin.qq.com/minigame/dev/api/util/wx.decode.html)
  11457. *
  11458. * 将 ArrayBuffer 按照指定的编码格式解码成字符串 */
  11459. decode(option: DecodeOption): string
  11460. /** [string wx.loadFont(string path)](https://developers.weixin.qq.com/minigame/dev/api/render/font/wx.loadFont.html)
  11461. *
  11462. * 加载自定义字体文件 */
  11463. loadFont(
  11464. /** 字体文件路径。支持本地路径、代码包路径。 */
  11465. path: string
  11466. ): string
  11467. /** [wx.addCard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/card/wx.addCard.html)
  11468. *
  11469. * 需要基础库: `2.5.0`
  11470. *
  11471. * 批量添加卡券。只有通过 [认证](https://developers.weixin.qq.com/miniprogram/product/renzheng.html) 的小程序或文化互动类目的小游戏才能使用。更多文档请参考 [微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2)。
  11472. *
  11473. * **cardExt 说明**
  11474. *
  11475. * cardExt 是卡券的扩展参数,其值是一个 JSON 字符串。
  11476. *
  11477. * **示例代码**
  11478. *
  11479. * ```js
  11480. wx.addCard({
  11481. cardList: [
  11482. {
  11483. cardId: '',
  11484. cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
  11485. }, {
  11486. cardId: '',
  11487. cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
  11488. }
  11489. ],
  11490. success (res) {
  11491. console.log(res.cardList) // 卡券添加结果
  11492. }
  11493. })
  11494. ``` */
  11495. addCard<T extends AddCardOption = AddCardOption>(
  11496. option: T
  11497. ): PromisifySuccessResult<T, AddCardOption>
  11498. /** [wx.authPrivateMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.authPrivateMessage.html)
  11499. *
  11500. * 需要基础库: `2.13.0`
  11501. *
  11502. * 验证私密消息。用法详情见 [小程序私密消息使用指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/private-message.html)
  11503. *
  11504. * **示例代码**
  11505. *
  11506. * ```js
  11507. wx.authPrivateMessage({
  11508. shareTicket: 'xxxxxx',
  11509. success(res) {
  11510. console.log('authPrivateMessage success', res)
  11511. // res
  11512. // {
  11513. // errMsg: 'authPrivateMessage:ok'
  11514. // valid: true
  11515. // iv: 'xxxx',
  11516. // encryptedData: 'xxxxxx'
  11517. // }
  11518. },
  11519. fail(res) {
  11520. console.log('authPrivateMessage fail', res)
  11521. }
  11522. })
  11523. ``` */
  11524. authPrivateMessage(option?: AuthPrivateMessageOption): void
  11525. /** [wx.authorize(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/authorize/wx.authorize.html)
  11526. *
  11527. * 需要基础库: `1.2.0`
  11528. *
  11529. * 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据,但不会实际调用对应接口。如果用户之前已经同意授权,则不会出现弹窗,直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html)。
  11530. * > 小程序插件可以使用 [wx.authorizeForMiniProgram](#)
  11531. *
  11532. * **示例代码**
  11533. *
  11534. * ```js
  11535. // 可以通过 wx.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope
  11536. wx.getSetting({
  11537. success(res) {
  11538. if (!res.authSetting['scope.record']) {
  11539. wx.authorize({
  11540. scope: 'scope.record',
  11541. success () {
  11542. // 用户已经同意小程序使用录音功能,后续调用 wx.startRecord 接口不会弹窗询问
  11543. wx.startRecord()
  11544. }
  11545. })
  11546. }
  11547. }
  11548. })
  11549. ``` */
  11550. authorize<T extends AuthorizeOption = AuthorizeOption>(
  11551. option: T
  11552. ): PromisifySuccessResult<T, AuthorizeOption>
  11553. /** [wx.checkHandoffEnabled(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.checkHandoffEnabled.html)
  11554. *
  11555. * 需要基础库: `2.14.4`
  11556. *
  11557. * 检查是否可以进行接力,该接口需要在开放数据域调用 */
  11558. checkHandoffEnabled(option?: CheckHandoffEnabledOption): void
  11559. /** [wx.checkIsUserAdvisedToRest(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/anti-addiction/wx.checkIsUserAdvisedToRest.html)
  11560. *
  11561. * 需要基础库: `1.9.97`
  11562. *
  11563. * 根据用户当天游戏时间判断用户是否需要休息 */
  11564. checkIsUserAdvisedToRest<
  11565. T extends CheckIsUserAdvisedToRestOption = CheckIsUserAdvisedToRestOption
  11566. >(
  11567. option: T
  11568. ): PromisifySuccessResult<T, CheckIsUserAdvisedToRestOption>
  11569. /** [wx.checkSession(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.checkSession.html)
  11570. *
  11571. * 检查登录态是否过期。
  11572. * 通过 wx.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序,用户登录态越有可能失效。反之如果用户一直在使用小程序,则用户登录态一直保持有效。具体时效逻辑由微信维护,对开发者透明。开发者只需要调用 wx.checkSession 接口检测当前用户登录态是否有效。
  11573. *
  11574. * 登录态过期后开发者可以再调用 wx.login 获取新的用户登录态。调用成功说明当前 session_key 未过期,调用失败说明 session_key 已过期。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/login.html)。
  11575. *
  11576. * **示例代码**
  11577. *
  11578. * ```js
  11579. wx.checkSession({
  11580. success () {
  11581. //session_key 未过期,并且在本生命周期一直有效
  11582. },
  11583. fail () {
  11584. // session_key 已经失效,需要重新执行登录流程
  11585. wx.login() //重新登录
  11586. }
  11587. })
  11588. ``` */
  11589. checkSession<T extends CheckSessionOption = CheckSessionOption>(
  11590. option?: T
  11591. ): PromisifySuccessResult<T, CheckSessionOption>
  11592. /** [wx.chooseImage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.chooseImage.html)
  11593. *
  11594. * 从本地相册选择图片或使用相机拍照。此接口不再更新,建议使用 `wx.chooseMedia`。
  11595. *
  11596. * ****
  11597. *
  11598. * ```js
  11599. wx.chooseImage({
  11600. count: 1,
  11601. sizeType: ['original', 'compressed'],
  11602. sourceType: ['album', 'camera'],
  11603. success (res) {
  11604. // tempFilePath可以作为img标签的src属性显示图片
  11605. const tempFilePaths = res.tempFilePaths
  11606. }
  11607. })
  11608. ``` */
  11609. chooseImage<T extends ChooseImageOption = ChooseImageOption>(
  11610. option?: T
  11611. ): PromisifySuccessResult<T, ChooseImageOption>
  11612. /** [wx.clearStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.clearStorage.html)
  11613. *
  11614. * 清理本地数据缓存。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
  11615. *
  11616. * **示例代码**
  11617. *
  11618. * ```js
  11619. wx.clearStorage()
  11620. ```
  11621. *
  11622. * ```js
  11623. try {
  11624. wx.clearStorageSync()
  11625. } catch(e) {
  11626. // Do something when catch error
  11627. }
  11628. ``` */
  11629. clearStorage<T extends ClearStorageOption = ClearStorageOption>(
  11630. option?: T
  11631. ): PromisifySuccessResult<T, ClearStorageOption>
  11632. /** [wx.clearStorageSync()](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.clearStorageSync.html)
  11633. *
  11634. * [wx.clearStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.clearStorage.html) 的同步版本
  11635. *
  11636. * **示例代码**
  11637. *
  11638. * ```js
  11639. wx.clearStorage()
  11640. ```
  11641. *
  11642. * ```js
  11643. try {
  11644. wx.clearStorageSync()
  11645. } catch(e) {
  11646. // Do something when catch error
  11647. }
  11648. ``` */
  11649. clearStorageSync(): void
  11650. /** [wx.closeBLEConnection(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.closeBLEConnection.html)
  11651. *
  11652. * 需要基础库: `2.9.2`
  11653. *
  11654. * 断开与蓝牙低功耗设备的连接。
  11655. *
  11656. * **示例代码**
  11657. *
  11658. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11659. * ```js
  11660. wx.closeBLEConnection({
  11661. deviceId,
  11662. success (res) {
  11663. console.log(res)
  11664. }
  11665. })
  11666. ``` */
  11667. closeBLEConnection<
  11668. T extends CloseBLEConnectionOption = CloseBLEConnectionOption
  11669. >(
  11670. option: T
  11671. ): PromisifySuccessResult<T, CloseBLEConnectionOption>
  11672. /** [wx.closeBluetoothAdapter(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.closeBluetoothAdapter.html)
  11673. *
  11674. * 需要基础库: `2.9.2`
  11675. *
  11676. * 关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后,与 [wx.openBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html) 成对调用。
  11677. *
  11678. * **示例代码**
  11679. *
  11680. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11681. * ```js
  11682. wx.closeBluetoothAdapter({
  11683. success (res) {
  11684. console.log(res)
  11685. }
  11686. })
  11687. ``` */
  11688. closeBluetoothAdapter<
  11689. T extends CloseBluetoothAdapterOption = CloseBluetoothAdapterOption
  11690. >(
  11691. option?: T
  11692. ): PromisifySuccessResult<T, CloseBluetoothAdapterOption>
  11693. /** [wx.closeSocket(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.closeSocket.html)
  11694. *
  11695. * 关闭 WebSocket 连接。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。**
  11696. *
  11697. * **示例代码**
  11698. *
  11699. * ```js
  11700. wx.connectSocket({
  11701. url: 'test.php'
  11702. })
  11703. //注意这里有时序问题,
  11704. //如果 wx.connectSocket 还没回调 wx.onSocketOpen,而先调用 wx.closeSocket,那么就做不到关闭 WebSocket 的目的。
  11705. //必须在 WebSocket 打开期间调用 wx.closeSocket 才能关闭。
  11706. wx.onSocketOpen(function() {
  11707. wx.closeSocket()
  11708. })
  11709. wx.onSocketClose(function(res) {
  11710. console.log('WebSocket 已关闭!')
  11711. })
  11712. ``` */
  11713. closeSocket<T extends CloseSocketOption = CloseSocketOption>(
  11714. option?: T
  11715. ): PromisifySuccessResult<T, CloseSocketOption>
  11716. /** [wx.createBLEConnection(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html)
  11717. *
  11718. * 需要基础库: `2.9.2`
  11719. *
  11720. * 连接蓝牙低功耗设备。
  11721. *
  11722. * 若小程序在之前已有搜索过某个蓝牙设备,并成功建立连接,可直接传入之前搜索获取的 deviceId 直接尝试连接该设备,无需再次进行搜索操作。
  11723. *
  11724. * **注意**
  11725. *
  11726. * - 请保证尽量成对的调用 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 和 [wx.closeBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.closeBLEConnection.html) 接口。安卓如果重复调用 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 创建连接,有可能导致系统持有同一设备多个连接的实例,导致调用 `closeBLEConnection` 的时候并不能真正的断开与设备的连接。
  11727. * - 蓝牙连接随时可能断开,建议监听 [wx.onBLEConnectionStateChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEConnectionStateChange.html) 回调事件,当蓝牙设备断开时按需执行重连操作
  11728. * - 若对未连接的设备或已断开连接的设备调用数据读写操作的接口,会返回 10006 错误,建议进行重连操作。
  11729. *
  11730. * **示例代码**
  11731. *
  11732. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11733. * ```js
  11734. wx.createBLEConnection({
  11735. deviceId,
  11736. success (res) {
  11737. console.log(res)
  11738. }
  11739. })
  11740. ``` */
  11741. createBLEConnection<
  11742. T extends CreateBLEConnectionOption = CreateBLEConnectionOption
  11743. >(
  11744. option: T
  11745. ): PromisifySuccessResult<T, CreateBLEConnectionOption>
  11746. /** [wx.createBLEPeripheralServer(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/wx.createBLEPeripheralServer.html)
  11747. *
  11748. * 需要基础库: `2.10.3`
  11749. *
  11750. * 建立本地作为蓝牙低功耗外围设备的服务端,可创建多个。 */
  11751. createBLEPeripheralServer<
  11752. T extends CreateBLEPeripheralServerOption = CreateBLEPeripheralServerOption
  11753. >(
  11754. option?: T
  11755. ): PromisifySuccessResult<T, CreateBLEPeripheralServerOption>
  11756. /** [wx.createBufferURL(ArrayBuffer|TypedArray buffer)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.createBufferURL.html)
  11757. *
  11758. * 需要基础库: `2.14.0`
  11759. *
  11760. * 根据传入的 buffer 创建一个唯一的 URL 存在内存中 */
  11761. createBufferURL(
  11762. /** 需要存入内存的二进制数据 */
  11763. buffer:
  11764. | ArrayBuffer
  11765. | Int8Array
  11766. | Uint8Array
  11767. | Uint8ClampedArray
  11768. | Int16Array
  11769. | Uint16Array
  11770. | Int32Array
  11771. | Uint32Array
  11772. | Float32Array
  11773. | Float64Array
  11774. ): void
  11775. /** [wx.createCustomAd(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createCustomAd.html)
  11776. *
  11777. * 需要基础库: `2.11.1`
  11778. *
  11779. * 创建原生模板广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.11.1 后再使用该 API。每次调用该方法创建原生模板广告都会返回一个全新的实例。 */
  11780. createCustomAd(option: CreateCustomAdOption): void
  11781. /** [wx.exitMiniProgram(Object object)](https://developers.weixin.qq.com/minigame/dev/api/navigate/wx.exitMiniProgram.html)
  11782. *
  11783. * 需要基础库: `2.17.3`
  11784. *
  11785. * 退出当前小程序。必须有点击行为才能调用成功。 */
  11786. exitMiniProgram<
  11787. T extends ExitMiniProgramOption = ExitMiniProgramOption
  11788. >(
  11789. option?: T
  11790. ): PromisifySuccessResult<T, ExitMiniProgramOption>
  11791. /** [wx.exitVoIPChat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.exitVoIPChat.html)
  11792. *
  11793. * 需要基础库: `2.7.0`
  11794. *
  11795. * 退出(销毁)实时语音通话 */
  11796. exitVoIPChat<T extends ExitVoIPChatOption = ExitVoIPChatOption>(
  11797. option?: T
  11798. ): PromisifySuccessResult<T, ExitVoIPChatOption>
  11799. /** [wx.faceDetect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ai/face/wx.faceDetect.html)
  11800. *
  11801. * 需要基础库: `2.18.0`
  11802. *
  11803. * 人脸识别,使用前需要通过 wx.initFaceDetect 进行一次初始化,推荐使用相机接口返回的帧数据 */
  11804. faceDetect(option: FaceDetectOption): void
  11805. /** [wx.getAvailableAudioSources(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.getAvailableAudioSources.html)
  11806. *
  11807. * 需要基础库: `2.1.0`
  11808. *
  11809. * 获取当前支持的音频输入源 */
  11810. getAvailableAudioSources<
  11811. T extends GetAvailableAudioSourcesOption = GetAvailableAudioSourcesOption
  11812. >(
  11813. option?: T
  11814. ): PromisifySuccessResult<T, GetAvailableAudioSourcesOption>
  11815. /** [wx.getBLEDeviceCharacteristics(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceCharacteristics.html)
  11816. *
  11817. * 需要基础库: `2.9.2`
  11818. *
  11819. * 获取蓝牙低功耗设备某个服务中所有特征 (characteristic)。
  11820. *
  11821. * **示例代码**
  11822. *
  11823. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11824. * ```js
  11825. wx.getBLEDeviceCharacteristics({
  11826. // 这里的 deviceId 需要已经通过 wx.createBLEConnection 与对应设备建立链接
  11827. deviceId,
  11828. // 这里的 serviceId 需要在 wx.getBLEDeviceServices 接口中获取
  11829. serviceId,
  11830. success (res) {
  11831. console.log('device getBLEDeviceCharacteristics:', res.characteristics)
  11832. }
  11833. })
  11834. ``` */
  11835. getBLEDeviceCharacteristics<
  11836. T extends GetBLEDeviceCharacteristicsOption = GetBLEDeviceCharacteristicsOption
  11837. >(
  11838. option: T
  11839. ): PromisifySuccessResult<T, GetBLEDeviceCharacteristicsOption>
  11840. /** [wx.getBLEDeviceRSSI(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceRSSI.html)
  11841. *
  11842. * 需要基础库: `2.11.0`
  11843. *
  11844. * 获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI)。 */
  11845. getBLEDeviceRSSI<
  11846. T extends GetBLEDeviceRSSIOption = GetBLEDeviceRSSIOption
  11847. >(
  11848. option: T
  11849. ): PromisifySuccessResult<T, GetBLEDeviceRSSIOption>
  11850. /** [wx.getBLEDeviceServices(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceServices.html)
  11851. *
  11852. * 需要基础库: `2.9.2`
  11853. *
  11854. * 获取蓝牙低功耗设备所有服务 (service)。
  11855. *
  11856. * **示例代码**
  11857. *
  11858. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11859. * ```js
  11860. wx.getBLEDeviceServices({
  11861. // 这里的 deviceId 需要已经通过 wx.createBLEConnection 与对应设备建立连接
  11862. deviceId,
  11863. success (res) {
  11864. console.log('device services:', res.services)
  11865. }
  11866. })
  11867. ``` */
  11868. getBLEDeviceServices<
  11869. T extends GetBLEDeviceServicesOption = GetBLEDeviceServicesOption
  11870. >(
  11871. option: T
  11872. ): PromisifySuccessResult<T, GetBLEDeviceServicesOption>
  11873. /** [wx.getBLEMTU(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEMTU.html)
  11874. *
  11875. * 需要基础库: `2.20.1`
  11876. *
  11877. * 获取蓝牙低功耗的最大传输单元。需在 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 调用成功后调用。
  11878. *
  11879. * **注意**
  11880. *
  11881. * - 小程序中 MTU 为 ATT_MTU,包含 Op-Code 和 Attribute Handle 的长度,实际可以传输的数据长度为 `ATT_MTU - 3`
  11882. * - iOS 系统中 MTU 为固定值;安卓系统中,MTU 会在系统协商成功之后发生改变,建议使用 [wx.onBLEMTUChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEMTUChange.html) 监听。
  11883. *
  11884. * **示例代码**
  11885. *
  11886. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11887. * ```js
  11888. wx.getBLEMTU({
  11889. deviceId: '',
  11890. writeType: 'write',
  11891. success (res) {
  11892. console.log(res)
  11893. }
  11894. })
  11895. ``` */
  11896. getBLEMTU<T extends GetBLEMTUOption = GetBLEMTUOption>(
  11897. option: T
  11898. ): PromisifySuccessResult<T, GetBLEMTUOption>
  11899. /** [wx.getBatteryInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfo.html)
  11900. *
  11901. * 获取设备电量。同步 API [wx.getBatteryInfoSync](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfoSync.html) 在 iOS 上不可用。 */
  11902. getBatteryInfo<T extends GetBatteryInfoOption = GetBatteryInfoOption>(
  11903. option?: T
  11904. ): PromisifySuccessResult<T, GetBatteryInfoOption>
  11905. /** [wx.getBeacons(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.getBeacons.html)
  11906. *
  11907. * 需要基础库: `2.9.2`
  11908. *
  11909. * 获取所有已搜索到的 Beacon 设备 */
  11910. getBeacons<T extends GetBeaconsOption = GetBeaconsOption>(
  11911. option?: T
  11912. ): PromisifySuccessResult<T, GetBeaconsOption>
  11913. /** [wx.getBluetoothAdapterState(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getBluetoothAdapterState.html)
  11914. *
  11915. * 需要基础库: `2.9.2`
  11916. *
  11917. * 获取本机蓝牙适配器状态。
  11918. *
  11919. * **示例代码**
  11920. *
  11921. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11922. * ```js
  11923. wx.getBluetoothAdapterState({
  11924. success (res) {
  11925. console.log(res)
  11926. }
  11927. })
  11928. ``` */
  11929. getBluetoothAdapterState<
  11930. T extends GetBluetoothAdapterStateOption = GetBluetoothAdapterStateOption
  11931. >(
  11932. option?: T
  11933. ): PromisifySuccessResult<T, GetBluetoothAdapterStateOption>
  11934. /** [wx.getBluetoothDevices(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getBluetoothDevices.html)
  11935. *
  11936. * 需要基础库: `2.9.2`
  11937. *
  11938. * 获取在蓝牙模块生效期间所有搜索到的蓝牙设备。包括已经和本机处于连接状态的设备。
  11939. *
  11940. * **示例代码**
  11941. *
  11942. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  11943. *
  11944. * ```js
  11945. // ArrayBuffer转16进度字符串示例
  11946. function ab2hex(buffer) {
  11947. var hexArr = Array.prototype.map.call(
  11948. new Uint8Array(buffer),
  11949. function(bit) {
  11950. return ('00' + bit.toString(16)).slice(-2)
  11951. }
  11952. )
  11953. return hexArr.join('');
  11954. }
  11955. wx.getBluetoothDevices({
  11956. success: function (res) {
  11957. console.log(res)
  11958. if (res.devices[0]) {
  11959. console.log(ab2hex(res.devices[0].advertisData))
  11960. }
  11961. }
  11962. })
  11963. ```
  11964. *
  11965. * **注意**
  11966. *
  11967. * - 该接口获取到的设备列表为**蓝牙模块生效期间所有搜索到的蓝牙设备**,若在蓝牙模块使用流程结束后未及时调用 [wx.closeBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.closeBluetoothAdapter.html) 释放资源,会存在调用该接口会返回之前的蓝牙使用流程中搜索到的蓝牙设备,可能设备已经不在用户身边,无法连接。 */
  11968. getBluetoothDevices<
  11969. T extends GetBluetoothDevicesOption = GetBluetoothDevicesOption
  11970. >(
  11971. option?: T
  11972. ): PromisifySuccessResult<T, GetBluetoothDevicesOption>
  11973. /** [wx.getChannelsLiveInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.getChannelsLiveInfo.html)
  11974. *
  11975. * 需要基础库: `2.15.0`
  11976. *
  11977. * 获取视频号直播信息 */
  11978. getChannelsLiveInfo(option: GetChannelsLiveInfoOption): void
  11979. /** [wx.getChannelsLiveNoticeInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.html)
  11980. *
  11981. * 需要基础库: `2.19.0`
  11982. *
  11983. * 获取视频号直播预告信息 */
  11984. getChannelsLiveNoticeInfo(option: GetChannelsLiveNoticeInfoOption): void
  11985. /** [wx.getClipboardData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/clipboard/wx.getClipboardData.html)
  11986. *
  11987. * 需要基础库: `1.1.0`
  11988. *
  11989. * 获取系统剪贴板的内容
  11990. *
  11991. * **示例代码**
  11992. *
  11993. * ```js
  11994. wx.getClipboardData({
  11995. success (res){
  11996. console.log(res.data)
  11997. }
  11998. })
  11999. ``` */
  12000. getClipboardData<
  12001. T extends GetClipboardDataOption = GetClipboardDataOption
  12002. >(
  12003. option?: T
  12004. ): PromisifySuccessResult<T, GetClipboardDataOption>
  12005. /** [wx.getConnectedBluetoothDevices(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getConnectedBluetoothDevices.html)
  12006. *
  12007. * 需要基础库: `2.9.2`
  12008. *
  12009. * 根据主服务 UUID 获取已连接的蓝牙设备。
  12010. *
  12011. * **示例代码**
  12012. *
  12013. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  12014. * ```js
  12015. wx.getConnectedBluetoothDevices({
  12016. services: ['FEE7'],
  12017. success (res) {
  12018. console.log(res)
  12019. }
  12020. })
  12021. ``` */
  12022. getConnectedBluetoothDevices<
  12023. T extends GetConnectedBluetoothDevicesOption = GetConnectedBluetoothDevicesOption
  12024. >(
  12025. option: T
  12026. ): PromisifySuccessResult<T, GetConnectedBluetoothDevicesOption>
  12027. /** [wx.getExtConfig(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfig.html)
  12028. *
  12029. * 需要基础库: `2.8.3`
  12030. *
  12031. * 获取[第三方平台](https://developers.weixin.qq.com/minigame/dev/devtools/ext.html)自定义的数据字段。
  12032. *
  12033. * **Tips**
  12034. *
  12035. * 1. 本接口暂时无法通过 [wx.canIUse](#) 判断是否兼容,开发者需要自行判断 [wx.getExtConfig](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfig.html) 是否存在来兼容
  12036. *
  12037. * ****
  12038. *
  12039. * ```js
  12040. if (wx.getExtConfig) {
  12041. wx.getExtConfig({
  12042. success (res) {
  12043. console.log(res.extConfig)
  12044. }
  12045. })
  12046. }
  12047. ``` */
  12048. getExtConfig<T extends GetExtConfigOption = GetExtConfigOption>(
  12049. option?: T
  12050. ): PromisifySuccessResult<T, GetExtConfigOption>
  12051. /** [wx.getFileInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/wx.getFileInfo.html)
  12052. *
  12053. * 需要基础库: `1.4.0`
  12054. *
  12055. * 获取文件信息
  12056. *
  12057. * **示例代码**
  12058. *
  12059. * ```js
  12060. wx.getFileInfo({
  12061. success (res) {
  12062. console.log(res.size)
  12063. console.log(res.digest)
  12064. }
  12065. })
  12066. ``` */
  12067. getFileInfo<T extends WxGetFileInfoOption = WxGetFileInfoOption>(
  12068. option: T
  12069. ): PromisifySuccessResult<T, WxGetFileInfoOption>
  12070. /** [wx.getFriendCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getFriendCloudStorage.html)
  12071. *
  12072. * 需要基础库: `1.9.92`
  12073. *
  12074. * 拉取当前用户所有同玩好友的托管数据。该接口需要用户授权,且只在开放数据域下可用。 */
  12075. getFriendCloudStorage<
  12076. T extends GetFriendCloudStorageOption = GetFriendCloudStorageOption
  12077. >(
  12078. option: T
  12079. ): PromisifySuccessResult<T, GetFriendCloudStorageOption>
  12080. /** [wx.getGroupCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupCloudStorage.html)
  12081. *
  12082. * 需要基础库: `1.9.92`
  12083. *
  12084. * 获取群同玩成员的游戏数据。小游戏通过群分享卡片打开的情况下才可以调用。该接口需要用户授权,且只在开放数据域下可用。 */
  12085. getGroupCloudStorage<
  12086. T extends GetGroupCloudStorageOption = GetGroupCloudStorageOption
  12087. >(
  12088. option: T
  12089. ): PromisifySuccessResult<T, GetGroupCloudStorageOption>
  12090. /** [wx.getGroupEnterInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/group/wx.getGroupEnterInfo.html)
  12091. *
  12092. * 需要基础库: `2.10.4`
  12093. *
  12094. * 获取微信群聊场景下的小程序启动信息。群聊场景包括群聊小程序消息卡片、群待办、群工具。可用于获取当前群的 opengid。
  12095. * ## 注意事项
  12096. * - 基础库 v2.10.4 开始支持获取群工具小程序启动信息
  12097. * - 基础库 v2.17.3 开始支持获取群聊小程序消息卡片、群待办小程序启动信息
  12098. *
  12099. * **示例代码**
  12100. *
  12101. * ```js
  12102. wx.getGroupEnterInfo({
  12103. success(res) {
  12104. // res
  12105. {
  12106. errMsg: 'getGroupEnterInfo:ok',
  12107. encryptedData: '',
  12108. iv: ''
  12109. }
  12110. },
  12111. fail() {
  12112. }
  12113. })
  12114. ```
  12115. *
  12116. * 敏感数据有两种获取方式,一是使用 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) 。
  12117. * 获取得到的开放数据为以下 json 结构(其中 opengid 为当前群的唯一标识):
  12118. *
  12119. * ```json
  12120. {
  12121. "opengid": "OPENGID"
  12122. }
  12123. ```
  12124. *
  12125. * **Tips**
  12126. *
  12127. * - 如需要展示群名称,小程序可以使用[开放数据组件](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/open-data.html)
  12128. * - 小游戏可以通过 `wx.getGroupInfo` 接口获取群名称 */
  12129. getGroupEnterInfo(option: GetGroupEnterInfoOption): void
  12130. /** [wx.getGroupInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupInfo.html)
  12131. *
  12132. * 需要基础库: `2.10.1`
  12133. *
  12134. * 获取群信息。小游戏通过群分享卡片打开的情况下才可以调用。该接口需要用户授权,且只在开放数据域下可用。 */
  12135. getGroupInfo<T extends GetGroupInfoOption = GetGroupInfoOption>(
  12136. option: T
  12137. ): PromisifySuccessResult<T, GetGroupInfoOption>
  12138. /** [wx.getLocalIPAddress(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.getLocalIPAddress.html)
  12139. *
  12140. * 需要基础库: `2.20.1`
  12141. *
  12142. * 获取局域网IP地址
  12143. *
  12144. * **示例代码**
  12145. *
  12146. * ```js
  12147. wx.getLocalIPAddress({
  12148. success (res) {
  12149. const localip = res.localip
  12150. }
  12151. })
  12152. ``` */
  12153. getLocalIPAddress(option: GetLocalIPAddressOption): void
  12154. /** [wx.getLocation(Object object)](https://developers.weixin.qq.com/minigame/dev/api/location/wx.getLocation.html)
  12155. *
  12156. * 获取当前的地理位置、速度。当用户离开小程序后,此接口无法调用。开启高精度定位,接口耗时会增加,可指定 highAccuracyExpireTime 作为超时时间。地图相关使用的坐标格式应为 gcj02。高频率调用会导致耗电,如有需要可使用持续定位接口 `wx.onLocationChange`。基础库 `2.17.0` 版本起 `wx.getLocation` 增加调用频率限制,[相关公告](https://developers.weixin.qq.com/community/develop/doc/000aee91a98d206bc6dbe722b51801)。
  12157. *
  12158. * **示例代码**
  12159. *
  12160. * ```js
  12161. wx.getLocation({
  12162. type: 'wgs84',
  12163. success (res) {
  12164. const latitude = res.latitude
  12165. const longitude = res.longitude
  12166. const speed = res.speed
  12167. const accuracy = res.accuracy
  12168. }
  12169. })
  12170. ```
  12171. *
  12172. * **注意**
  12173. *
  12174. * - `2.17.0 起 `wx.getLocation` 增加调用频率限制,[相关公告](https://developers.weixin.qq.com/community/develop/doc/000aee91a98d206bc6dbe722b51801)
  12175. * - 工具中定位模拟使用IP定位,可能会有一定误差。且工具目前仅支持 gcj02 坐标。
  12176. * - 使用第三方服务进行逆地址解析时,请确认第三方服务默认的坐标系,正确进行坐标转换。 */
  12177. getLocation<T extends GetLocationOption = GetLocationOption>(
  12178. option: T
  12179. ): PromisifySuccessResult<T, GetLocationOption>
  12180. /** [wx.getNetworkType(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.getNetworkType.html)
  12181. *
  12182. * 获取网络类型
  12183. *
  12184. * **示例代码**
  12185. *
  12186. * ```js
  12187. wx.getNetworkType({
  12188. success (res) {
  12189. const networkType = res.networkType
  12190. }
  12191. })
  12192. ``` */
  12193. getNetworkType<T extends GetNetworkTypeOption = GetNetworkTypeOption>(
  12194. option?: T
  12195. ): PromisifySuccessResult<T, GetNetworkTypeOption>
  12196. /** [wx.getPotentialFriendList(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getPotentialFriendList.html)
  12197. *
  12198. * 需要基础库: `2.9.0`
  12199. *
  12200. * 获取可能对游戏感兴趣的未注册的好友名单。每次调用最多可获得 5 个好友。该接口需要用户授权,且只在开放数据域下可用。 */
  12201. getPotentialFriendList<
  12202. T extends GetPotentialFriendListOption = GetPotentialFriendListOption
  12203. >(
  12204. option?: T
  12205. ): PromisifySuccessResult<T, GetPotentialFriendListOption>
  12206. /** [wx.getScreenBrightness(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.getScreenBrightness.html)
  12207. *
  12208. * 需要基础库: `1.2.0`
  12209. *
  12210. * 获取屏幕亮度
  12211. *
  12212. * **说明**
  12213. *
  12214. * - 若安卓系统设置中开启了自动调节亮度功能,则屏幕亮度会根据光线自动调整,该接口仅能获取自动调节亮度之前的值,而非实时的亮度值。 */
  12215. getScreenBrightness<
  12216. T extends GetScreenBrightnessOption = GetScreenBrightnessOption
  12217. >(
  12218. option?: T
  12219. ): PromisifySuccessResult<T, GetScreenBrightnessOption>
  12220. /** [wx.getSetting(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html)
  12221. *
  12222. * 需要基础库: `1.2.0`
  12223. *
  12224. * 获取用户的当前设置。**返回值中只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html)**。
  12225. *
  12226. * **示例代码**
  12227. *
  12228. * ```js
  12229. wx.getSetting({
  12230. success (res) {
  12231. console.log(res.authSetting)
  12232. // res.authSetting = {
  12233. // "scope.userInfo": true,
  12234. // "scope.userLocation": true
  12235. // }
  12236. }
  12237. })
  12238. ```
  12239. *
  12240. * ```js
  12241. wx.getSetting({
  12242. withSubscriptions: true,
  12243. success (res) {
  12244. console.log(res.authSetting)
  12245. // res.authSetting = {
  12246. // "scope.userInfo": true,
  12247. // "scope.userLocation": true
  12248. // }
  12249. console.log(res.subscriptionsSetting)
  12250. // res.subscriptionsSetting = {
  12251. // mainSwitch: true, // 订阅消息总开关
  12252. // itemSettings: { // 每一项开关
  12253. // SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息
  12254. // SYS_MSG_TYPE_RANK: 'accept'
  12255. // zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息
  12256. // ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban',
  12257. // }
  12258. // }
  12259. }
  12260. })
  12261. ``` */
  12262. getSetting<T extends GetSettingOption = GetSettingOption>(
  12263. option?: T
  12264. ): PromisifySuccessResult<T, GetSettingOption>
  12265. /** [wx.getShareInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.getShareInfo.html)
  12266. *
  12267. * 需要基础库: `1.1.0`
  12268. *
  12269. * 获取转发详细信息
  12270. *
  12271. * **示例代码**
  12272. *
  12273. * 敏感数据获取方式 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) 。
  12274. * 获取得到的开放数据为以下 json 结构(其中 openGId 为当前群的唯一标识):
  12275. *
  12276. * ```json
  12277. {
  12278. "openGId": "OPENGID"
  12279. }
  12280. ```
  12281. *
  12282. * **Tips**
  12283. *
  12284. * - 如需要展示群名称,小程序可以使用 [开放数据组件](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/open-data.html)
  12285. * - 小游戏可以通过 [`wx.getGroupInfo`](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupInfo.html) 接口获取群名称 */
  12286. getShareInfo<T extends GetShareInfoOption = GetShareInfoOption>(
  12287. option: T
  12288. ): PromisifySuccessResult<T, GetShareInfoOption>
  12289. /** [wx.getStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorage.html)
  12290. *
  12291. * 从本地缓存中异步获取指定 key 的内容。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
  12292. *
  12293. * **示例代码**
  12294. *
  12295. * ```js
  12296. wx.getStorage({
  12297. key: 'key',
  12298. success (res) {
  12299. console.log(res.data)
  12300. }
  12301. })
  12302. ```
  12303. *
  12304. * ```js
  12305. try {
  12306. var value = wx.getStorageSync('key')
  12307. if (value) {
  12308. // Do something with return value
  12309. }
  12310. } catch (e) {
  12311. // Do something when catch error
  12312. }
  12313. ```
  12314. *
  12315. * ```js
  12316. // 开启加密存储
  12317. wx.setStorage({
  12318. key: "key",
  12319. data: "value",
  12320. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  12321. success() {
  12322. wx.getStorage({
  12323. key: "key",
  12324. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  12325. success(res) {
  12326. console.log(res.data)
  12327. }
  12328. })
  12329. }
  12330. })
  12331. ``` */
  12332. getStorage<
  12333. T = any,
  12334. U extends GetStorageOption<T> = GetStorageOption<T>
  12335. >(
  12336. option: U
  12337. ): PromisifySuccessResult<U, GetStorageOption<T>>
  12338. /** [wx.getStorageInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageInfo.html)
  12339. *
  12340. * 异步获取当前storage的相关信息。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
  12341. *
  12342. * **示例代码**
  12343. *
  12344. * ```js
  12345. wx.getStorageInfo({
  12346. success (res) {
  12347. console.log(res.keys)
  12348. console.log(res.currentSize)
  12349. console.log(res.limitSize)
  12350. }
  12351. })
  12352. ```
  12353. *
  12354. * ```js
  12355. try {
  12356. const res = wx.getStorageInfoSync()
  12357. console.log(res.keys)
  12358. console.log(res.currentSize)
  12359. console.log(res.limitSize)
  12360. } catch (e) {
  12361. // Do something when catch error
  12362. }
  12363. ``` */
  12364. getStorageInfo<T extends GetStorageInfoOption = GetStorageInfoOption>(
  12365. option?: T
  12366. ): PromisifySuccessResult<T, GetStorageInfoOption>
  12367. /** [wx.getSystemInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfo.html)
  12368. *
  12369. * 获取系统信息。**由于历史原因,wx.getSystemInfo 是异步的调用格式,但是是同步返回,需要异步获取系统信息请使用 [wx.getSystemInfoAsync](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoAsync.html)。**
  12370. *
  12371. * **示例代码**
  12372. *
  12373. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/WkUCgXmS7mqO)
  12374. *
  12375. * ```js
  12376. wx.getSystemInfo({
  12377. success (res) {
  12378. console.log(res.model)
  12379. console.log(res.pixelRatio)
  12380. console.log(res.windowWidth)
  12381. console.log(res.windowHeight)
  12382. console.log(res.language)
  12383. console.log(res.version)
  12384. console.log(res.platform)
  12385. }
  12386. })
  12387. ```
  12388. *
  12389. * ```js
  12390. try {
  12391. const res = wx.getSystemInfoSync()
  12392. console.log(res.model)
  12393. console.log(res.pixelRatio)
  12394. console.log(res.windowWidth)
  12395. console.log(res.windowHeight)
  12396. console.log(res.language)
  12397. console.log(res.version)
  12398. console.log(res.platform)
  12399. } catch (e) {
  12400. // Do something when catch error
  12401. }
  12402. ``` */
  12403. getSystemInfo<T extends GetSystemInfoOption = GetSystemInfoOption>(
  12404. option?: T
  12405. ): PromisifySuccessResult<T, GetSystemInfoOption>
  12406. /** [wx.getSystemInfoAsync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoAsync.html)
  12407. *
  12408. * 需要基础库: `2.14.1`
  12409. *
  12410. * 异步获取系统信息。需要一定的微信客户端版本支持,在不支持的客户端上,会使用同步实现来返回。
  12411. *
  12412. * **示例代码**
  12413. *
  12414. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/WkUCgXmS7mqO)
  12415. *
  12416. * ```js
  12417. wx.getSystemInfoAsync({
  12418. success (res) {
  12419. console.log(res.model)
  12420. console.log(res.pixelRatio)
  12421. console.log(res.windowWidth)
  12422. console.log(res.windowHeight)
  12423. console.log(res.language)
  12424. console.log(res.version)
  12425. console.log(res.platform)
  12426. }
  12427. })
  12428. ``` */
  12429. getSystemInfoAsync(option?: GetSystemInfoAsyncOption): void
  12430. /** [wx.getUserCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserCloudStorage.html)
  12431. *
  12432. * 需要基础库: `1.9.92`
  12433. *
  12434. * 获取当前用户托管数据当中对应 key 的数据。该接口只可在开放数据域下使用 */
  12435. getUserCloudStorage<
  12436. T extends GetUserCloudStorageOption = GetUserCloudStorageOption
  12437. >(
  12438. option: T
  12439. ): PromisifySuccessResult<T, GetUserCloudStorageOption>
  12440. /** [wx.getUserCloudStorageKeys(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserCloudStorageKeys.html)
  12441. *
  12442. * 需要基础库: `2.16.1`
  12443. *
  12444. * 获取当前用户托管数据当中所有的 key。该接口需要用户授权,且只在开放数据域下可用。 */
  12445. getUserCloudStorageKeys(option?: GetUserCloudStorageKeysOption): void
  12446. /** [wx.getUserInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.getUserInfo.html)
  12447. *
  12448. * 获取用户信息。
  12449. *
  12450. * **接口调整说明**
  12451. *
  12452. * 为优化用户登录体验,该接口将进行调整,详见 [用户信息接口调整说明](https://developers.weixin.qq.com/community/develop/doc/000cacfa20ce88df04cb468bc52801)
  12453. *
  12454. * **示例代码**
  12455. *
  12456. * ```js
  12457. // 必须是在用户已经授权的情况下调用
  12458. wx.getUserInfo({
  12459. success: function(res) {
  12460. var userInfo = res.userInfo
  12461. var nickName = userInfo.nickName
  12462. var avatarUrl = userInfo.avatarUrl
  12463. var gender = userInfo.gender //性别 0:未知、1:男、2:女
  12464. var province = userInfo.province
  12465. var city = userInfo.city
  12466. var country = userInfo.country
  12467. }
  12468. })
  12469. ```
  12470. *
  12471. * 敏感数据有两种获取方式:
  12472. * 1. 使用 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法)
  12473. * 2. 使用 [云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#云调用直接获取开放数据)
  12474. * 获取得到的开放数据为以下 json 结构:
  12475. *
  12476. * ```json
  12477. {
  12478. "openId": "OPENID",
  12479. "nickName": "NICKNAME",
  12480. "gender": GENDER,
  12481. "city": "CITY",
  12482. "province": "PROVINCE",
  12483. "country": "COUNTRY",
  12484. "avatarUrl": "AVATARURL",
  12485. "unionId": "UNIONID",
  12486. "watermark": {
  12487. "appid":"APPID",
  12488. "timestamp":TIMESTAMP
  12489. }
  12490. }
  12491. ```
  12492. *
  12493. * **小程序用户信息组件示例代码**
  12494. *
  12495. * ```html
  12496. * <!-- 如果只是展示用户头像昵称,可以使用 <open-data /> 组件 -->
  12497. * <open-data type="userAvatarUrl"></open-data>
  12498. * <open-data type="userNickName"></open-data>
  12499. * <!-- 需要使用 button 来授权登录 -->
  12500. * <button wx:if="{{canIUse}}" open-type="getUserInfo" bindgetuserinfo="bindGetUserInfo">授权登录</button>
  12501. * <view wx:else>请升级微信版本</view>
  12502. * ```
  12503. *
  12504. * ```js
  12505. Page({
  12506. data: {
  12507. canIUse: wx.canIUse('button.open-type.getUserInfo')
  12508. },
  12509. onLoad: function() {
  12510. // 查看是否授权
  12511. wx.getSetting({
  12512. success (res){
  12513. if (res.authSetting['scope.userInfo']) {
  12514. // 已经授权,可以直接调用 getUserInfo 获取头像昵称
  12515. wx.getUserInfo({
  12516. success: function(res) {
  12517. console.log(res.userInfo)
  12518. }
  12519. })
  12520. }
  12521. }
  12522. })
  12523. },
  12524. bindGetUserInfo (e) {
  12525. console.log(e.detail.userInfo)
  12526. }
  12527. })
  12528. ``` */
  12529. getUserInfo<T extends GetUserInfoOption = GetUserInfoOption>(
  12530. option: T
  12531. ): PromisifySuccessResult<T, GetUserInfoOption>
  12532. /** [wx.getUserInteractiveStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserInteractiveStorage.html)
  12533. *
  12534. * 需要基础库: `2.7.7`
  12535. *
  12536. * 获取当前用户互动型托管数据对应 key 的数据。该接口需要用户授权。 */
  12537. getUserInteractiveStorage<
  12538. T extends GetUserInteractiveStorageOption = GetUserInteractiveStorageOption
  12539. >(
  12540. option: T
  12541. ): PromisifySuccessResult<T, GetUserInteractiveStorageOption>
  12542. /** [wx.getWeRunData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/werun/wx.getWeRunData.html)
  12543. *
  12544. * 需要基础库: `1.2.0`
  12545. *
  12546. * 获取用户过去三十天微信运动步数。需要先调用 [wx.login](https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.login.html) 接口。步数信息会在用户主动进入小程序时更新。
  12547. *
  12548. * **示例代码**
  12549. *
  12550. * ```js
  12551. wx.getWeRunData({
  12552. success (res) {
  12553. // 拿 encryptedData 到开发者后台解密开放数据
  12554. const encryptedData = res.encryptedData
  12555. // 或拿 cloudID 通过云调用直接获取开放数据
  12556. const cloudID = res.cloudID
  12557. }
  12558. })
  12559. ```
  12560. *
  12561. * **开放数据 JSON 结构**
  12562. *
  12563. * 敏感数据有两种获取方式,一是使用 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) 。
  12564. * 获取得到的开放数据为以下 json 结构:
  12565. *
  12566. * ```json
  12567. {
  12568. "stepInfoList": [
  12569. {
  12570. "timestamp": 1445866601,
  12571. "step": 100
  12572. },
  12573. {
  12574. "timestamp": 1445876601,
  12575. "step": 120
  12576. }
  12577. ]
  12578. }
  12579. ```
  12580. *
  12581. * stepInfoList 中,每一项结构如下:
  12582. *
  12583. * | 属性 | 类型 | 说明 |
  12584. * | --- | ---- | --- |
  12585. * | timestamp | number | 时间戳,表示数据对应的时间 |
  12586. * | step | number | 微信运动步数 | */
  12587. getWeRunData<T extends GetWeRunDataOption = GetWeRunDataOption>(
  12588. option?: T
  12589. ): PromisifySuccessResult<T, GetWeRunDataOption>
  12590. /** [wx.hideKeyboard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.hideKeyboard.html)
  12591. *
  12592. * 隐藏键盘 */
  12593. hideKeyboard<T extends HideKeyboardOption = HideKeyboardOption>(
  12594. option?: T
  12595. ): PromisifySuccessResult<T, HideKeyboardOption>
  12596. /** [wx.hideLoading(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.hideLoading.html)
  12597. *
  12598. * 需要基础库: `1.1.0`
  12599. *
  12600. * 隐藏 loading 提示框 */
  12601. hideLoading<T extends HideLoadingOption = HideLoadingOption>(
  12602. option?: T
  12603. ): PromisifySuccessResult<T, HideLoadingOption>
  12604. /** [wx.hideShareMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.hideShareMenu.html)
  12605. *
  12606. * 需要基础库: `1.1.0`
  12607. *
  12608. * 隐藏当前页面的转发按钮
  12609. *
  12610. * ****
  12611. *
  12612. * ## 注意事项
  12613. * - "shareAppMessage"表示“发送给朋友”按钮,"shareTimeline"表示“分享到朋友圈”按钮
  12614. * - 隐藏“发送给朋友”按钮时必须同时隐藏“分享到朋友圈”按钮,隐藏“分享到朋友圈”按钮时则允许不隐藏“发送给朋友”按钮
  12615. *
  12616. * **示例代码**
  12617. *
  12618. * ```js
  12619. wx.hideShareMenu({
  12620. menus: ['shareAppMessage', 'shareTimeline']
  12621. })
  12622. ``` */
  12623. hideShareMenu<T extends HideShareMenuOption = HideShareMenuOption>(
  12624. option?: T
  12625. ): PromisifySuccessResult<T, HideShareMenuOption>
  12626. /** [wx.hideToast(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.hideToast.html)
  12627. *
  12628. * 隐藏消息提示框 */
  12629. hideToast<T extends HideToastOption = HideToastOption>(
  12630. option?: T
  12631. ): PromisifySuccessResult<T, HideToastOption>
  12632. /** [wx.initFaceDetect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ai/face/wx.initFaceDetect.html)
  12633. *
  12634. * 需要基础库: `2.18.0`
  12635. *
  12636. * 初始化人脸识别 */
  12637. initFaceDetect(option?: InitFaceDetectOption): void
  12638. /** [wx.isBluetoothDevicePaired(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.isBluetoothDevicePaired.html)
  12639. *
  12640. * 需要基础库: `2.20.1`
  12641. *
  12642. * 查询蓝牙设备是否配对,仅安卓支持。 */
  12643. isBluetoothDevicePaired<
  12644. T extends IsBluetoothDevicePairedOption = IsBluetoothDevicePairedOption
  12645. >(
  12646. option: T
  12647. ): PromisifySuccessResult<T, IsBluetoothDevicePairedOption>
  12648. /** [wx.joinVoIPChat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.joinVoIPChat.html)
  12649. *
  12650. * 需要基础库: `2.7.0`
  12651. *
  12652. * 加入 (创建) 实时语音通话,更多信息可见 [实时语音指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/voip-chat.html)。调用前需要用户授权 `scope.record`,若房间类型为视频房间需要用户授权 `scope.camera`。 */
  12653. joinVoIPChat<T extends JoinVoIPChatOption = JoinVoIPChatOption>(
  12654. option: T
  12655. ): PromisifySuccessResult<T, JoinVoIPChatOption>
  12656. /** [wx.login(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.login.html)
  12657. *
  12658. * 调用接口获取登录凭证(code)。通过凭证进而换取用户登录态信息,包括用户在当前小程序的唯一标识(openid)、微信开放平台帐号下的唯一标识(unionid,若当前小程序已绑定到微信开放平台帐号)及本次登录的会话密钥(session_key)等。用户数据的加解密通讯需要依赖会话密钥完成。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/login.html)。
  12659. *
  12660. * **示例代码**
  12661. *
  12662. * ```js
  12663. wx.login({
  12664. success (res) {
  12665. if (res.code) {
  12666. //发起网络请求
  12667. wx.request({
  12668. url: 'https://example.com/onLogin',
  12669. data: {
  12670. code: res.code
  12671. }
  12672. })
  12673. } else {
  12674. console.log('登录失败!' + res.errMsg)
  12675. }
  12676. }
  12677. })
  12678. ``` */
  12679. login<T extends LoginOption = LoginOption>(
  12680. option?: T
  12681. ): PromisifySuccessResult<T, LoginOption>
  12682. /** [wx.makeBluetoothPair(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.makeBluetoothPair.html)
  12683. *
  12684. * 需要基础库: `2.12.0`
  12685. *
  12686. * 蓝牙配对接口,仅安卓支持。
  12687. *
  12688. * 通常情况下(需要指定 `pin` 码或者密码时)系统会接管配对流程,直接调用 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 即可。该接口只应当在开发者不想让用户手动输入 `pin` 码且真机验证确认可以正常生效情况下用。 */
  12689. makeBluetoothPair<
  12690. T extends MakeBluetoothPairOption = MakeBluetoothPairOption
  12691. >(
  12692. option: T
  12693. ): PromisifySuccessResult<T, MakeBluetoothPairOption>
  12694. /** [wx.modifyFriendInteractiveStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.modifyFriendInteractiveStorage.html)
  12695. *
  12696. * 需要基础库: `2.7.7`
  12697. *
  12698. * 修改好友的互动型托管数据,该接口只可在开放数据域下使用。
  12699. *
  12700. * **赠送动作的校验**
  12701. *
  12702. * 调用该接口需要上传 JSServer 函数 "checkInteractiveData",该函数可用于执行赠送动作的校验逻辑,校验通过后返回结果表示本次赠送是否合法。只有 checkInteractiveData 返回了 `{ret: true}`,此次修改才会成功。
  12703. *
  12704. * **使用模板规则进行交互**
  12705. *
  12706. * 每次调用该接口会弹窗询问用户是否确认执行该操作,2.9.0 之后版本,需要在 game.json 中设置 `modifyFriendInteractiveStorageTemplates` 来定制交互的文案。
  12707. * `modifyFriendInteractiveStorageTemplates` 是一个模板数组,每一个模板需要有 key, action, object 参数,还有一个可选参数 ratio,详细说明见示例配置:
  12708. * ```json
  12709. {
  12710. "modifyFriendInteractiveStorageTemplates": [
  12711. {
  12712. "key": "1", // 这个 key 与接口中同名参数相对应,不同的 key 对应不同的模板
  12713. "action": "赠送", // 互动行为
  12714. "object": "金币", // 互动物品
  12715. "ratio": 10 // 物品比率,opNum * ratio 代表物品个数
  12716. }
  12717. ]
  12718. }
  12719. ```
  12720. * 最后生成的文案为 "确认 ${action} ${nickname} ${object}?",或者 "确认 ${action} ${nickname} ${object} x ${opNum * ratio}?"
  12721. *
  12722. * **使用自定义文案进行交互**
  12723. *
  12724. * 2.7.7 之后,2.9.0 之前的版本,文案通过 game.json 的 `modifyFriendInteractiveStorageConfirmWording` 字段配置。
  12725. * 配置内容可包含 nickname 变量,用 ${nickname} 表示,实际调用时会被替换成好友的昵称。示例配置:
  12726. * ```json
  12727. {
  12728. "modifyFriendInteractiveStorageConfirmWording": "确认送给${nickname}一个体力?"
  12729. }
  12730. ```
  12731. * 2.9.0 之后,在 `modifyFriendInteractiveStorageTemplates` 和 `modifyFriendInteractiveStorageConfirmWording` 都存在的情况下,会优先使用前者。 */
  12732. modifyFriendInteractiveStorage<
  12733. T extends ModifyFriendInteractiveStorageOption = ModifyFriendInteractiveStorageOption
  12734. >(
  12735. option: T
  12736. ): PromisifySuccessResult<T, ModifyFriendInteractiveStorageOption>
  12737. /** [wx.navigateToMiniProgram(Object object)](https://developers.weixin.qq.com/minigame/dev/api/navigate/wx.navigateToMiniProgram.html)
  12738. *
  12739. * 需要基础库: `2.2.0`
  12740. *
  12741. * 打开另一个小程序
  12742. *
  12743. * **使用限制**
  12744. *
  12745. * ##### 需要用户触发跳转
  12746. * 从 2.3.0 版本开始,若用户未点击小程序页面任意位置,则开发者将无法调用此接口自动跳转至其他小程序。
  12747. * ##### 需要用户确认跳转
  12748. * 从 2.3.0 版本开始,在跳转至其他小程序前,将统一增加弹窗,询问是否跳转,用户确认后才可以跳转其他小程序。如果用户点击取消,则回调 `fail cancel`。
  12749. * ##### 无需声明跳转名单,不限跳转数量(众测中)
  12750. * 1. 从2020年4月24日起,使用跳转其他小程序功能将无需在全局配置中声明跳转名单,调用此接口时将不再校验所跳转的 AppID 是否在 navigateToMiniProgramAppIdList 中。
  12751. * 2. 从2020年4月24日起,跳转其他小程序将不再受数量限制,使用此功能时请注意遵守运营规范。
  12752. *
  12753. * **运营规范**
  12754. *
  12755. * 平台将坚决打击小程序盒子等互推行为,使用此功能时请严格遵守[《微信小程序平台运营规范》](https://developers.weixin.qq.com/miniprogram/product/#_5-10-%E4%BA%92%E6%8E%A8%E8%A1%8C%E4%B8%BA),若发现小程序违反运营规范将被下架处理。
  12756. *
  12757. * **关于调试**
  12758. *
  12759. * - 在开发者工具上调用此 API 并不会真实的跳转到另外的小程序,但是开发者工具会校验本次调用跳转是否成功。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持)
  12760. * - 开发者工具上支持被跳转的小程序处理接收参数的调试。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持)
  12761. *
  12762. * **示例代码**
  12763. *
  12764. * ```js
  12765. wx.navigateToMiniProgram({
  12766. appId: '',
  12767. path: 'page/index/index?id=123',
  12768. extraData: {
  12769. foo: 'bar'
  12770. },
  12771. envVersion: 'develop',
  12772. success(res) {
  12773. // 打开成功
  12774. }
  12775. })
  12776. ``` */
  12777. navigateToMiniProgram<
  12778. T extends NavigateToMiniProgramOption = NavigateToMiniProgramOption
  12779. >(
  12780. option: T
  12781. ): PromisifySuccessResult<T, NavigateToMiniProgramOption>
  12782. /** [wx.notifyBLECharacteristicValueChange(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html)
  12783. *
  12784. * 需要基础库: `2.9.2`
  12785. *
  12786. * 启用蓝牙低功耗设备特征值变化时的 notify 功能,订阅特征。注意:必须设备的特征支持 notify 或者 indicate 才可以成功调用。
  12787. *
  12788. * 另外,必须先启用 [wx.notifyBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) 才能监听到设备 `characteristicValueChange` 事件
  12789. *
  12790. * **注意**
  12791. *
  12792. * - 订阅操作成功后需要设备主动更新特征的 value,才会触发 [wx.onBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html) 回调。
  12793. * - 安卓平台上,在本接口调用成功后立即调用 [wx.writeBLECharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.writeBLECharacteristicValue.html) 接口,在部分机型上会发生 10008 系统错误
  12794. *
  12795. * **示例代码**
  12796. *
  12797. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  12798. * ```js
  12799. wx.notifyBLECharacteristicValueChange({
  12800. state: true, // 启用 notify 功能
  12801. // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
  12802. deviceId,
  12803. // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取
  12804. serviceId,
  12805. // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取
  12806. characteristicId,
  12807. success (res) {
  12808. console.log('notifyBLECharacteristicValueChange success', res.errMsg)
  12809. }
  12810. })
  12811. ``` */
  12812. notifyBLECharacteristicValueChange<
  12813. T extends NotifyBLECharacteristicValueChangeOption = NotifyBLECharacteristicValueChangeOption
  12814. >(
  12815. option: T
  12816. ): PromisifySuccessResult<T, NotifyBLECharacteristicValueChangeOption>
  12817. /** [wx.offAccelerometerChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.offAccelerometerChange.html)
  12818. *
  12819. * 需要基础库: `2.9.3`
  12820. *
  12821. * 取消监听加速度数据事件,参数为空,则取消所有的事件监听。 */
  12822. offAccelerometerChange(
  12823. /** 加速度数据事件的回调函数 */
  12824. callback: (...args: any[]) => any
  12825. ): void
  12826. /** [wx.offAddToFavorites(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offAddToFavorites.html)
  12827. *
  12828. * 需要基础库: `2.10.3`
  12829. *
  12830. * 取消监听用户点击菜单「收藏」按钮时触发的事件 */
  12831. offAddToFavorites(
  12832. /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
  12833. callback?: OffAddToFavoritesCallback
  12834. ): void
  12835. /** [wx.offAudioInterruptionBegin(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offAudioInterruptionBegin.html)
  12836. *
  12837. * 需要基础库: `1.8.0`
  12838. *
  12839. * 取消监听音频因为受到系统占用而被中断开始事件 */
  12840. offAudioInterruptionBegin(
  12841. /** 音频因为受到系统占用而被中断开始事件的回调函数 */
  12842. callback?: OffAudioInterruptionBeginCallback
  12843. ): void
  12844. /** [wx.offAudioInterruptionEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offAudioInterruptionEnd.html)
  12845. *
  12846. * 需要基础库: `1.8.0`
  12847. *
  12848. * 取消监听音频中断结束事件 */
  12849. offAudioInterruptionEnd(
  12850. /** 音频中断结束事件的回调函数 */
  12851. callback?: OffAudioInterruptionEndCallback
  12852. ): void
  12853. /** [wx.offBLECharacteristicValueChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.offBLECharacteristicValueChange.html)
  12854. *
  12855. * 需要基础库: `2.9.2`
  12856. *
  12857. * 取消监听蓝牙低功耗设备的特征值变化事件。 */
  12858. offBLECharacteristicValueChange(
  12859. /** 蓝牙低功耗设备的特征值变化事件的回调函数 */
  12860. callback: (...args: any[]) => any
  12861. ): void
  12862. /** [wx.offBLEConnectionStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.offBLEConnectionStateChange.html)
  12863. *
  12864. * 需要基础库: `2.9.2`
  12865. *
  12866. * 取消监听蓝牙低功耗连接状态的改变事件 */
  12867. offBLEConnectionStateChange(
  12868. /** 蓝牙低功耗连接状态的改变事件的回调函数 */
  12869. callback: (...args: any[]) => any
  12870. ): void
  12871. /** [wx.offBLEMTUChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.offBLEMTUChange.html)
  12872. *
  12873. * 需要基础库: `2.20.1`
  12874. *
  12875. * 取消监听蓝牙低功耗的最大传输单元变化事件 */
  12876. offBLEMTUChange(
  12877. /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
  12878. callback?: OffBLEMTUChangeCallback
  12879. ): void
  12880. /** [wx.offBLEPeripheralConnectionStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/wx.offBLEPeripheralConnectionStateChanged.html)
  12881. *
  12882. * 需要基础库: `2.10.3`
  12883. *
  12884. * 取消监听当前外围设备被连接或断开连接事件 */
  12885. offBLEPeripheralConnectionStateChanged(
  12886. /** 当前外围设备被连接或断开连接事件的回调函数 */
  12887. callback?: OffBLEPeripheralConnectionStateChangedCallback
  12888. ): void
  12889. /** [wx.offBeaconServiceChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.offBeaconServiceChange.html)
  12890. *
  12891. * 需要基础库: `2.9.2`
  12892. *
  12893. * 取消监听 Beacon 服务状态变化事件 */
  12894. offBeaconServiceChange(
  12895. /** Beacon 服务状态变化事件的回调函数 */
  12896. callback?: OffBeaconServiceChangeCallback
  12897. ): void
  12898. /** [wx.offBeaconUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.offBeaconUpdate.html)
  12899. *
  12900. * 需要基础库: `2.9.2`
  12901. *
  12902. * 取消监听 Beacon 设备更新事件 */
  12903. offBeaconUpdate(
  12904. /** Beacon 设备更新事件的回调函数 */
  12905. callback?: OffBeaconUpdateCallback
  12906. ): void
  12907. /** [wx.offBluetoothAdapterStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.offBluetoothAdapterStateChange.html)
  12908. *
  12909. * 需要基础库: `2.9.2`
  12910. *
  12911. * 取消监听蓝牙适配器状态变化事件。 */
  12912. offBluetoothAdapterStateChange(
  12913. /** 蓝牙适配器状态变化事件的回调函数 */
  12914. callback: (...args: any[]) => any
  12915. ): void
  12916. /** [wx.offBluetoothDeviceFound(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.offBluetoothDeviceFound.html)
  12917. *
  12918. * 需要基础库: `2.9.2`
  12919. *
  12920. * 取消监听寻找到新设备的事件。 */
  12921. offBluetoothDeviceFound(
  12922. /** 寻找到新设备的事件的回调函数 */
  12923. callback: (...args: any[]) => any
  12924. ): void
  12925. /** [wx.offCompassChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.offCompassChange.html)
  12926. *
  12927. * 需要基础库: `2.9.3`
  12928. *
  12929. * 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听。 */
  12930. offCompassChange(
  12931. /** 罗盘数据变化事件的回调函数 */
  12932. callback: (...args: any[]) => any
  12933. ): void
  12934. /** [wx.offCopyUrl(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offCopyUrl.html)
  12935. *
  12936. * 需要基础库: `2.14.3`
  12937. *
  12938. * 取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件 */
  12939. offCopyUrl(
  12940. /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
  12941. callback?: OffCopyUrlCallback
  12942. ): void
  12943. /** [wx.offDeviceMotionChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.offDeviceMotionChange.html)
  12944. *
  12945. * 需要基础库: `2.9.3`
  12946. *
  12947. * 取消监听设备方向变化事件,参数为空,则取消所有的事件监听。 */
  12948. offDeviceMotionChange(
  12949. /** 设备方向变化事件的回调函数 */
  12950. callback: (...args: any[]) => any
  12951. ): void
  12952. /** [wx.offDeviceOrientationChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/orientation/wx.offDeviceOrientationChange.html)
  12953. *
  12954. * 需要基础库: `2.1.0`
  12955. *
  12956. * 取消监听横竖屏切换事件 */
  12957. offDeviceOrientationChange(
  12958. /** 横竖屏切换事件的回调函数 */
  12959. callback?: OffDeviceOrientationChangeCallback
  12960. ): void
  12961. /** [wx.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offError.html)
  12962. *
  12963. * 取消监听全局错误事件 */
  12964. offError(
  12965. /** 全局错误事件的回调函数 */
  12966. callback?: WxOffErrorCallback
  12967. ): void
  12968. /** [wx.offGyroscopeChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.offGyroscopeChange.html)
  12969. *
  12970. * 需要基础库: `2.9.3`
  12971. *
  12972. * 取消监听陀螺仪数据变化事件。 */
  12973. offGyroscopeChange(
  12974. /** 陀螺仪数据变化事件的回调函数 */
  12975. callback: (...args: any[]) => any
  12976. ): void
  12977. /** [wx.offHandoff(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offHandoff.html)
  12978. *
  12979. * 需要基础库: `2.14.4`
  12980. *
  12981. * 取消监听用户点击菜单「在电脑上打开」按钮时触发的事件 */
  12982. offHandoff(
  12983. /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
  12984. callback?: OffHandoffCallback
  12985. ): void
  12986. /** [wx.offHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.offHide.html)
  12987. *
  12988. * 取消监听小游戏隐藏到后台事件 */
  12989. offHide(
  12990. /** 小游戏隐藏到后台事件的回调函数 */
  12991. callback?: OffHideCallback
  12992. ): void
  12993. /** [wx.offInteractiveStorageModified(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.offInteractiveStorageModified.html)
  12994. *
  12995. * 需要基础库: `2.14.4`
  12996. *
  12997. * 取消监听成功修改好友的互动型托管数据事件,该接口在游戏主域使用 */
  12998. offInteractiveStorageModified(
  12999. /** 事件发生的回调函数,留空则清除所有回调 */
  13000. callback?: (...args: any[]) => any
  13001. ): void
  13002. /** [wx.offKeyDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyDown.html)
  13003. *
  13004. * 需要基础库: `2.10.1`
  13005. *
  13006. * 取消监听键盘按键按下事件 */
  13007. offKeyDown(
  13008. /** 键盘按键按下事件的回调函数 */
  13009. callback?: OffKeyDownCallback
  13010. ): void
  13011. /** [wx.offKeyUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyUp.html)
  13012. *
  13013. * 需要基础库: `2.10.1`
  13014. *
  13015. * 取消监听键盘按键弹起事件 */
  13016. offKeyUp(
  13017. /** 键盘按键弹起事件的回调函数 */
  13018. callback?: OffKeyUpCallback
  13019. ): void
  13020. /** [wx.offKeyboardComplete(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardComplete.html)
  13021. *
  13022. * 取消监听监听键盘收起的事件 */
  13023. offKeyboardComplete(
  13024. /** 监听键盘收起的事件的回调函数 */
  13025. callback?: OffKeyboardCompleteCallback
  13026. ): void
  13027. /** [wx.offKeyboardConfirm(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardConfirm.html)
  13028. *
  13029. * 取消监听用户点击键盘 Confirm 按钮时的事件 */
  13030. offKeyboardConfirm(
  13031. /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
  13032. callback?: OffKeyboardConfirmCallback
  13033. ): void
  13034. /** [wx.offKeyboardHeightChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardHeightChange.html)
  13035. *
  13036. * 需要基础库: `2.21.3`
  13037. *
  13038. * 取消监听键盘高度变化事件 */
  13039. offKeyboardHeightChange(
  13040. /** 键盘高度变化事件的回调函数 */
  13041. callback: (...args: any[]) => any
  13042. ): void
  13043. /** [wx.offKeyboardInput(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardInput.html)
  13044. *
  13045. * 取消监听键盘输入事件 */
  13046. offKeyboardInput(
  13047. /** 键盘输入事件的回调函数 */
  13048. callback?: OffKeyboardInputCallback
  13049. ): void
  13050. /** [wx.offMemoryWarning(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/memory/wx.offMemoryWarning.html)
  13051. *
  13052. * 需要基础库: `2.9.0`
  13053. *
  13054. * 取消监听内存不足告警事件。 */
  13055. offMemoryWarning(
  13056. /** 内存不足告警事件的回调函数 */
  13057. callback: (...args: any[]) => any
  13058. ): void
  13059. /** [wx.offMouseDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.offMouseDown.html)
  13060. *
  13061. * 取消监听鼠标按键按下事件 */
  13062. offMouseDown(
  13063. /** 鼠标按键按下事件的回调函数 */
  13064. callback?: OffMouseDownCallback
  13065. ): void
  13066. /** [wx.offMouseMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.offMouseMove.html)
  13067. *
  13068. * 取消监听鼠标移动事件 */
  13069. offMouseMove(
  13070. /** 鼠标移动事件的回调函数 */
  13071. callback?: OffMouseMoveCallback
  13072. ): void
  13073. /** [wx.offMouseUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.offMouseUp.html)
  13074. *
  13075. * 取消监听鼠标按键弹起事件 */
  13076. offMouseUp(
  13077. /** 鼠标按键弹起事件的回调函数 */
  13078. callback?: OffMouseUpCallback
  13079. ): void
  13080. /** [wx.offNetworkStatusChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.offNetworkStatusChange.html)
  13081. *
  13082. * 需要基础库: `2.9.3`
  13083. *
  13084. * 取消监听网络状态变化事件,参数为空,则取消所有的事件监听。 */
  13085. offNetworkStatusChange(
  13086. /** 网络状态变化事件的回调函数 */
  13087. callback: (...args: any[]) => any
  13088. ): void
  13089. /** [wx.offNetworkWeakChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.offNetworkWeakChange.html)
  13090. *
  13091. * 需要基础库: `2.21.0`
  13092. *
  13093. * 取消监听弱网状态变化事件 */
  13094. offNetworkWeakChange(
  13095. /** 弱网状态变化事件的回调函数 */
  13096. callback?: OffNetworkWeakChangeCallback
  13097. ): void
  13098. /** [wx.offShareAppMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offShareAppMessage.html)
  13099. *
  13100. * 取消监听用户点击右上角菜单的「转发」按钮时触发的事件 */
  13101. offShareAppMessage(
  13102. /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
  13103. callback?: OffShareAppMessageCallback
  13104. ): void
  13105. /** [wx.offShareTimeline(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offShareTimeline.html)
  13106. *
  13107. * 需要基础库: `2.11.3`
  13108. *
  13109. * 取消监听用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件 */
  13110. offShareTimeline(
  13111. /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
  13112. callback?: OffShareTimelineCallback
  13113. ): void
  13114. /** [wx.offShow(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.offShow.html)
  13115. *
  13116. * 取消监听小游戏回到前台的事件 */
  13117. offShow(
  13118. /** 小游戏回到前台的事件的回调函数 */
  13119. callback?: OffShowCallback
  13120. ): void
  13121. /** [wx.offTouchCancel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchCancel.html)
  13122. *
  13123. * 取消监听触点失效事件 */
  13124. offTouchCancel(
  13125. /** 触点失效事件的回调函数 */
  13126. callback?: OffTouchCancelCallback
  13127. ): void
  13128. /** [wx.offTouchEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchEnd.html)
  13129. *
  13130. * 取消监听触摸结束事件 */
  13131. offTouchEnd(
  13132. /** 触摸结束事件的回调函数 */
  13133. callback?: OffTouchEndCallback
  13134. ): void
  13135. /** [wx.offTouchMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchMove.html)
  13136. *
  13137. * 取消监听触点移动事件 */
  13138. offTouchMove(
  13139. /** 触点移动事件的回调函数 */
  13140. callback?: OffTouchMoveCallback
  13141. ): void
  13142. /** [wx.offTouchStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchStart.html)
  13143. *
  13144. * 取消监听开始触摸事件 */
  13145. offTouchStart(
  13146. /** 开始触摸事件的回调函数 */
  13147. callback?: OffTouchStartCallback
  13148. ): void
  13149. /** [wx.offUnhandledRejection(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offUnhandledRejection.html)
  13150. *
  13151. * 需要基础库: `2.10.0`
  13152. *
  13153. * 取消监听未处理的 Promise 拒绝事件 */
  13154. offUnhandledRejection(
  13155. /** 未处理的 Promise 拒绝事件的回调函数 */
  13156. callback?: OffUnhandledRejectionCallback
  13157. ): void
  13158. /** [wx.offVoIPChatInterrupted(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatInterrupted.html)
  13159. *
  13160. * 需要基础库: `2.9.0`
  13161. *
  13162. * 取消监听被动断开实时语音通话事件。 */
  13163. offVoIPChatInterrupted(
  13164. /** 被动断开实时语音通话事件的回调函数 */
  13165. callback: (...args: any[]) => any
  13166. ): void
  13167. /** [wx.offVoIPChatMembersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatMembersChanged.html)
  13168. *
  13169. * 需要基础库: `2.9.0`
  13170. *
  13171. * 取消监听实时语音通话成员在线状态变化事件。 */
  13172. offVoIPChatMembersChanged(
  13173. /** 实时语音通话成员在线状态变化事件的回调函数 */
  13174. callback: (...args: any[]) => any
  13175. ): void
  13176. /** [wx.offVoIPChatSpeakersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatSpeakersChanged.html)
  13177. *
  13178. * 需要基础库: `2.9.0`
  13179. *
  13180. * 取消监听实时语音通话成员通话状态变化事件。 */
  13181. offVoIPChatSpeakersChanged(
  13182. /** 实时语音通话成员通话状态变化事件的回调函数 */
  13183. callback: (...args: any[]) => any
  13184. ): void
  13185. /** [wx.offVoIPChatStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatStateChanged.html)
  13186. *
  13187. * 需要基础库: `2.16.0`
  13188. *
  13189. * 取消监听房间状态变化事件 */
  13190. offVoIPChatStateChanged(
  13191. /** 房间状态变化事件的回调函数 */
  13192. callback?: OffVoIPChatStateChangedCallback
  13193. ): void
  13194. /** [wx.offWheel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/wheel-event/wx.offWheel.html)
  13195. *
  13196. * 取消监听鼠标滚轮事件 */
  13197. offWheel(
  13198. /** 鼠标滚轮事件的回调函数 */
  13199. callback?: OffWheelCallback
  13200. ): void
  13201. /** [wx.offWindowResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ui/window/wx.offWindowResize.html)
  13202. *
  13203. * 取消监听窗口尺寸变化事件 */
  13204. offWindowResize(
  13205. /** 窗口尺寸变化事件的回调函数 */
  13206. callback?: OffWindowResizeCallback
  13207. ): void
  13208. /** [wx.onAccelerometerChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.onAccelerometerChange.html)
  13209. *
  13210. * 监听加速度数据事件。频率根据 [wx.startAccelerometer()](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.startAccelerometer.html) 的 interval 参数, 接口调用后会自动开始监听。
  13211. *
  13212. * **示例代码**
  13213. *
  13214. * ```js
  13215. wx.onAccelerometerChange(callback)
  13216. ``` */
  13217. onAccelerometerChange(
  13218. /** 加速度数据事件的回调函数 */
  13219. callback: OnAccelerometerChangeCallback
  13220. ): void
  13221. /** [wx.onAddToFavorites(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onAddToFavorites.html)
  13222. *
  13223. * 需要基础库: `2.10.3`
  13224. *
  13225. * 监听用户点击菜单「收藏」按钮时触发的事件(安卓7.0.15起支持,iOS 暂不支持) */
  13226. onAddToFavorites(
  13227. /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
  13228. callback: OnAddToFavoritesCallback
  13229. ): void
  13230. /** [wx.onAudioInterruptionBegin(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onAudioInterruptionBegin.html)
  13231. *
  13232. * 需要基础库: `1.8.0`
  13233. *
  13234. * 监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后,小程序内所有音频会暂停。 */
  13235. onAudioInterruptionBegin(
  13236. /** 音频因为受到系统占用而被中断开始事件的回调函数 */
  13237. callback: OnAudioInterruptionBeginCallback
  13238. ): void
  13239. /** [wx.onAudioInterruptionEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onAudioInterruptionEnd.html)
  13240. *
  13241. * 需要基础库: `1.8.0`
  13242. *
  13243. * 监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功 */
  13244. onAudioInterruptionEnd(
  13245. /** 音频中断结束事件的回调函数 */
  13246. callback: OnAudioInterruptionEndCallback
  13247. ): void
  13248. /** [wx.onBLECharacteristicValueChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html)
  13249. *
  13250. * 需要基础库: `2.9.2`
  13251. *
  13252. * 监听蓝牙低功耗设备的特征值变化事件。必须先调用 [wx.notifyBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) 接口才能接收到设备推送的 notification。
  13253. *
  13254. * **示例代码**
  13255. *
  13256. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13257. *
  13258. * ```js
  13259. // ArrayBuffer转16进制字符串示例
  13260. function ab2hex(buffer) {
  13261. let hexArr = Array.prototype.map.call(
  13262. new Uint8Array(buffer),
  13263. function(bit) {
  13264. return ('00' + bit.toString(16)).slice(-2)
  13265. }
  13266. )
  13267. return hexArr.join('');
  13268. }
  13269. wx.onBLECharacteristicValueChange(function(res) {
  13270. console.log(`characteristic ${res.characteristicId} has changed, now is ${res.value}`)
  13271. console.log(ab2hex(res.value))
  13272. })
  13273. ``` */
  13274. onBLECharacteristicValueChange(
  13275. /** 蓝牙低功耗设备的特征值变化事件的回调函数 */
  13276. callback: OnBLECharacteristicValueChangeCallback
  13277. ): void
  13278. /** [wx.onBLEConnectionStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEConnectionStateChange.html)
  13279. *
  13280. * 需要基础库: `2.9.2`
  13281. *
  13282. * 监听蓝牙低功耗连接状态的改变事件。包括开发者主动连接或断开连接,设备丢失,连接异常断开等等
  13283. *
  13284. * **示例代码**
  13285. *
  13286. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13287. * ```js
  13288. wx.onBLEConnectionStateChange(function(res) {
  13289. // 该方法回调中可以用于处理连接意外断开等异常情况
  13290. console.log(`device ${res.deviceId} state has changed, connected: ${res.connected}`)
  13291. })
  13292. ``` */
  13293. onBLEConnectionStateChange(
  13294. /** 蓝牙低功耗连接状态的改变事件的回调函数 */
  13295. callback: OnBLEConnectionStateChangeCallback
  13296. ): void
  13297. /** [wx.onBLEMTUChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEMTUChange.html)
  13298. *
  13299. * 需要基础库: `2.20.1`
  13300. *
  13301. * 监听蓝牙低功耗的最大传输单元变化事件(仅安卓触发)。
  13302. *
  13303. * **示例代码**
  13304. *
  13305. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13306. * ```js
  13307. wx.onBLEMTUChange(function (res) {
  13308. console.log('bluetooth mtu is', res.mtu)
  13309. })
  13310. ``` */
  13311. onBLEMTUChange(
  13312. /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
  13313. callback: OnBLEMTUChangeCallback
  13314. ): void
  13315. /** [wx.onBLEPeripheralConnectionStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/wx.onBLEPeripheralConnectionStateChanged.html)
  13316. *
  13317. * 需要基础库: `2.10.3`
  13318. *
  13319. * 监听当前外围设备被连接或断开连接事件 */
  13320. onBLEPeripheralConnectionStateChanged(
  13321. /** 当前外围设备被连接或断开连接事件的回调函数 */
  13322. callback: OnBLEPeripheralConnectionStateChangedCallback
  13323. ): void
  13324. /** [wx.onBeaconServiceChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.onBeaconServiceChange.html)
  13325. *
  13326. * 需要基础库: `2.9.2`
  13327. *
  13328. * 监听 Beacon 服务状态变化事件,仅能注册一个监听 */
  13329. onBeaconServiceChange(
  13330. /** Beacon 服务状态变化事件的回调函数 */
  13331. callback: OnBeaconServiceChangeCallback
  13332. ): void
  13333. /** [wx.onBeaconUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.onBeaconUpdate.html)
  13334. *
  13335. * 需要基础库: `2.9.2`
  13336. *
  13337. * 监听 Beacon 设备更新事件,仅能注册一个监听 */
  13338. onBeaconUpdate(
  13339. /** Beacon 设备更新事件的回调函数 */
  13340. callback: OnBeaconUpdateCallback
  13341. ): void
  13342. /** [wx.onBluetoothAdapterStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.onBluetoothAdapterStateChange.html)
  13343. *
  13344. * 需要基础库: `2.9.2`
  13345. *
  13346. * 监听蓝牙适配器状态变化事件
  13347. *
  13348. * **示例代码**
  13349. *
  13350. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13351. * ```js
  13352. wx.onBluetoothAdapterStateChange(function (res) {
  13353. console.log('adapterState changed, now is', res)
  13354. })
  13355. ``` */
  13356. onBluetoothAdapterStateChange(
  13357. /** 蓝牙适配器状态变化事件的回调函数 */
  13358. callback: OnBluetoothAdapterStateChangeCallback
  13359. ): void
  13360. /** [wx.onBluetoothDeviceFound(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.onBluetoothDeviceFound.html)
  13361. *
  13362. * 需要基础库: `2.9.2`
  13363. *
  13364. * 监听搜索到新设备的事件
  13365. *
  13366. * **注意**
  13367. *
  13368. * - 若在 [wx.onBluetoothDeviceFound](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.onBluetoothDeviceFound.html) 回调了某个设备,则此设备会添加到 [wx.getBluetoothDevices](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getBluetoothDevices.html) 接口获取到的数组中。
  13369. *
  13370. * **示例代码**
  13371. *
  13372. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13373. *
  13374. * ```js
  13375. // ArrayBuffer转16进度字符串示例
  13376. function ab2hex(buffer) {
  13377. var hexArr = Array.prototype.map.call(
  13378. new Uint8Array(buffer),
  13379. function(bit) {
  13380. return ('00' + bit.toString(16)).slice(-2)
  13381. }
  13382. )
  13383. return hexArr.join('');
  13384. }
  13385. wx.onBluetoothDeviceFound(function(res) {
  13386. var devices = res.devices;
  13387. console.log('new device list has founded')
  13388. console.dir(devices)
  13389. console.log(ab2hex(devices[0].advertisData))
  13390. })
  13391. ```
  13392. *
  13393. * **注意**
  13394. *
  13395. * - 蓝牙设备在被搜索到时,系统返回的 `name` 字段一般为广播包中的 `LocalName` 字段中的设备名称,而如果与蓝牙设备建立连接,系统返回的 `name` 字段会改为从蓝牙设备上获取到的 `GattName`。若需要动态改变设备名称并展示,建议使用 `localName` 字段。
  13396. * - 安卓下部分机型需要有位置权限才能搜索到设备,需留意是否开启了位置权限 */
  13397. onBluetoothDeviceFound(
  13398. /** 搜索到新设备的事件的回调函数 */
  13399. callback: OnBluetoothDeviceFoundCallback
  13400. ): void
  13401. /** [wx.onCompassChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.onCompassChange.html)
  13402. *
  13403. * 监听罗盘数据变化事件。频率:5 次/秒,接口调用后会自动开始监听,可使用 wx.stopCompass 停止监听。
  13404. *
  13405. * **accuracy 在 iOS/Android 的差异**
  13406. *
  13407. * 由于平台差异,accuracy 在 iOS/Android 的值不同。
  13408. *
  13409. * - iOS:accuracy 是一个 number 类型的值,表示相对于磁北极的偏差。0 表示设备指向磁北,90 表示指向东,180 表示指向南,依此类推。
  13410. * - Android:accuracy 是一个 string 类型的枚举值。
  13411. *
  13412. * | 值 | 说明 |
  13413. * | --------------- | -------------------------------------------------------------------------------------- |
  13414. * | high | 高精度 |
  13415. * | medium | 中等精度 |
  13416. * | low | 低精度 |
  13417. * | no-contact | 不可信,传感器失去连接 |
  13418. * | unreliable | 不可信,原因未知 |
  13419. * | unknow ${value} | 未知的精度枚举值,即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值 | */
  13420. onCompassChange(
  13421. /** 罗盘数据变化事件的回调函数 */
  13422. callback: OnCompassChangeCallback
  13423. ): void
  13424. /** [wx.onCopyUrl(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onCopyUrl.html)
  13425. *
  13426. * 需要基础库: `2.14.3`
  13427. *
  13428. * 监听用户点击右上角菜单的「复制链接」按钮时触发的事件。本接口为 Beta 版本,暂只在 Android 平台支持。 */
  13429. onCopyUrl(
  13430. /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
  13431. callback: OnCopyUrlCallback
  13432. ): void
  13433. /** [wx.onDeviceMotionChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.onDeviceMotionChange.html)
  13434. *
  13435. * 需要基础库: `2.3.0`
  13436. *
  13437. * 监听设备方向变化事件。频率根据 [wx.startDeviceMotionListening()](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.startDeviceMotionListening.html) 的 interval 参数。可以使用 [wx.stopDeviceMotionListening()](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.stopDeviceMotionListening.html) 停止监听。 */
  13438. onDeviceMotionChange(
  13439. /** 设备方向变化事件的回调函数 */
  13440. callback: OnDeviceMotionChangeCallback
  13441. ): void
  13442. /** [wx.onDeviceOrientationChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/orientation/wx.onDeviceOrientationChange.html)
  13443. *
  13444. * 需要基础库: `2.1.0`
  13445. *
  13446. * 监听横竖屏切换事件 */
  13447. onDeviceOrientationChange(
  13448. /** 横竖屏切换事件的回调函数 */
  13449. callback: OnDeviceOrientationChangeCallback
  13450. ): void
  13451. /** [wx.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onError.html)
  13452. *
  13453. * 监听全局错误事件 */
  13454. onError(
  13455. /** 全局错误事件的回调函数 */
  13456. callback: WxOnErrorCallback
  13457. ): void
  13458. /** [wx.onGyroscopeChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.onGyroscopeChange.html)
  13459. *
  13460. * 需要基础库: `2.3.0`
  13461. *
  13462. * 监听陀螺仪数据变化事件。频率根据 [wx.startGyroscope()](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.startGyroscope.html) 的 interval 参数。可以使用 [wx.stopGyroscope()](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.stopGyroscope.html) 停止监听。 */
  13463. onGyroscopeChange(
  13464. /** 陀螺仪数据变化事件的回调函数 */
  13465. callback: OnGyroscopeChangeCallback
  13466. ): void
  13467. /** [wx.onHandoff(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onHandoff.html)
  13468. *
  13469. * 需要基础库: `2.14.4`
  13470. *
  13471. * 监听用户点击菜单「在电脑上打开」按钮时触发的事件 */
  13472. onHandoff(
  13473. /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
  13474. callback: OnHandoffCallback
  13475. ): void
  13476. /** [wx.onHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onHide.html)
  13477. *
  13478. * 监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。 */
  13479. onHide(
  13480. /** 小游戏隐藏到后台事件的回调函数 */
  13481. callback: OnHideCallback
  13482. ): void
  13483. /** [wx.onInteractiveStorageModified(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.onInteractiveStorageModified.html)
  13484. *
  13485. * 需要基础库: `2.9.0`
  13486. *
  13487. * 监听成功修改好友的互动型托管数据事件,该接口在游戏主域使用 */
  13488. onInteractiveStorageModified(
  13489. /** 事件发生的回调函数,只有一个参数为 `wx.modifyFriendInteractiveStorage` 传入的 key */
  13490. callback: (...args: any[]) => any
  13491. ): void
  13492. /** [wx.onKeyDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyDown.html)
  13493. *
  13494. * 需要基础库: `2.10.1`
  13495. *
  13496. * 监听键盘按键按下事件,仅适用于 PC 平台 */
  13497. onKeyDown(
  13498. /** 键盘按键按下事件的回调函数 */
  13499. callback: OnKeyDownCallback
  13500. ): void
  13501. /** [wx.onKeyUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyUp.html)
  13502. *
  13503. * 需要基础库: `2.10.1`
  13504. *
  13505. * 监听键盘按键弹起事件,仅适用于 PC 平台 */
  13506. onKeyUp(
  13507. /** 键盘按键弹起事件的回调函数 */
  13508. callback: OnKeyUpCallback
  13509. ): void
  13510. /** [wx.onKeyboardComplete(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardComplete.html)
  13511. *
  13512. * 监听监听键盘收起的事件 */
  13513. onKeyboardComplete(
  13514. /** 监听键盘收起的事件的回调函数 */
  13515. callback: OnKeyboardCompleteCallback
  13516. ): void
  13517. /** [wx.onKeyboardConfirm(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardConfirm.html)
  13518. *
  13519. * 监听用户点击键盘 Confirm 按钮时的事件 */
  13520. onKeyboardConfirm(
  13521. /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
  13522. callback: OnKeyboardConfirmCallback
  13523. ): void
  13524. /** [wx.onKeyboardHeightChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardHeightChange.html)
  13525. *
  13526. * 需要基础库: `2.21.3`
  13527. *
  13528. * 监听键盘高度变化
  13529. *
  13530. * **示例代码**
  13531. *
  13532. * ```js
  13533. wx.onKeyboardHeightChange(res => {
  13534. console.log(res.height)
  13535. })
  13536. ``` */
  13537. onKeyboardHeightChange(callback: OnKeyboardHeightChangeCallback): void
  13538. /** [wx.onKeyboardInput(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardInput.html)
  13539. *
  13540. * 监听键盘输入事件 */
  13541. onKeyboardInput(
  13542. /** 键盘输入事件的回调函数 */
  13543. callback: OnKeyboardInputCallback
  13544. ): void
  13545. /** [wx.onMemoryWarning(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/memory/wx.onMemoryWarning.html)
  13546. *
  13547. * 需要基础库: `2.0.2`
  13548. *
  13549. * 监听内存不足告警事件。
  13550. *
  13551. * 当 iOS/Android 向小程序进程发出内存警告时,触发该事件。触发该事件不意味小程序被杀,大部分情况下仅仅是告警,开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。
  13552. *
  13553. * **示例代码**
  13554. *
  13555. * ```js
  13556. * wx.onMemoryWarning(function () {
  13557. * console.log('onMemoryWarningReceive')
  13558. * })
  13559. * `` */
  13560. onMemoryWarning(
  13561. /** 内存不足告警事件的回调函数 */
  13562. callback: OnMemoryWarningCallback
  13563. ): void
  13564. /** [wx.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/context/wx.onMessage.html)
  13565. *
  13566. * 监听主域发送的消息 */
  13567. onMessage(
  13568. /** 监听事件的回调函数 */
  13569. callback: (...args: any[]) => any
  13570. ): void
  13571. /** [wx.onMouseDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.onMouseDown.html)
  13572. *
  13573. * 监听鼠标按键按下事件 */
  13574. onMouseDown(
  13575. /** 鼠标按键按下事件的回调函数 */
  13576. callback: OnMouseDownCallback
  13577. ): void
  13578. /** [wx.onMouseMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.onMouseMove.html)
  13579. *
  13580. * 监听鼠标移动事件 */
  13581. onMouseMove(
  13582. /** 鼠标移动事件的回调函数 */
  13583. callback: OnMouseMoveCallback
  13584. ): void
  13585. /** [wx.onMouseUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.onMouseUp.html)
  13586. *
  13587. * 监听鼠标按键弹起事件 */
  13588. onMouseUp(
  13589. /** 鼠标按键弹起事件的回调函数 */
  13590. callback: OnMouseUpCallback
  13591. ): void
  13592. /** [wx.onNetworkStatusChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.onNetworkStatusChange.html)
  13593. *
  13594. * 需要基础库: `1.1.0`
  13595. *
  13596. * 监听网络状态变化事件
  13597. *
  13598. * **示例代码**
  13599. *
  13600. * ```js
  13601. wx.onNetworkStatusChange(function (res) {
  13602. console.log(res.isConnected)
  13603. console.log(res.networkType)
  13604. })
  13605. ``` */
  13606. onNetworkStatusChange(
  13607. /** 网络状态变化事件的回调函数 */
  13608. callback: OnNetworkStatusChangeCallback
  13609. ): void
  13610. /** [wx.onNetworkWeakChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.onNetworkWeakChange.html)
  13611. *
  13612. * 需要基础库: `2.21.0`
  13613. *
  13614. * 监听弱网状态变化事件
  13615. *
  13616. * **示例代码**
  13617. *
  13618. * ```js
  13619. wx.onNetworkWeakChange(function (res) {
  13620. console.log(res.weakNet)
  13621. console.log(res.networkType)
  13622. })
  13623. // 取消监听
  13624. wx.offNetworkWeakChange()
  13625. ``` */
  13626. onNetworkWeakChange(
  13627. /** 弱网状态变化事件的回调函数 */
  13628. callback: OnNetworkWeakChangeCallback
  13629. ): void
  13630. /** [wx.onShareAppMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onShareAppMessage.html)
  13631. *
  13632. * 监听用户点击右上角菜单的「转发」按钮时触发的事件 */
  13633. onShareAppMessage(
  13634. /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
  13635. callback: OnShareAppMessageCallback
  13636. ): void
  13637. /** [wx.onShareMessageToFriend(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onShareMessageToFriend.html)
  13638. *
  13639. * 需要基础库: `2.9.4`
  13640. *
  13641. * 监听主域接收 `wx.shareMessageToFriend` 接口的成功失败通知 */
  13642. onShareMessageToFriend(
  13643. /** 的回调函数 */
  13644. callback: OnShareMessageToFriendCallback
  13645. ): void
  13646. /** [wx.onShareTimeline(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onShareTimeline.html)
  13647. *
  13648. * 需要基础库: `2.11.3`
  13649. *
  13650. * 监听用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件。本接口为 Beta 版本,暂只在 Android 平台支持。 */
  13651. onShareTimeline(
  13652. /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
  13653. callback: OnShareTimelineCallback
  13654. ): void
  13655. /** [wx.onShow(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onShow.html)
  13656. *
  13657. * 监听小游戏回到前台的事件 */
  13658. onShow(
  13659. /** 小游戏回到前台的事件的回调函数 */
  13660. callback: OnShowCallback
  13661. ): void
  13662. /** [wx.onSocketClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketClose.html)
  13663. *
  13664. * 监听 WebSocket 连接关闭事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
  13665. onSocketClose(
  13666. /** WebSocket 连接关闭事件的回调函数 */
  13667. callback: OnSocketCloseCallback
  13668. ): void
  13669. /** [wx.onSocketError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketError.html)
  13670. *
  13671. * 监听 WebSocket 错误事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
  13672. onSocketError(
  13673. /** WebSocket 错误事件的回调函数 */
  13674. callback: OnSocketErrorCallback
  13675. ): void
  13676. /** [wx.onSocketMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketMessage.html)
  13677. *
  13678. * 监听 WebSocket 接受到服务器的消息事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
  13679. onSocketMessage(
  13680. /** WebSocket 接受到服务器的消息事件的回调函数 */
  13681. callback: OnSocketMessageCallback
  13682. ): void
  13683. /** [wx.onSocketOpen(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketOpen.html)
  13684. *
  13685. * 监听 WebSocket 连接打开事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
  13686. onSocketOpen(
  13687. /** WebSocket 连接打开事件的回调函数 */
  13688. callback: OnSocketOpenCallback
  13689. ): void
  13690. /** [wx.onTouchCancel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchCancel.html)
  13691. *
  13692. * 监听触点失效事件 */
  13693. onTouchCancel(
  13694. /** 触点失效事件的回调函数 */
  13695. callback: OnTouchCancelCallback
  13696. ): void
  13697. /** [wx.onTouchEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchEnd.html)
  13698. *
  13699. * 监听触摸结束事件 */
  13700. onTouchEnd(
  13701. /** 触摸结束事件的回调函数 */
  13702. callback: OnTouchEndCallback
  13703. ): void
  13704. /** [wx.onTouchMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchMove.html)
  13705. *
  13706. * 监听触点移动事件 */
  13707. onTouchMove(
  13708. /** 触点移动事件的回调函数 */
  13709. callback: OnTouchMoveCallback
  13710. ): void
  13711. /** [wx.onTouchStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchStart.html)
  13712. *
  13713. * 监听开始触摸事件 */
  13714. onTouchStart(
  13715. /** 开始触摸事件的回调函数 */
  13716. callback: OnTouchStartCallback
  13717. ): void
  13718. /** [wx.onUnhandledRejection(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onUnhandledRejection.html)
  13719. *
  13720. * 需要基础库: `2.10.0`
  13721. *
  13722. * 监听未处理的 Promise 拒绝事件
  13723. *
  13724. * **注意**
  13725. *
  13726. * 安卓平台暂时不会派发该事件 */
  13727. onUnhandledRejection(
  13728. /** 未处理的 Promise 拒绝事件的回调函数 */
  13729. callback: OnUnhandledRejectionCallback
  13730. ): void
  13731. /** [wx.onUserCaptureScreen(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.onUserCaptureScreen.html)
  13732. *
  13733. * 需要基础库: `2.8.1`
  13734. *
  13735. * 监听用户主动截屏事件。用户使用系统截屏按键截屏时触发,只能注册一个监听
  13736. *
  13737. * **示例代码**
  13738. *
  13739. * ```js
  13740. wx.onUserCaptureScreen(function (res) {
  13741. console.log('用户截屏了')
  13742. })
  13743. ``` */
  13744. onUserCaptureScreen(
  13745. /** 用户主动截屏事件的回调函数 */
  13746. callback: OnUserCaptureScreenCallback
  13747. ): void
  13748. /** [wx.onVoIPChatInterrupted(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatInterrupted.html)
  13749. *
  13750. * 需要基础库: `2.7.0`
  13751. *
  13752. * 监听被动断开实时语音通话事件。包括小游戏切入后端时断开 */
  13753. onVoIPChatInterrupted(
  13754. /** 被动断开实时语音通话事件的回调函数 */
  13755. callback: OnVoIPChatInterruptedCallback
  13756. ): void
  13757. /** [wx.onVoIPChatMembersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatMembersChanged.html)
  13758. *
  13759. * 需要基础库: `2.7.0`
  13760. *
  13761. * 监听实时语音通话成员在线状态变化事件。有成员加入/退出通话时触发回调 */
  13762. onVoIPChatMembersChanged(
  13763. /** 实时语音通话成员在线状态变化事件的回调函数 */
  13764. callback: OnVoIPChatMembersChangedCallback
  13765. ): void
  13766. /** [wx.onVoIPChatSpeakersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatSpeakersChanged.html)
  13767. *
  13768. * 需要基础库: `2.7.0`
  13769. *
  13770. * 监听实时语音通话成员通话状态变化事件。有成员开始/停止说话时触发回调 */
  13771. onVoIPChatSpeakersChanged(
  13772. /** 实时语音通话成员通话状态变化事件的回调函数 */
  13773. callback: OnVoIPChatSpeakersChangedCallback
  13774. ): void
  13775. /** [wx.onVoIPChatStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatStateChanged.html)
  13776. *
  13777. * 需要基础库: `2.16.0`
  13778. *
  13779. * 监听房间状态变化事件。 */
  13780. onVoIPChatStateChanged(
  13781. /** 房间状态变化事件的回调函数 */
  13782. callback: OnVoIPChatStateChangedCallback
  13783. ): void
  13784. /** [wx.onWheel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/wheel-event/wx.onWheel.html)
  13785. *
  13786. * 监听鼠标滚轮事件 */
  13787. onWheel(
  13788. /** 鼠标滚轮事件的回调函数 */
  13789. callback: OnWheelCallback
  13790. ): void
  13791. /** [wx.onWindowResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ui/window/wx.onWindowResize.html)
  13792. *
  13793. * 监听窗口尺寸变化事件 */
  13794. onWindowResize(
  13795. /** 窗口尺寸变化事件的回调函数 */
  13796. callback: OnWindowResizeCallback
  13797. ): void
  13798. /** [wx.openBluetoothAdapter(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html)
  13799. *
  13800. * 需要基础库: `2.9.2`
  13801. *
  13802. * 初始化蓝牙模块。iOS 上开启主机/从机(外围设备)模式时需分别调用一次,并指定对应的 `mode`。
  13803. *
  13804. * **object.fail 回调函数返回的 state 参数(仅 iOS)**
  13805. *
  13806. * | 状态码 | 说明 |
  13807. * | ------ | ------ |
  13808. * | 0 | 未知 |
  13809. * | 1 | 重置中 |
  13810. * | 2 | 不支持 |
  13811. * | 3 | 未授权 |
  13812. * | 4 | 未开启 |
  13813. *
  13814. * **注意**
  13815. *
  13816. * - 其他蓝牙相关 API 必须在 [wx.openBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html) 调用之后使用。否则 API 会返回错误(errCode=10000)。
  13817. * - 在用户蓝牙开关未开启或者手机不支持蓝牙功能的情况下,调用 [wx.openBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html) 会返回错误(errCode=10001),表示手机蓝牙功能不可用。此时小程序蓝牙模块已经初始化完成,可通过 [wx.onBluetoothAdapterStateChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.onBluetoothAdapterStateChange.html) 监听手机蓝牙状态的改变,也可以调用蓝牙模块的所有API。
  13818. *
  13819. * **示例代码**
  13820. *
  13821. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13822. * ```js
  13823. wx.openBluetoothAdapter({
  13824. success (res) {
  13825. console.log(res)
  13826. }
  13827. })
  13828. ``` */
  13829. openBluetoothAdapter<
  13830. T extends OpenBluetoothAdapterOption = OpenBluetoothAdapterOption
  13831. >(
  13832. option?: T
  13833. ): PromisifySuccessResult<T, OpenBluetoothAdapterOption>
  13834. /** [wx.openCard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/card/wx.openCard.html)
  13835. *
  13836. * 需要基础库: `2.5.0`
  13837. *
  13838. * 查看微信卡包中的卡券。只有通过 [认证](https://developers.weixin.qq.com/miniprogram/product/renzheng.html) 的小程序或文化互动类目的小游戏才能使用。更多文档请参考 [微信卡券接口文档](https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&key=1490190158&version=1&lang=zh_CN&platform=2)。
  13839. *
  13840. * **示例代码**
  13841. *
  13842. * ```js
  13843. wx.openCard({
  13844. cardList: [{
  13845. cardId: '',
  13846. code: ''
  13847. }, {
  13848. cardId: '',
  13849. code: ''
  13850. }],
  13851. success (res) { }
  13852. })
  13853. ``` */
  13854. openCard<T extends OpenCardOption = OpenCardOption>(
  13855. option: T
  13856. ): PromisifySuccessResult<T, OpenCardOption>
  13857. /** [wx.openChannelsActivity(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsActivity.html)
  13858. *
  13859. * 需要基础库: `2.19.2`
  13860. *
  13861. * 打开视频号视频 */
  13862. openChannelsActivity(option: OpenChannelsActivityOption): void
  13863. /** [wx.openChannelsEvent(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsEvent.html)
  13864. *
  13865. * 需要基础库: `2.21.0`
  13866. *
  13867. * 打开视频号活动页 */
  13868. openChannelsEvent(option: OpenChannelsEventOption): void
  13869. /** [wx.openChannelsLive(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsLive.html)
  13870. *
  13871. * 需要基础库: `2.15.0`
  13872. *
  13873. * 打开视频号直播 */
  13874. openChannelsLive(option: OpenChannelsLiveOption): void
  13875. /** [wx.openChannelsUserProfile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsUserProfile.html)
  13876. *
  13877. * 需要基础库: `2.21.2`
  13878. *
  13879. * 打开视频号主页 */
  13880. openChannelsUserProfile(option: OpenChannelsUserProfileOption): void
  13881. /** [wx.openCustomerServiceConversation(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/customer-message/wx.openCustomerServiceConversation.html)
  13882. *
  13883. * 需要基础库: `2.0.3`
  13884. *
  13885. * 进入客服会话。要求在用户发生过至少一次 touch 事件后才能调用。后台接入方式与小程序一致,详见 [客服消息接入](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/customer-message.html) */
  13886. openCustomerServiceConversation<
  13887. T extends OpenCustomerServiceConversationOption = OpenCustomerServiceConversationOption
  13888. >(
  13889. option: T
  13890. ): PromisifySuccessResult<T, OpenCustomerServiceConversationOption>
  13891. /** [wx.openSetting(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.openSetting.html)
  13892. *
  13893. * 需要基础库: `1.1.0`
  13894. *
  13895. * 调起客户端小程序设置界面,返回用户设置的操作结果。**设置界面只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html)**。
  13896. *
  13897. * ****
  13898. *
  13899. * - 注意:[2.3.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始,用户发生点击行为后,才可以跳转打开设置页,管理授权信息。[详情](https://developers.weixin.qq.com/community/develop/doc/000cea2305cc5047af5733de751008)
  13900. *
  13901. * **示例代码**
  13902. *
  13903. * ```js
  13904. wx.openSetting({
  13905. success (res) {
  13906. console.log(res.authSetting)
  13907. // res.authSetting = {
  13908. // "scope.userInfo": true,
  13909. // "scope.userLocation": true
  13910. // }
  13911. }
  13912. })
  13913. ``` */
  13914. openSetting<T extends OpenSettingOption = OpenSettingOption>(
  13915. option?: T
  13916. ): PromisifySuccessResult<T, OpenSettingOption>
  13917. /** [wx.previewImage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.previewImage.html)
  13918. *
  13919. * 在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。
  13920. *
  13921. * **示例代码**
  13922. *
  13923. * ```js
  13924. wx.previewImage({
  13925. current: '', // 当前显示图片的http链接
  13926. urls: [] // 需要预览的图片http链接列表
  13927. })
  13928. ``` */
  13929. previewImage<T extends PreviewImageOption = PreviewImageOption>(
  13930. option: T
  13931. ): PromisifySuccessResult<T, PreviewImageOption>
  13932. /** [wx.previewMedia(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.previewMedia.html)
  13933. *
  13934. * 需要基础库: `2.12.0`
  13935. *
  13936. * 预览图片和视频。 */
  13937. previewMedia<T extends PreviewMediaOption = PreviewMediaOption>(
  13938. option: T
  13939. ): PromisifySuccessResult<T, PreviewMediaOption>
  13940. /** [wx.readBLECharacteristicValue(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.readBLECharacteristicValue.html)
  13941. *
  13942. * 需要基础库: `2.9.2`
  13943. *
  13944. * 读取蓝牙低功耗设备特征值的二进制数据。注意:必须设备的特征支持 read 才可以成功调用。
  13945. *
  13946. * **注意**
  13947. *
  13948. * - 并行调用多次会存在读失败的可能性。
  13949. * - 接口读取到的信息需要在 [wx.onBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html) 方法注册的回调中获取。
  13950. *
  13951. * **示例代码**
  13952. *
  13953. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  13954. * ```js
  13955. // 必须在这里的回调才能获取
  13956. wx.onBLECharacteristicValueChange(function(characteristic) {
  13957. console.log('characteristic value comed:', characteristic)
  13958. })
  13959. wx.readBLECharacteristicValue({
  13960. // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
  13961. deviceId,
  13962. // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取
  13963. serviceId,
  13964. // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取
  13965. characteristicId,
  13966. success (res) {
  13967. console.log('readBLECharacteristicValue:', res.errCode)
  13968. }
  13969. })
  13970. ``` */
  13971. readBLECharacteristicValue<
  13972. T extends ReadBLECharacteristicValueOption = ReadBLECharacteristicValueOption
  13973. >(
  13974. option: T
  13975. ): PromisifySuccessResult<T, ReadBLECharacteristicValueOption>
  13976. /** [wx.removeStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.removeStorage.html)
  13977. *
  13978. * 从本地缓存中移除指定 key。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
  13979. *
  13980. * **示例代码**
  13981. *
  13982. * ```js
  13983. wx.removeStorage({
  13984. key: 'key',
  13985. success (res) {
  13986. console.log(res)
  13987. }
  13988. })
  13989. ```
  13990. *
  13991. * ```js
  13992. try {
  13993. wx.removeStorageSync('key')
  13994. } catch (e) {
  13995. // Do something when catch error
  13996. }
  13997. ``` */
  13998. removeStorage<T extends RemoveStorageOption = RemoveStorageOption>(
  13999. option: T
  14000. ): PromisifySuccessResult<T, RemoveStorageOption>
  14001. /** [wx.removeStorageSync(string key)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.removeStorageSync.html)
  14002. *
  14003. * [wx.removeStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.removeStorage.html) 的同步版本
  14004. *
  14005. * **示例代码**
  14006. *
  14007. * ```js
  14008. wx.removeStorage({
  14009. key: 'key',
  14010. success (res) {
  14011. console.log(res)
  14012. }
  14013. })
  14014. ```
  14015. *
  14016. * ```js
  14017. try {
  14018. wx.removeStorageSync('key')
  14019. } catch (e) {
  14020. // Do something when catch error
  14021. }
  14022. ``` */
  14023. removeStorageSync(
  14024. /** 本地缓存中指定的 key */
  14025. key: string
  14026. ): void
  14027. /** [wx.removeUserCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.removeUserCloudStorage.html)
  14028. *
  14029. * 需要基础库: `1.9.92`
  14030. *
  14031. * 删除用户托管数据当中对应 key 的数据。 */
  14032. removeUserCloudStorage<
  14033. T extends RemoveUserCloudStorageOption = RemoveUserCloudStorageOption
  14034. >(
  14035. option: T
  14036. ): PromisifySuccessResult<T, RemoveUserCloudStorageOption>
  14037. /** [wx.reportEvent(string eventId, object data)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.reportEvent.html)
  14038. *
  14039. * 需要基础库: `2.14.4`
  14040. *
  14041. * 事件上报 */
  14042. reportEvent(
  14043. /** 在 mp 实验系统中设置的事件英文名 */
  14044. eventId: string,
  14045. /** 可被 JSON.stringily 的对象,将一起上报至系统 */
  14046. data?: IAnyObject
  14047. ): void
  14048. /** [wx.reportMonitor(string name, number value)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.reportMonitor.html)
  14049. *
  14050. * 需要基础库: `2.1.2`
  14051. *
  14052. * 自定义业务数据监控上报接口。
  14053. *
  14054. * **使用说明**
  14055. *
  14056. * 使用前,需要在「小程序管理后台-运维中心-性能监控-业务数据监控」中新建监控事件,配置监控描述与告警类型。每一个监控事件对应唯一的监控ID,开发者最多可以创建128个监控事件。
  14057. *
  14058. * **示例代码**
  14059. *
  14060. * ```js
  14061. wx.reportMonitor('1', 1)
  14062. ``` */
  14063. reportMonitor(
  14064. /** 监控ID,在「小程序管理后台」新建数据指标后获得 */
  14065. name: string,
  14066. /** 上报数值,经处理后会在「小程序管理后台」上展示每分钟的上报总量 */
  14067. value: number
  14068. ): void
  14069. /** [wx.reportPerformance(Number id, Number value, String|Array dimensions)](https://developers.weixin.qq.com/minigame/dev/api/base/performance/wx.reportPerformance.html)
  14070. *
  14071. * 需要基础库: `2.10.0`
  14072. *
  14073. * 小程序测速上报。使用前,需要在小程序管理后台配置。 详情参见[小程序测速](https://developers.weixin.qq.com/miniprogram/dev/framework/performanceReport/)指南。
  14074. *
  14075. * **示例代码**
  14076. *
  14077. * ```js
  14078. wx.reportPerformance(1101, 680)
  14079. wx.reportPerformance(1101, 680, 'custom')
  14080. ``` */
  14081. reportPerformance(
  14082. /** 指标 id */
  14083. id: number,
  14084. /** 需要上报的数值 */
  14085. value: number,
  14086. /** 自定义维度 (选填) */
  14087. dimensions?: string | any[]
  14088. ): void
  14089. /** [wx.reportUserBehaviorBranchAnalytics(Object object)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.reportUserBehaviorBranchAnalytics.html)
  14090. *
  14091. * 需要基础库: `2.12.0`
  14092. *
  14093. * 用于分支相关的UI组件(一般是按钮)相关事件的上报,事件目前有曝光、点击两种 */
  14094. reportUserBehaviorBranchAnalytics(
  14095. option: ReportUserBehaviorBranchAnalyticsOption
  14096. ): void
  14097. /** [wx.requestMidasFriendPayment(Object object)](https://developers.weixin.qq.com/minigame/dev/api/midas-payment/wx.requestMidasFriendPayment.html)
  14098. *
  14099. * 需要基础库: `2.11.0`
  14100. *
  14101. * 发起米大师朋友礼物索要。接口用法详见 [小游戏礼物索要接入指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/friend-payment.html)
  14102. *
  14103. * **示例代码**
  14104. *
  14105. * ```js
  14106. wx.requestMidasFriendPayment({
  14107. success(res) {
  14108. // res
  14109. {
  14110. errMsg: 'requestMidasFriendPayment:ok',
  14111. encryptedData: 'xxxx',
  14112. iv: 'xxx'
  14113. }
  14114. },
  14115. fail() {
  14116. }
  14117. })
  14118. ```
  14119. *
  14120. * encryptedData 解密后数据结构如下:
  14121. *
  14122. * ```json
  14123. {
  14124. "outTradeNo": "xxxxxxxx",
  14125. "orderNo": "PBgAAHMjeOhixxxx",
  14126. "watermark": {
  14127. "timestamp": 1585537091,
  14128. "appid": "wx7a727ff7d940xxxx"
  14129. }
  14130. }
  14131. ```
  14132. *
  14133. * **buyQuantity限制说明**
  14134. *
  14135. * 购买游戏币的时候,buyQuantity 不可任意填写。需满足 buyQuantity * 游戏币单价 = 限定的价格等级。如:游戏币单价为 0.1 元,一次购买最少数量是 10。
  14136. *
  14137. * 有效价格等级如下:
  14138. *
  14139. * | 价格等级(单位:人民币) |
  14140. * |----------------------|
  14141. * | 1 |
  14142. * | 3 |
  14143. * | 6 |
  14144. * | 8 |
  14145. * | 12 |
  14146. * | 18 |
  14147. * | 25 |
  14148. * | 30 |
  14149. * | 40 |
  14150. * | 45 |
  14151. * | 50 |
  14152. * | 60 |
  14153. * | 68 |
  14154. * | 73 |
  14155. * | 78 |
  14156. * | 88 |
  14157. * | 98 |
  14158. * | 108 |
  14159. * | 118 |
  14160. * | 128 |
  14161. * | 148 |
  14162. * | 168 |
  14163. * | 188 |
  14164. * | 198 |
  14165. * | 328 |
  14166. * | 648 |
  14167. * | 998 |
  14168. * | 1998 |
  14169. * | 2998 | */
  14170. requestMidasFriendPayment(option: RequestMidasFriendPaymentOption): void
  14171. /** [wx.requestMidasPayment(Object object)](https://developers.weixin.qq.com/minigame/dev/api/midas-payment/wx.requestMidasPayment.html)
  14172. *
  14173. * 发起米大师支付
  14174. *
  14175. * **buyQuantity 限制说明**
  14176. *
  14177. * 购买游戏币的时候,buyQuantity 不可任意填写。需满足 buyQuantity * 游戏币单价 = 限定的价格等级。如:游戏币单价为 0.1 元,一次购买最少数量是 10。
  14178. *
  14179. * 有效价格等级如下:
  14180. *
  14181. * | 价格等级(单位:人民币) |
  14182. * |----------------------|
  14183. * | 1 |
  14184. * | 3 |
  14185. * | 6 |
  14186. * | 8 |
  14187. * | 12 |
  14188. * | 18 |
  14189. * | 25 |
  14190. * | 30 |
  14191. * | 40 |
  14192. * | 45 |
  14193. * | 50 |
  14194. * | 60 |
  14195. * | 68 |
  14196. * | 73 |
  14197. * | 78 |
  14198. * | 88 |
  14199. * | 98 |
  14200. * | 108 |
  14201. * | 118 |
  14202. * | 128 |
  14203. * | 148 |
  14204. * | 168 |
  14205. * | 188 |
  14206. * | 198 |
  14207. * | 328 |
  14208. * | 648 |
  14209. * | 998 |
  14210. * | 1998 |
  14211. * | 2998 | */
  14212. requestMidasPayment<
  14213. T extends RequestMidasPaymentOption = RequestMidasPaymentOption
  14214. >(
  14215. option: T
  14216. ): PromisifySuccessResult<T, RequestMidasPaymentOption>
  14217. /** [wx.requestSubscribeMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html)
  14218. *
  14219. * 需要基础库: `2.4.4`
  14220. *
  14221. * 调起客户端小游戏订阅消息界面,返回用户订阅消息的操作结果。当用户勾选了订阅面板中的“总是保持以上选择,不再询问”时,模板消息会被添加到用户的小游戏设置页,通过 [wx.getSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html) 接口可获取用户对相关模板消息的订阅状态。
  14222. *
  14223. * ## 注意事项
  14224. * - 一次性模板 id 和永久模板 id 不可同时使用。
  14225. * - 低版本基础库2.4.4~2.8.3 已支持订阅消息接口调用,仅支持传入一个一次性 tmplId / 永久 tmplId。
  14226. * - [2.8.2](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始,用户发生点击行为或者发起支付回调后,才可以调起订阅消息界面。
  14227. * - [2.10.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始,开发版和体验版小游戏将禁止使用模板消息 fomrId。
  14228. * - 使用前建议阅读 [小游戏订阅消息使用指引](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/subscribe-message.html)。
  14229. * - 一次授权调用里,每个tmplId对应的模板标题不能存在相同的,若出现相同的,只保留一个。
  14230. *
  14231. * **错误码**
  14232. *
  14233. * | errCode | errMsg | 说明 |
  14234. * | ------- | ------------------------------------------------------ | -------------------------------------------------------------- |
  14235. * | 10001 | TmplIds can't be empty | 参数传空了 |
  14236. * | 10002 | Request list fail | 网络问题,请求消息列表失败 |
  14237. * | 10003 | Request subscribe fail | 网络问题,订阅请求发送失败 |
  14238. * | 10004 | Invalid template id | 参数类型错误 |
  14239. * | 10005 | Cannot show subscribe message UI | 无法展示 UI,一般是小游戏这个时候退后台了导致的 |
  14240. * | 20001 | No template data return, verify the template id exist | 没有模板数据,一般是模板 ID 不存在 或者和模板类型不对应 导致的 |
  14241. * | 20002 | Templates type must be same | 模板消息类型 既有一次性的又有永久的 |
  14242. * | 20003 | Templates count out of max bounds | 模板消息数量超过上限 |
  14243. * | 20004 | The main switch is switched off | 用户关闭了主开关,无法进行订阅 |
  14244. * | 20005 | This mini program was banned from subscribing messages | 小游戏被禁封 |
  14245. *
  14246. * **示例代码**
  14247. *
  14248. * ```js
  14249. wx.requestSubscribeMessage({
  14250. tmplIds: [''],
  14251. success (res) {
  14252. console.log(res)
  14253. res === {
  14254. errMsg: "requestSubscribeMessage:ok",
  14255. "zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE": "accept"
  14256. }
  14257. }
  14258. })
  14259. ``` */
  14260. requestSubscribeMessage<
  14261. T extends RequestSubscribeMessageOption = RequestSubscribeMessageOption
  14262. >(
  14263. option: T
  14264. ): PromisifySuccessResult<T, RequestSubscribeMessageOption>
  14265. /** [wx.requestSubscribeSystemMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeSystemMessage.html)
  14266. *
  14267. * 需要基础库: `2.9.4`
  14268. *
  14269. * 调起小游戏系统订阅消息界面,返回用户订阅消息的操作结果。当用户勾选了订阅面板中的“总是保持以上选择,不再询问”时,模板消息会被添加到用户的小游戏设置页,通过 [wx.getSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html) 接口可获取用户对相关模板消息的订阅状态。
  14270. *
  14271. * ## 注意事项
  14272. * - 需要在 touchend 事件的回调中调用。
  14273. * - 使用前建议阅读 [小游戏系统订阅消息使用指引](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/subscribe-system-message.html)。
  14274. * - 系统订阅消息只需要订阅一次,永久有效。
  14275. *
  14276. * **错误码**
  14277. *
  14278. * | errCode | errMsg | 说明 |
  14279. * | ------- | ------------------------------------------------------ | -------------------------------------------------------------- |
  14280. * | 10001 | TmplIds can't be empty | 参数传空了 |
  14281. * | 10002 | Request list fail | 网络问题,请求消息列表失败 |
  14282. * | 10003 | Request subscribe fail | 网络问题,订阅请求发送失败 |
  14283. * | 10004 | Invalid template id | 参数类型错误 |
  14284. * | 10005 | Cannot show subscribe message UI | 无法展示 UI,一般是小游戏这个时候退后台了导致的 |
  14285. * | 20004 | The main switch is switched off | 用户关闭了主开关,无法进行订阅 |
  14286. * | 20005 | This mini program was banned from subscribing messages | 小游戏被禁封 |
  14287. *
  14288. * **示例代码**
  14289. *
  14290. * ```js
  14291. wx.requestSubscribeSystemMessage({
  14292. msgTypeList: ['SYS_MSG_TYPE_INTERACTIVE', 'SYS_MSG_TYPE_RANK'],
  14293. success (res) {
  14294. console.log(res)
  14295. // res === {
  14296. // errMsg: "requestSubscribeSystemMessage:ok",
  14297. // SYS_MSG_TYPE_INTERACTIVE: "accept",
  14298. // SYS_MSG_TYPE_RANK: 'reject'
  14299. // }
  14300. }
  14301. })
  14302. ``` */
  14303. requestSubscribeSystemMessage<
  14304. T extends RequestSubscribeSystemMessageOption = RequestSubscribeSystemMessageOption
  14305. >(
  14306. option: T
  14307. ): PromisifySuccessResult<T, RequestSubscribeSystemMessageOption>
  14308. /** [wx.reserveChannelsLive(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.reserveChannelsLive.html)
  14309. *
  14310. * 需要基础库: `2.19.0`
  14311. *
  14312. * 预约视频号直播 */
  14313. reserveChannelsLive(option: ReserveChannelsLiveOption): void
  14314. /** [wx.revokeBufferURL(string url)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.revokeBufferURL.html)
  14315. *
  14316. * 需要基础库: `2.14.0`
  14317. *
  14318. * 根据 URL 销毁存在内存中的数据 */
  14319. revokeBufferURL(
  14320. /** 需要销毁的二进制数据 URL */
  14321. url: string
  14322. ): void
  14323. /** [wx.saveFileToDisk(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/wx.saveFileToDisk.html)
  14324. *
  14325. * 需要基础库: `2.11.0`
  14326. *
  14327. * 保存文件系统的文件到用户磁盘,仅在 PC 端支持
  14328. *
  14329. * **示例代码**
  14330. *
  14331. * ```js
  14332. wx.saveFileToDisk({
  14333. filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
  14334. success(res) {
  14335. console.log(res)
  14336. },
  14337. fail(res) {
  14338. console.error(res)
  14339. }
  14340. })
  14341. ``` */
  14342. saveFileToDisk(option: SaveFileToDiskOption): void
  14343. /** [wx.saveImageToPhotosAlbum(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.saveImageToPhotosAlbum.html)
  14344. *
  14345. * 需要基础库: `1.2.0`
  14346. *
  14347. * 保存图片到系统相册。
  14348. *
  14349. * **示例代码**
  14350. *
  14351. * ```js
  14352. wx.saveImageToPhotosAlbum({
  14353. success(res) { }
  14354. })
  14355. ``` */
  14356. saveImageToPhotosAlbum<
  14357. T extends SaveImageToPhotosAlbumOption = SaveImageToPhotosAlbumOption
  14358. >(
  14359. option: T
  14360. ): PromisifySuccessResult<T, SaveImageToPhotosAlbumOption>
  14361. /** [wx.scanCode(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/scan/wx.scanCode.html)
  14362. *
  14363. * 需要基础库: `2.16.1`
  14364. *
  14365. * 调起客户端扫码界面进行扫码
  14366. *
  14367. * **示例代码**
  14368. *
  14369. * ```js
  14370. // 允许从相机和相册扫码
  14371. wx.scanCode({
  14372. success (res) {
  14373. console.log(res)
  14374. }
  14375. })
  14376. // 只允许从相机扫码
  14377. wx.scanCode({
  14378. onlyFromCamera: true,
  14379. success (res) {
  14380. console.log(res)
  14381. }
  14382. })
  14383. ``` */
  14384. scanCode<T extends ScanCodeOption = ScanCodeOption>(
  14385. option: T
  14386. ): PromisifySuccessResult<T, ScanCodeOption>
  14387. /** [wx.sendSocketMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.sendSocketMessage.html)
  14388. *
  14389. * 通过 WebSocket 连接发送数据。需要先 wx.connectSocket,并在 wx.onSocketOpen 回调之后才能发送。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。**
  14390. *
  14391. * **示例代码**
  14392. *
  14393. * ```js
  14394. let socketOpen = false
  14395. let socketMsgQueue = []
  14396. wx.connectSocket({
  14397. url: 'test.php'
  14398. })
  14399. wx.onSocketOpen(function(res) {
  14400. socketOpen = true
  14401. for (let i = 0; i < socketMsgQueue.length; i++){
  14402. sendSocketMessage(socketMsgQueue[i])
  14403. }
  14404. socketMsgQueue = []
  14405. })
  14406. function sendSocketMessage(msg) {
  14407. if (socketOpen) {
  14408. wx.sendSocketMessage({
  14409. data:msg
  14410. })
  14411. } else {
  14412. socketMsgQueue.push(msg)
  14413. }
  14414. }
  14415. ``` */
  14416. sendSocketMessage<
  14417. T extends SendSocketMessageOption = SendSocketMessageOption
  14418. >(
  14419. option: T
  14420. ): PromisifySuccessResult<T, SendSocketMessageOption>
  14421. /** [wx.setBLEMTU(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.setBLEMTU.html)
  14422. *
  14423. * 需要基础库: `2.11.0`
  14424. *
  14425. * 协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU)。需在 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 调用成功后调用。仅安卓系统 5.1 以上版本有效,iOS 因系统限制不支持。 */
  14426. setBLEMTU<T extends SetBLEMTUOption = SetBLEMTUOption>(
  14427. option: T
  14428. ): PromisifySuccessResult<T, SetBLEMTUOption>
  14429. /** [wx.setClipboardData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/clipboard/wx.setClipboardData.html)
  14430. *
  14431. * 需要基础库: `1.1.0`
  14432. *
  14433. * 设置系统剪贴板的内容。调用成功后,会弹出 toast 提示"内容已复制",持续 1.5s
  14434. *
  14435. * **示例代码**
  14436. *
  14437. * ```js
  14438. wx.setClipboardData({
  14439. data: 'data',
  14440. success (res) {
  14441. wx.getClipboardData({
  14442. success (res) {
  14443. console.log(res.data) // data
  14444. }
  14445. })
  14446. }
  14447. })
  14448. ``` */
  14449. setClipboardData<
  14450. T extends SetClipboardDataOption = SetClipboardDataOption
  14451. >(
  14452. option: T
  14453. ): PromisifySuccessResult<T, SetClipboardDataOption>
  14454. /** [wx.setEnableDebug(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/wx.setEnableDebug.html)
  14455. *
  14456. * 需要基础库: `1.4.0`
  14457. *
  14458. * 设置是否打开调试开关。此开关对正式版也能生效。
  14459. *
  14460. * **示例代码**
  14461. *
  14462. * ```javascript
  14463. // 打开调试
  14464. wx.setEnableDebug({
  14465. enableDebug: true
  14466. })
  14467. // 关闭调试
  14468. wx.setEnableDebug({
  14469. enableDebug: false
  14470. })
  14471. ```
  14472. *
  14473. * **Tips**
  14474. *
  14475. * - 在正式版打开调试还有一种方法,就是先在开发版或体验版打开调试,再切到正式版就能看到vConsole。 */
  14476. setEnableDebug<T extends SetEnableDebugOption = SetEnableDebugOption>(
  14477. option: T
  14478. ): PromisifySuccessResult<T, SetEnableDebugOption>
  14479. /** [wx.setInnerAudioOption(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.setInnerAudioOption.html)
  14480. *
  14481. * 需要基础库: `2.3.0`
  14482. *
  14483. * 设置 [InnerAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.html) 的播放选项。设置之后对当前小程序全局生效。
  14484. *
  14485. * ****
  14486. *
  14487. * ## 注意事项
  14488. * - 为保证微信整体体验,speakerOn 为 true 时,客户端会忽略 mixWithOthers 参数的内容,强制与其它音频互斥
  14489. * - 不支持在播放音频的过程中切换为扬声器播放,开发者如需切换可以先暂停当前播放的音频并记录下当前暂停的时间点,然后切换后重新从原来暂停的时间点开始播放音频
  14490. * - 目前 wx.setInnerAudioOption 接口不兼容 wx.createWebAudioContext 接口,也不兼容 wx.createInnerAudioContext 开启 useWebAudioImplement 的情况,将在后续版本中支持 */
  14491. setInnerAudioOption<
  14492. T extends SetInnerAudioOption = SetInnerAudioOption
  14493. >(
  14494. option: T
  14495. ): PromisifySuccessResult<T, SetInnerAudioOption>
  14496. /** [wx.setKeepScreenOn(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.setKeepScreenOn.html)
  14497. *
  14498. * 需要基础库: `1.4.0`
  14499. *
  14500. * 设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效。
  14501. *
  14502. * **示例代码**
  14503. *
  14504. * ```js
  14505. wx.setKeepScreenOn({
  14506. keepScreenOn: true
  14507. })
  14508. ``` */
  14509. setKeepScreenOn<
  14510. T extends SetKeepScreenOnOption = SetKeepScreenOnOption
  14511. >(
  14512. option: T
  14513. ): PromisifySuccessResult<T, SetKeepScreenOnOption>
  14514. /** [wx.setMenuStyle(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/menu/wx.setMenuStyle.html)
  14515. *
  14516. * 动态设置通过右上角按钮拉起的菜单的样式。 */
  14517. setMenuStyle<T extends SetMenuStyleOption = SetMenuStyleOption>(
  14518. option: T
  14519. ): PromisifySuccessResult<T, SetMenuStyleOption>
  14520. /** [wx.setPreferredFramesPerSecond(number fps)](https://developers.weixin.qq.com/minigame/dev/api/render/frame/wx.setPreferredFramesPerSecond.html)
  14521. *
  14522. * 可以修改渲染帧率。默认渲染帧率为 60 帧每秒。修改后,requestAnimationFrame 的回调频率会发生改变。 */
  14523. setPreferredFramesPerSecond(
  14524. /** 帧率,有效范围 1 - 60。 */
  14525. fps: number
  14526. ): void
  14527. /** [wx.setScreenBrightness(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.setScreenBrightness.html)
  14528. *
  14529. * 需要基础库: `1.2.0`
  14530. *
  14531. * 设置屏幕亮度 */
  14532. setScreenBrightness<
  14533. T extends SetScreenBrightnessOption = SetScreenBrightnessOption
  14534. >(
  14535. option: T
  14536. ): PromisifySuccessResult<T, SetScreenBrightnessOption>
  14537. /** [wx.setStatusBarStyle(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/statusbar/wx.setStatusBarStyle.html)
  14538. *
  14539. * 当在配置中设置 showStatusBarStyle 时,屏幕顶部会显示状态栏。此接口可以修改状态栏的样式。 */
  14540. setStatusBarStyle<
  14541. T extends SetStatusBarStyleOption = SetStatusBarStyleOption
  14542. >(
  14543. option: T
  14544. ): PromisifySuccessResult<T, SetStatusBarStyleOption>
  14545. /** [wx.setStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.setStorage.html)
  14546. *
  14547. * 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。
  14548. *
  14549. * **示例代码**
  14550. *
  14551. * ```js
  14552. wx.setStorage({
  14553. key:"key",
  14554. data:"value"
  14555. })
  14556. ```
  14557. * ```js
  14558. try {
  14559. wx.setStorageSync('key', 'value')
  14560. } catch (e) { }
  14561. ```
  14562. * ```js
  14563. // 开启加密存储
  14564. wx.setStorage({
  14565. key: "key",
  14566. data: "value",
  14567. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  14568. success() {
  14569. wx.getStorage({
  14570. key: "key",
  14571. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  14572. success(res) {
  14573. console.log(res.data)
  14574. }
  14575. })
  14576. }
  14577. })
  14578. ``` */
  14579. setStorage<
  14580. T = any,
  14581. U extends SetStorageOption<T> = SetStorageOption<T>
  14582. >(
  14583. option: U
  14584. ): PromisifySuccessResult<U, SetStorageOption<T>>
  14585. /** [wx.setStorageSync(string key, any data, Boolean encrypt)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.setStorageSync.html)
  14586. *
  14587. * [wx.setStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.setStorage.html) 的同步版本
  14588. *
  14589. * **示例代码**
  14590. *
  14591. * ```js
  14592. wx.setStorage({
  14593. key:"key",
  14594. data:"value"
  14595. })
  14596. ```
  14597. * ```js
  14598. try {
  14599. wx.setStorageSync('key', 'value')
  14600. } catch (e) { }
  14601. ```
  14602. * ```js
  14603. // 开启加密存储
  14604. wx.setStorage({
  14605. key: "key",
  14606. data: "value",
  14607. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  14608. success() {
  14609. wx.getStorage({
  14610. key: "key",
  14611. encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
  14612. success(res) {
  14613. console.log(res.data)
  14614. }
  14615. })
  14616. }
  14617. })
  14618. ``` */
  14619. setStorageSync<T = any>(
  14620. /** 本地缓存中指定的 key */
  14621. key: string,
  14622. /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
  14623. data: T,
  14624. /** 需要基础库: `2.21.3`
  14625. *
  14626. * 是否开启加密存储。只有异步的 setStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 加密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true。此外,由于加密后的数据会比原始数据膨胀1.4倍,因此开启 encrypt 的情况下,单个 key 允许存储的最大数据长度为 0.7MB,所有数据存储上限为 7.1MB */
  14627. encrypt?: boolean
  14628. ): void
  14629. /** [wx.setUserCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.setUserCloudStorage.html)
  14630. *
  14631. * 需要基础库: `1.9.92`
  14632. *
  14633. * 对用户托管数据进行写数据操作。允许同时写多组 KV 数据。
  14634. *
  14635. * **托管数据的限制**
  14636. *
  14637. * 1. 每个openid所标识的微信用户在每个游戏上托管的数据不能超过128个key-value对。
  14638. * 2. 上报的key-value列表当中每一项的key+value长度都不能超过1K(1024)字节。
  14639. * 3. 上报的key-value列表当中每一个key长度都不能超过128字节。 */
  14640. setUserCloudStorage<
  14641. T extends SetUserCloudStorageOption = SetUserCloudStorageOption
  14642. >(
  14643. option: T
  14644. ): PromisifySuccessResult<T, SetUserCloudStorageOption>
  14645. /** [wx.setWindowSize(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/window/wx.setWindowSize.html)
  14646. *
  14647. * 需要基础库: `2.10.1`
  14648. * @deprecated 基础库版本 [2.11.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
  14649. *
  14650. * 设置窗口大小,该接口仅适用于 PC 平台,使用细则请参见指南 */
  14651. setWindowSize(option: SetWindowSizeOption): void
  14652. /** [wx.shareAppMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.shareAppMessage.html)
  14653. *
  14654. * 主动拉起转发,进入选择通讯录界面。 */
  14655. shareAppMessage(option: ShareAppMessageOption): void
  14656. /** [wx.shareMessageToFriend(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.shareMessageToFriend.html)
  14657. *
  14658. * 需要基础库: `2.9.0`
  14659. *
  14660. * 给指定的好友分享游戏信息,该接口只可在开放数据域下使用。接收者打开之后,可以用 `wx.modifyFriendInteractiveStorage` 传入参数 quiet=true 发起一次无需弹框确认的好友互动。
  14661. *
  14662. * ****
  14663. *
  14664. * 定向分享不允许直接在开放数据域设置 query 参数
  14665. * 需要设置请参见游戏域 `wx.setMessageToFriendQuery` 接口 */
  14666. shareMessageToFriend(option: ShareMessageToFriendOption): void
  14667. /** [wx.showActionSheet(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showActionSheet.html)
  14668. *
  14669. * 显示操作菜单
  14670. *
  14671. * **示例代码**
  14672. *
  14673. * ```js
  14674. wx.showActionSheet({
  14675. itemList: ['A', 'B', 'C'],
  14676. success (res) {
  14677. console.log(res.tapIndex)
  14678. },
  14679. fail (res) {
  14680. console.log(res.errMsg)
  14681. }
  14682. })
  14683. ```
  14684. *
  14685. * **注意**
  14686. *
  14687. * - Android 6.7.2 以下版本,点击取消或蒙层时,回调 fail, errMsg 为 "fail cancel";
  14688. * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗,所以尽量避免使用「取消」分支中实现业务逻辑 */
  14689. showActionSheet<
  14690. T extends ShowActionSheetOption = ShowActionSheetOption
  14691. >(
  14692. option: T
  14693. ): PromisifySuccessResult<T, ShowActionSheetOption>
  14694. /** [wx.showKeyboard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.showKeyboard.html)
  14695. *
  14696. * 显示键盘 */
  14697. showKeyboard<T extends ShowKeyboardOption = ShowKeyboardOption>(
  14698. option: T
  14699. ): PromisifySuccessResult<T, ShowKeyboardOption>
  14700. /** [wx.showLoading(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showLoading.html)
  14701. *
  14702. * 需要基础库: `1.1.0`
  14703. *
  14704. * 显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框
  14705. *
  14706. * **示例代码**
  14707. *
  14708. * ```js
  14709. wx.showLoading({
  14710. title: '加载中',
  14711. })
  14712. setTimeout(function () {
  14713. wx.hideLoading()
  14714. }, 2000)
  14715. ```
  14716. *
  14717. * **注意**
  14718. *
  14719. * - [wx.showLoading](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showLoading.html) 和 [wx.showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 同时只能显示一个
  14720. * - [wx.showLoading](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showLoading.html) 应与 [wx.hideLoading](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.hideLoading.html) 配对使用 */
  14721. showLoading<T extends ShowLoadingOption = ShowLoadingOption>(
  14722. option: T
  14723. ): PromisifySuccessResult<T, ShowLoadingOption>
  14724. /** [wx.showModal(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showModal.html)
  14725. *
  14726. * 显示模态对话框
  14727. *
  14728. * **示例代码**
  14729. *
  14730. * ```js
  14731. wx.showModal({
  14732. title: '提示',
  14733. content: '这是一个模态弹窗',
  14734. success (res) {
  14735. if (res.confirm) {
  14736. console.log('用户点击确定')
  14737. } else if (res.cancel) {
  14738. console.log('用户点击取消')
  14739. }
  14740. }
  14741. })
  14742. ```
  14743. *
  14744. * **注意**
  14745. *
  14746. * - Android 6.7.2 以下版本,点击取消或蒙层时,回调 fail, errMsg 为 "fail cancel";
  14747. * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗,所以尽量避免使用「取消」分支中实现业务逻辑
  14748. * - 自基础库 2.17.1 版本起,支持传入 editable 参数,显示带输入框的弹窗 */
  14749. showModal<T extends ShowModalOption = ShowModalOption>(
  14750. option: T
  14751. ): PromisifySuccessResult<T, ShowModalOption>
  14752. /** [wx.showShareImageMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.showShareImageMenu.html)
  14753. *
  14754. * 需要基础库: `2.14.3`
  14755. *
  14756. * 打开分享图片弹窗,可以将图片发送给朋友、收藏或下载 */
  14757. showShareImageMenu<
  14758. T extends ShowShareImageMenuOption = ShowShareImageMenuOption
  14759. >(
  14760. option: T
  14761. ): PromisifySuccessResult<T, ShowShareImageMenuOption>
  14762. /** [wx.showShareMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.showShareMenu.html)
  14763. *
  14764. * 需要基础库: `1.1.0`
  14765. *
  14766. * 显示当前页面的转发按钮
  14767. *
  14768. * ****
  14769. *
  14770. * ## 注意事项
  14771. * - "shareAppMessage"表示“发送给朋友”按钮,"shareTimeline"表示“分享到朋友圈”按钮
  14772. * - 显示“分享到朋友圈”按钮时必须同时显示“发送给朋友”按钮,显示“发送给朋友”按钮时则允许不显示“分享到朋友圈”按钮
  14773. *
  14774. * **示例代码**
  14775. *
  14776. * ```js
  14777. wx.showShareMenu({
  14778. withShareTicket: true,
  14779. menus: ['shareAppMessage', 'shareTimeline']
  14780. })
  14781. ``` */
  14782. showShareMenu<T extends ShowShareMenuOption = ShowShareMenuOption>(
  14783. option: T
  14784. ): PromisifySuccessResult<T, ShowShareMenuOption>
  14785. /** [wx.showToast(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html)
  14786. *
  14787. * 显示消息提示框
  14788. *
  14789. * **示例代码**
  14790. *
  14791. * ```js
  14792. wx.showToast({
  14793. title: '成功',
  14794. icon: 'success',
  14795. duration: 2000
  14796. })
  14797. ```
  14798. *
  14799. * **注意**
  14800. *
  14801. * - [wx.showLoading](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showLoading.html) 和 [wx.showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 同时只能显示一个
  14802. * - [wx.showToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html) 应与 [wx.hideToast](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.hideToast.html) 配对使用 */
  14803. showToast<T extends ShowToastOption = ShowToastOption>(
  14804. option: T
  14805. ): PromisifySuccessResult<T, ShowToastOption>
  14806. /** [wx.startAccelerometer(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.startAccelerometer.html)
  14807. *
  14808. * 需要基础库: `1.1.0`
  14809. *
  14810. * 开始监听加速度数据。
  14811. *
  14812. * **示例代码**
  14813. *
  14814. * ```js
  14815. wx.startAccelerometer({
  14816. interval: 'game'
  14817. })
  14818. ```
  14819. *
  14820. * **注意**
  14821. *
  14822. * - 根据机型性能、当前 CPU 与内存的占用情况,`interval` 的设置与实际 `wx.onAccelerometerChange()` 回调函数的执行频率会有一些出入。 */
  14823. startAccelerometer<
  14824. T extends StartAccelerometerOption = StartAccelerometerOption
  14825. >(
  14826. option?: T
  14827. ): PromisifySuccessResult<T, StartAccelerometerOption>
  14828. /** [wx.startBeaconDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.startBeaconDiscovery.html)
  14829. *
  14830. * 需要基础库: `2.9.2`
  14831. *
  14832. * 开始搜索附近的 Beacon 设备
  14833. *
  14834. * **示例代码**
  14835. *
  14836. * ```js
  14837. wx.startBeaconDiscovery({
  14838. success(res) { }
  14839. })
  14840. ``` */
  14841. startBeaconDiscovery<
  14842. T extends StartBeaconDiscoveryOption = StartBeaconDiscoveryOption
  14843. >(
  14844. option: T
  14845. ): PromisifySuccessResult<T, StartBeaconDiscoveryOption>
  14846. /** [wx.startBluetoothDevicesDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.startBluetoothDevicesDiscovery.html)
  14847. *
  14848. * 需要基础库: `2.9.2`
  14849. *
  14850. * 开始搜寻附近的蓝牙外围设备。
  14851. *
  14852. * **此操作比较耗费系统资源,请在搜索到需要的设备后及时调用 [wx.stopBluetoothDevicesDiscovery](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.stopBluetoothDevicesDiscovery.html) 停止搜索。**
  14853. *
  14854. * **注意**
  14855. *
  14856. * - 考虑到蓝牙功能可以间接进行定位,安卓 6.0 及以上版本,无定位权限或定位开关未打开时,无法进行设备搜索。这种情况下,安卓 8.0.16 前,接口调用成功但无法扫描设备;8.0.16 及以上版本,会返回错误。
  14857. *
  14858. * **示例代码**
  14859. *
  14860. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/m7klFDmZ72i1)
  14861. *
  14862. * ```js
  14863. // 以微信硬件平台的蓝牙智能灯为例,主服务的 UUID 是 FEE7。传入这个参数,只搜索主服务 UUID 为 FEE7 的设备
  14864. wx.startBluetoothDevicesDiscovery({
  14865. services: ['FEE7'],
  14866. success (res) {
  14867. console.log(res)
  14868. }
  14869. })
  14870. ``` */
  14871. startBluetoothDevicesDiscovery<
  14872. T extends StartBluetoothDevicesDiscoveryOption = StartBluetoothDevicesDiscoveryOption
  14873. >(
  14874. option: T
  14875. ): PromisifySuccessResult<T, StartBluetoothDevicesDiscoveryOption>
  14876. /** [wx.startCompass(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.startCompass.html)
  14877. *
  14878. * 需要基础库: `1.1.0`
  14879. *
  14880. * 开始监听罗盘数据
  14881. *
  14882. * **示例代码**
  14883. *
  14884. * ```js
  14885. wx.startCompass()
  14886. ``` */
  14887. startCompass<T extends StartCompassOption = StartCompassOption>(
  14888. option?: T
  14889. ): PromisifySuccessResult<T, StartCompassOption>
  14890. /** [wx.startDeviceMotionListening(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.startDeviceMotionListening.html)
  14891. *
  14892. * 需要基础库: `2.3.0`
  14893. *
  14894. * 开始监听设备方向的变化。 */
  14895. startDeviceMotionListening<
  14896. T extends StartDeviceMotionListeningOption = StartDeviceMotionListeningOption
  14897. >(
  14898. option?: T
  14899. ): PromisifySuccessResult<T, StartDeviceMotionListeningOption>
  14900. /** [wx.startGyroscope(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.startGyroscope.html)
  14901. *
  14902. * 需要基础库: `2.3.0`
  14903. *
  14904. * 开始监听陀螺仪数据。 */
  14905. startGyroscope<T extends StartGyroscopeOption = StartGyroscopeOption>(
  14906. option?: T
  14907. ): PromisifySuccessResult<T, StartGyroscopeOption>
  14908. /** [wx.startHandoff(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.startHandoff.html)
  14909. *
  14910. * 需要基础库: `2.14.4`
  14911. *
  14912. * 开始进行接力,该接口需要在开放数据域调用 */
  14913. startHandoff(option?: StartHandoffOption): void
  14914. /** [wx.stopAccelerometer(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.stopAccelerometer.html)
  14915. *
  14916. * 需要基础库: `1.1.0`
  14917. *
  14918. * 停止监听加速度数据。
  14919. *
  14920. * **示例代码**
  14921. *
  14922. * ```js
  14923. wx.stopAccelerometer()
  14924. ``` */
  14925. stopAccelerometer<
  14926. T extends StopAccelerometerOption = StopAccelerometerOption
  14927. >(
  14928. option?: T
  14929. ): PromisifySuccessResult<T, StopAccelerometerOption>
  14930. /** [wx.stopBeaconDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.stopBeaconDiscovery.html)
  14931. *
  14932. * 需要基础库: `2.9.2`
  14933. *
  14934. * 停止搜索附近的 Beacon 设备 */
  14935. stopBeaconDiscovery<
  14936. T extends StopBeaconDiscoveryOption = StopBeaconDiscoveryOption
  14937. >(
  14938. option?: T
  14939. ): PromisifySuccessResult<T, StopBeaconDiscoveryOption>
  14940. /** [wx.stopBluetoothDevicesDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.stopBluetoothDevicesDiscovery.html)
  14941. *
  14942. * 需要基础库: `2.9.2`
  14943. *
  14944. * 停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时,建议调用该接口停止蓝牙搜索。
  14945. *
  14946. * **示例代码**
  14947. *
  14948. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  14949. * ```js
  14950. wx.stopBluetoothDevicesDiscovery({
  14951. success (res) {
  14952. console.log(res)
  14953. }
  14954. })
  14955. ``` */
  14956. stopBluetoothDevicesDiscovery<
  14957. T extends StopBluetoothDevicesDiscoveryOption = StopBluetoothDevicesDiscoveryOption
  14958. >(
  14959. option?: T
  14960. ): PromisifySuccessResult<T, StopBluetoothDevicesDiscoveryOption>
  14961. /** [wx.stopCompass(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.stopCompass.html)
  14962. *
  14963. * 需要基础库: `1.1.0`
  14964. *
  14965. * 停止监听罗盘数据
  14966. *
  14967. * **示例代码**
  14968. *
  14969. * ```js
  14970. wx.stopCompass()
  14971. ``` */
  14972. stopCompass<T extends StopCompassOption = StopCompassOption>(
  14973. option?: T
  14974. ): PromisifySuccessResult<T, StopCompassOption>
  14975. /** [wx.stopDeviceMotionListening(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.stopDeviceMotionListening.html)
  14976. *
  14977. * 需要基础库: `2.3.0`
  14978. *
  14979. * 停止监听设备方向的变化。 */
  14980. stopDeviceMotionListening<
  14981. T extends StopDeviceMotionListeningOption = StopDeviceMotionListeningOption
  14982. >(
  14983. option?: T
  14984. ): PromisifySuccessResult<T, StopDeviceMotionListeningOption>
  14985. /** [wx.stopFaceDetect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ai/face/wx.stopFaceDetect.html)
  14986. *
  14987. * 需要基础库: `2.18.0`
  14988. *
  14989. * 停止人脸识别 */
  14990. stopFaceDetect(option?: StopFaceDetectOption): void
  14991. /** [wx.stopGyroscope(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.stopGyroscope.html)
  14992. *
  14993. * 需要基础库: `2.3.0`
  14994. *
  14995. * 停止监听陀螺仪数据。 */
  14996. stopGyroscope<T extends StopGyroscopeOption = StopGyroscopeOption>(
  14997. option?: T
  14998. ): PromisifySuccessResult<T, StopGyroscopeOption>
  14999. /** [wx.triggerGC()](https://developers.weixin.qq.com/minigame/dev/api/base/performance/wx.triggerGC.html)
  15000. *
  15001. * 加快触发 JavaScriptCore 垃圾回收(Garbage Collection)。GC 时机是由 JavaScriptCore 来控制的,并不能保证调用后马上触发 GC。 */
  15002. triggerGC(): void
  15003. /** [wx.updateKeyboard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.updateKeyboard.html)
  15004. *
  15005. * 需要基础库: `2.1.0`
  15006. *
  15007. * 更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果 */
  15008. updateKeyboard<T extends UpdateKeyboardOption = UpdateKeyboardOption>(
  15009. option: T
  15010. ): PromisifySuccessResult<T, UpdateKeyboardOption>
  15011. /** [wx.updateShareMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.updateShareMenu.html)
  15012. *
  15013. * 需要基础库: `1.2.0`
  15014. *
  15015. * 更新转发属性
  15016. *
  15017. * **示例代码**
  15018. *
  15019. * ```js
  15020. wx.updateShareMenu({
  15021. withShareTicket: true,
  15022. success () { }
  15023. })
  15024. ```
  15025. * ```js
  15026. // 转发私密消息
  15027. wx.updateShareMenu({
  15028. isPrivateMessage: true,
  15029. activityId: 'xxx',
  15030. templateInfo: {},
  15031. success () { },
  15032. fail () {}
  15033. })
  15034. ``` */
  15035. updateShareMenu<
  15036. T extends UpdateShareMenuOption = UpdateShareMenuOption
  15037. >(
  15038. option: T
  15039. ): PromisifySuccessResult<T, UpdateShareMenuOption>
  15040. /** [wx.updateVoIPChatMuteConfig(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.updateVoIPChatMuteConfig.html)
  15041. *
  15042. * 需要基础库: `2.7.0`
  15043. *
  15044. * 更新实时语音静音设置 */
  15045. updateVoIPChatMuteConfig<
  15046. T extends UpdateVoIPChatMuteConfigOption = UpdateVoIPChatMuteConfigOption
  15047. >(
  15048. option: T
  15049. ): PromisifySuccessResult<T, UpdateVoIPChatMuteConfigOption>
  15050. /** [wx.updateWeChatApp(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/update/wx.updateWeChatApp.html)
  15051. *
  15052. * 需要基础库: `2.12.0`
  15053. *
  15054. * 更新客户端版本。当判断用户小程序所在客户端版本过低时,可使用该接口跳转到更新微信页面。 */
  15055. updateWeChatApp<
  15056. T extends UpdateWeChatAppOption = UpdateWeChatAppOption
  15057. >(
  15058. option?: T
  15059. ): PromisifySuccessResult<T, UpdateWeChatAppOption>
  15060. /** [wx.vibrateLong(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/vibrate/wx.vibrateLong.html)
  15061. *
  15062. * 需要基础库: `1.2.0`
  15063. *
  15064. * 使手机发生较长时间的振动(400 ms) */
  15065. vibrateLong<T extends VibrateLongOption = VibrateLongOption>(
  15066. option?: T
  15067. ): PromisifySuccessResult<T, VibrateLongOption>
  15068. /** [wx.vibrateShort(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/vibrate/wx.vibrateShort.html)
  15069. *
  15070. * 需要基础库: `1.2.0`
  15071. *
  15072. * 使手机发生较短时间的振动(15 ms)。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效 */
  15073. vibrateShort<T extends VibrateShortOption = VibrateShortOption>(
  15074. option: T
  15075. ): PromisifySuccessResult<T, VibrateShortOption>
  15076. /** [wx.writeBLECharacteristicValue(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.writeBLECharacteristicValue.html)
  15077. *
  15078. * 需要基础库: `2.9.2`
  15079. *
  15080. * 向蓝牙低功耗设备特征值中写入二进制数据。注意:必须设备的特征支持 write 才可以成功调用。
  15081. *
  15082. * **注意**
  15083. *
  15084. * - 并行调用多次会存在写失败的可能性。
  15085. * - 小程序不会对写入数据包大小做限制,但系统与蓝牙设备会限制蓝牙 4.0 单次传输的数据大小,超过最大字节数后会发生写入错误,建议每次写入不超过 20 字节。
  15086. * - 若单次写入数据过长,iOS 上存在系统不会有任何回调的情况(包括错误回调)。
  15087. * - 安卓平台上,在调用 [wx.notifyBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) 成功后立即调用本接口,在部分机型上会发生 10008 系统错误
  15088. *
  15089. * **示例代码**
  15090. *
  15091. * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
  15092. * ```js
  15093. // 向蓝牙设备发送一个0x00的16进制数据
  15094. let buffer = new ArrayBuffer(1)
  15095. let dataView = new DataView(buffer)
  15096. dataView.setUint8(0, 0)
  15097. wx.writeBLECharacteristicValue({
  15098. // 这里的 deviceId 需要在 getBluetoothDevices 或 onBluetoothDeviceFound 接口中获取
  15099. deviceId,
  15100. // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取
  15101. serviceId,
  15102. // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取
  15103. characteristicId,
  15104. // 这里的value是ArrayBuffer类型
  15105. value: buffer,
  15106. success (res) {
  15107. console.log('writeBLECharacteristicValue success', res.errMsg)
  15108. }
  15109. })
  15110. ``` */
  15111. writeBLECharacteristicValue<
  15112. T extends WriteBLECharacteristicValueOption = WriteBLECharacteristicValueOption
  15113. >(
  15114. option: T
  15115. ): PromisifySuccessResult<T, WriteBLECharacteristicValueOption>
  15116. /** 小程序云开发 */
  15117. cloud: WxCloud
  15118. /** 文件系统中的用户目录路径 */
  15119. env: { USER_DATA_PATH: string }
  15120. }
  15121. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15122. type AccessCompleteCallback = (res: GeneralCallbackResult) => void
  15123. /** 接口调用失败的回调函数 */
  15124. type AccessFailCallback = (result: AccessFailCallbackResult) => void
  15125. /** 接口调用成功的回调函数 */
  15126. type AccessSuccessCallback = (res: GeneralCallbackResult) => void
  15127. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15128. type AddCardCompleteCallback = (res: GeneralCallbackResult) => void
  15129. /** 接口调用失败的回调函数 */
  15130. type AddCardFailCallback = (res: GeneralCallbackResult) => void
  15131. /** 接口调用成功的回调函数 */
  15132. type AddCardSuccessCallback = (result: AddCardSuccessCallbackResult) => void
  15133. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15134. type AddServiceCompleteCallback = (res: GeneralCallbackResult) => void
  15135. /** 接口调用失败的回调函数 */
  15136. type AddServiceFailCallback = (res: GeneralCallbackResult) => void
  15137. /** 接口调用成功的回调函数 */
  15138. type AddServiceSuccessCallback = (res: GeneralCallbackResult) => void
  15139. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15140. type AppendFileCompleteCallback = (res: GeneralCallbackResult) => void
  15141. /** 接口调用失败的回调函数 */
  15142. type AppendFileFailCallback = (result: AppendFileFailCallbackResult) => void
  15143. /** 接口调用成功的回调函数 */
  15144. type AppendFileSuccessCallback = (res: GeneralCallbackResult) => void
  15145. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15146. type AuthPrivateMessageCompleteCallback = (
  15147. res: GeneralCallbackResult
  15148. ) => void
  15149. /** 接口调用失败的回调函数 */
  15150. type AuthPrivateMessageFailCallback = (res: GeneralCallbackResult) => void
  15151. /** 接口调用成功的回调函数 */
  15152. type AuthPrivateMessageSuccessCallback = (
  15153. result: AuthPrivateMessageSuccessCallbackResult
  15154. ) => void
  15155. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15156. type AuthorizeCompleteCallback = (res: GeneralCallbackResult) => void
  15157. /** 接口调用失败的回调函数 */
  15158. type AuthorizeFailCallback = (res: GeneralCallbackResult) => void
  15159. /** 接口调用成功的回调函数 */
  15160. type AuthorizeSuccessCallback = (res: GeneralCallbackResult) => void
  15161. type BannerAdOffErrorCallback = (
  15162. result: BannerAdOnErrorCallbackResult
  15163. ) => void
  15164. type BannerAdOffResizeCallback = (result: OnResizeCallbackResult) => void
  15165. type BannerAdOnErrorCallback = (
  15166. result: BannerAdOnErrorCallbackResult
  15167. ) => void
  15168. type BannerAdOnResizeCallback = (result: OnResizeCallbackResult) => void
  15169. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15170. type BroadcastInRoomCompleteCallback = (res: GeneralCallbackResult) => void
  15171. /** 接口调用失败的回调函数 */
  15172. type BroadcastInRoomFailCallback = (res: GeneralCallbackResult) => void
  15173. /** 接口调用成功的回调函数 */
  15174. type BroadcastInRoomSuccessCallback = (res: GeneralCallbackResult) => void
  15175. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15176. type CancelMatchCompleteCallback = (res: GeneralCallbackResult) => void
  15177. /** 接口调用失败的回调函数 */
  15178. type CancelMatchFailCallback = (res: GeneralCallbackResult) => void
  15179. /** 接口调用成功的回调函数 */
  15180. type CancelMatchSuccessCallback = (res: GeneralCallbackResult) => void
  15181. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15182. type ChangeSeatCompleteCallback = (res: GeneralCallbackResult) => void
  15183. /** 接口调用失败的回调函数 */
  15184. type ChangeSeatFailCallback = (res: GeneralCallbackResult) => void
  15185. /** 接口调用成功的回调函数 */
  15186. type ChangeSeatSuccessCallback = (res: GeneralCallbackResult) => void
  15187. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15188. type CheckHandoffEnabledCompleteCallback = (
  15189. res: GeneralCallbackResult
  15190. ) => void
  15191. /** 接口调用失败的回调函数 */
  15192. type CheckHandoffEnabledFailCallback = (res: GeneralCallbackResult) => void
  15193. /** 接口调用成功的回调函数 */
  15194. type CheckHandoffEnabledSuccessCallback = (
  15195. result: CheckHandoffEnabledSuccessCallbackResult
  15196. ) => void
  15197. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15198. type CheckIsUserAdvisedToRestCompleteCallback = (
  15199. res: GeneralCallbackResult
  15200. ) => void
  15201. /** 接口调用失败的回调函数 */
  15202. type CheckIsUserAdvisedToRestFailCallback = (
  15203. res: GeneralCallbackResult
  15204. ) => void
  15205. /** 接口调用成功的回调函数 */
  15206. type CheckIsUserAdvisedToRestSuccessCallback = (
  15207. result: CheckIsUserAdvisedToRestSuccessCallbackResult
  15208. ) => void
  15209. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15210. type CheckSessionCompleteCallback = (res: GeneralCallbackResult) => void
  15211. /** 接口调用失败的回调函数 */
  15212. type CheckSessionFailCallback = (res: GeneralCallbackResult) => void
  15213. /** 接口调用成功的回调函数 */
  15214. type CheckSessionSuccessCallback = (res: GeneralCallbackResult) => void
  15215. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15216. type ChooseImageCompleteCallback = (res: GeneralCallbackResult) => void
  15217. /** 接口调用失败的回调函数 */
  15218. type ChooseImageFailCallback = (res: GeneralCallbackResult) => void
  15219. /** 接口调用成功的回调函数 */
  15220. type ChooseImageSuccessCallback = (
  15221. result: ChooseImageSuccessCallbackResult
  15222. ) => void
  15223. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15224. type ClearStorageCompleteCallback = (res: GeneralCallbackResult) => void
  15225. /** 接口调用失败的回调函数 */
  15226. type ClearStorageFailCallback = (res: GeneralCallbackResult) => void
  15227. /** 接口调用成功的回调函数 */
  15228. type ClearStorageSuccessCallback = (res: GeneralCallbackResult) => void
  15229. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15230. type CloseBLEConnectionCompleteCallback = (res: BluetoothError) => void
  15231. /** 接口调用失败的回调函数 */
  15232. type CloseBLEConnectionFailCallback = (res: BluetoothError) => void
  15233. /** 接口调用成功的回调函数 */
  15234. type CloseBLEConnectionSuccessCallback = (res: BluetoothError) => void
  15235. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15236. type CloseBluetoothAdapterCompleteCallback = (res: BluetoothError) => void
  15237. /** 接口调用失败的回调函数 */
  15238. type CloseBluetoothAdapterFailCallback = (res: BluetoothError) => void
  15239. /** 接口调用成功的回调函数 */
  15240. type CloseBluetoothAdapterSuccessCallback = (res: BluetoothError) => void
  15241. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15242. type CloseCompleteCallback = (res: GeneralCallbackResult) => void
  15243. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15244. type CloseSocketCompleteCallback = (res: GeneralCallbackResult) => void
  15245. /** 接口调用失败的回调函数 */
  15246. type CloseSocketFailCallback = (res: GeneralCallbackResult) => void
  15247. /** 接口调用成功的回调函数 */
  15248. type CloseSocketSuccessCallback = (res: GeneralCallbackResult) => void
  15249. /** 接口调用成功的回调函数 */
  15250. type CloseSuccessCallback = (res: GeneralCallbackResult) => void
  15251. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15252. type ConnectSocketCompleteCallback = (res: GeneralCallbackResult) => void
  15253. /** 接口调用失败的回调函数 */
  15254. type ConnectSocketFailCallback = (res: GeneralCallbackResult) => void
  15255. /** 接口调用成功的回调函数 */
  15256. type ConnectSocketSuccessCallback = (res: GeneralCallbackResult) => void
  15257. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15258. type CopyFileCompleteCallback = (res: GeneralCallbackResult) => void
  15259. /** 接口调用失败的回调函数 */
  15260. type CopyFileFailCallback = (result: CopyFileFailCallbackResult) => void
  15261. /** 接口调用成功的回调函数 */
  15262. type CopyFileSuccessCallback = (res: GeneralCallbackResult) => void
  15263. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15264. type CreateBLEConnectionCompleteCallback = (res: BluetoothError) => void
  15265. /** 接口调用失败的回调函数 */
  15266. type CreateBLEConnectionFailCallback = (res: BluetoothError) => void
  15267. /** 接口调用成功的回调函数 */
  15268. type CreateBLEConnectionSuccessCallback = (res: BluetoothError) => void
  15269. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15270. type CreateBLEPeripheralServerCompleteCallback = (
  15271. res: GeneralCallbackResult
  15272. ) => void
  15273. /** 接口调用失败的回调函数 */
  15274. type CreateBLEPeripheralServerFailCallback = (
  15275. res: GeneralCallbackResult
  15276. ) => void
  15277. /** 接口调用成功的回调函数 */
  15278. type CreateBLEPeripheralServerSuccessCallback = (
  15279. result: CreateBLEPeripheralServerSuccessCallbackResult
  15280. ) => void
  15281. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15282. type CreateCameraCompleteCallback = (res: GeneralCallbackResult) => void
  15283. /** 接口调用失败的回调函数 */
  15284. type CreateCameraFailCallback = (res: GeneralCallbackResult) => void
  15285. /** 接口调用成功的回调函数 */
  15286. type CreateCameraSuccessCallback = (res: GeneralCallbackResult) => void
  15287. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15288. type CreateRoomCompleteCallback = (res: GeneralCallbackResult) => void
  15289. /** 接口调用失败的回调函数 */
  15290. type CreateRoomFailCallback = (res: GeneralCallbackResult) => void
  15291. /** 接口调用成功的回调函数 */
  15292. type CreateRoomSuccessCallback = (
  15293. result: CreateRoomSuccessCallbackResult
  15294. ) => void
  15295. /** 原生模板广告错误事件的回调函数 */
  15296. type CustomAdOffErrorCallback = (
  15297. result: CustomAdOnErrorCallbackResult
  15298. ) => void
  15299. /** 原生模板广告错误事件的回调函数 */
  15300. type CustomAdOnErrorCallback = (
  15301. result: CustomAdOnErrorCallbackResult
  15302. ) => void
  15303. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15304. type DownloadFileCompleteCallback = (res: GeneralCallbackResult) => void
  15305. /** 接口调用失败的回调函数 */
  15306. type DownloadFileFailCallback = (res: GeneralCallbackResult) => void
  15307. /** 接口调用成功的回调函数 */
  15308. type DownloadFileSuccessCallback = (
  15309. result: DownloadFileSuccessCallbackResult
  15310. ) => void
  15311. /** 下载进度变化事件的回调函数 */
  15312. type DownloadTaskOffProgressUpdateCallback = (
  15313. result: DownloadTaskOnProgressUpdateCallbackResult
  15314. ) => void
  15315. /** 下载进度变化事件的回调函数 */
  15316. type DownloadTaskOnProgressUpdateCallback = (
  15317. result: DownloadTaskOnProgressUpdateCallbackResult
  15318. ) => void
  15319. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15320. type EndGameCompleteCallback = (res: GeneralCallbackResult) => void
  15321. /** 接口调用失败的回调函数 */
  15322. type EndGameFailCallback = (res: GeneralCallbackResult) => void
  15323. /** 接口调用成功的回调函数 */
  15324. type EndGameSuccessCallback = (res: GeneralCallbackResult) => void
  15325. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15326. type EndStateServiceCompleteCallback = (res: GeneralCallbackResult) => void
  15327. /** 接口调用失败的回调函数 */
  15328. type EndStateServiceFailCallback = (res: GeneralCallbackResult) => void
  15329. /** 接口调用成功的回调函数 */
  15330. type EndStateServiceSuccessCallback = (res: GeneralCallbackResult) => void
  15331. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15332. type ExitMiniProgramCompleteCallback = (res: GeneralCallbackResult) => void
  15333. /** 接口调用失败的回调函数 */
  15334. type ExitMiniProgramFailCallback = (res: GeneralCallbackResult) => void
  15335. /** 接口调用成功的回调函数 */
  15336. type ExitMiniProgramSuccessCallback = (res: GeneralCallbackResult) => void
  15337. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15338. type ExitVoIPChatCompleteCallback = (res: GeneralCallbackResult) => void
  15339. /** 接口调用失败的回调函数 */
  15340. type ExitVoIPChatFailCallback = (res: GeneralCallbackResult) => void
  15341. /** 接口调用成功的回调函数 */
  15342. type ExitVoIPChatSuccessCallback = (res: GeneralCallbackResult) => void
  15343. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15344. type FaceDetectCompleteCallback = (res: GeneralCallbackResult) => void
  15345. /** 接口调用失败的回调函数 */
  15346. type FaceDetectFailCallback = (res: GeneralCallbackResult) => void
  15347. /** 接口调用成功的回调函数 */
  15348. type FaceDetectSuccessCallback = (
  15349. result: FaceDetectSuccessCallbackResult
  15350. ) => void
  15351. /** 接口调用失败的回调函数 */
  15352. type FileSystemManagerCloseFailCallback = (
  15353. result: CloseFailCallbackResult
  15354. ) => void
  15355. /** 接口调用失败的回调函数 */
  15356. type FileSystemManagerGetFileInfoFailCallback = (
  15357. result: GetFileInfoFailCallbackResult
  15358. ) => void
  15359. /** 接口调用成功的回调函数 */
  15360. type FileSystemManagerGetFileInfoSuccessCallback = (
  15361. result: FileSystemManagerGetFileInfoSuccessCallbackResult
  15362. ) => void
  15363. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15364. type FstatCompleteCallback = (res: GeneralCallbackResult) => void
  15365. /** 接口调用失败的回调函数 */
  15366. type FstatFailCallback = (result: FstatFailCallbackResult) => void
  15367. /** 接口调用成功的回调函数 */
  15368. type FstatSuccessCallback = (result: FstatSuccessCallbackResult) => void
  15369. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15370. type FtruncateCompleteCallback = (res: GeneralCallbackResult) => void
  15371. /** 接口调用失败的回调函数 */
  15372. type FtruncateFailCallback = (result: FtruncateFailCallbackResult) => void
  15373. /** 接口调用成功的回调函数 */
  15374. type FtruncateSuccessCallback = (res: GeneralCallbackResult) => void
  15375. type GameBannerOffErrorCallback = (
  15376. result: GameBannerOnErrorCallbackResult
  15377. ) => void
  15378. type GameBannerOffResizeCallback = (res: GeneralCallbackResult) => void
  15379. type GameBannerOnErrorCallback = (
  15380. result: GameBannerOnErrorCallbackResult
  15381. ) => void
  15382. type GameBannerOnResizeCallback = (res: GeneralCallbackResult) => void
  15383. type GameClubButtonOffTapCallback = (res: GeneralCallbackResult) => void
  15384. type GameClubButtonOnTapCallback = (res: GeneralCallbackResult) => void
  15385. /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
  15386. type GamePortalOffErrorCallback = (
  15387. result: GamePortalOnErrorCallbackResult
  15388. ) => void
  15389. /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
  15390. type GamePortalOnErrorCallback = (
  15391. result: GamePortalOnErrorCallbackResult
  15392. ) => void
  15393. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15394. type GetAvailableAudioSourcesCompleteCallback = (
  15395. res: GeneralCallbackResult
  15396. ) => void
  15397. /** 接口调用失败的回调函数 */
  15398. type GetAvailableAudioSourcesFailCallback = (
  15399. res: GeneralCallbackResult
  15400. ) => void
  15401. /** 接口调用成功的回调函数 */
  15402. type GetAvailableAudioSourcesSuccessCallback = (
  15403. result: GetAvailableAudioSourcesSuccessCallbackResult
  15404. ) => void
  15405. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15406. type GetBLEDeviceCharacteristicsCompleteCallback = (
  15407. res: BluetoothError
  15408. ) => void
  15409. /** 接口调用失败的回调函数 */
  15410. type GetBLEDeviceCharacteristicsFailCallback = (res: BluetoothError) => void
  15411. /** 接口调用成功的回调函数 */
  15412. type GetBLEDeviceCharacteristicsSuccessCallback = (
  15413. result: GetBLEDeviceCharacteristicsSuccessCallbackResult
  15414. ) => void
  15415. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15416. type GetBLEDeviceRSSICompleteCallback = (res: GeneralCallbackResult) => void
  15417. /** 接口调用失败的回调函数 */
  15418. type GetBLEDeviceRSSIFailCallback = (res: GeneralCallbackResult) => void
  15419. /** 接口调用成功的回调函数 */
  15420. type GetBLEDeviceRSSISuccessCallback = (
  15421. result: GetBLEDeviceRSSISuccessCallbackResult
  15422. ) => void
  15423. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15424. type GetBLEDeviceServicesCompleteCallback = (res: BluetoothError) => void
  15425. /** 接口调用失败的回调函数 */
  15426. type GetBLEDeviceServicesFailCallback = (res: BluetoothError) => void
  15427. /** 接口调用成功的回调函数 */
  15428. type GetBLEDeviceServicesSuccessCallback = (
  15429. result: GetBLEDeviceServicesSuccessCallbackResult
  15430. ) => void
  15431. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15432. type GetBLEMTUCompleteCallback = (res: BluetoothError) => void
  15433. /** 接口调用失败的回调函数 */
  15434. type GetBLEMTUFailCallback = (res: BluetoothError) => void
  15435. /** 接口调用成功的回调函数 */
  15436. type GetBLEMTUSuccessCallback = (
  15437. result: GetBLEMTUSuccessCallbackResult
  15438. ) => void
  15439. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15440. type GetBatteryInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15441. /** 接口调用失败的回调函数 */
  15442. type GetBatteryInfoFailCallback = (res: GeneralCallbackResult) => void
  15443. /** 接口调用成功的回调函数 */
  15444. type GetBatteryInfoSuccessCallback = (
  15445. result: GetBatteryInfoSuccessCallbackResult
  15446. ) => void
  15447. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15448. type GetBeaconsCompleteCallback = (res: BeaconError) => void
  15449. /** 接口调用失败的回调函数 */
  15450. type GetBeaconsFailCallback = (res: BeaconError) => void
  15451. /** 接口调用成功的回调函数 */
  15452. type GetBeaconsSuccessCallback = (
  15453. result: GetBeaconsSuccessCallbackResult
  15454. ) => void
  15455. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15456. type GetBluetoothAdapterStateCompleteCallback = (
  15457. res: BluetoothError
  15458. ) => void
  15459. /** 接口调用失败的回调函数 */
  15460. type GetBluetoothAdapterStateFailCallback = (res: BluetoothError) => void
  15461. /** 接口调用成功的回调函数 */
  15462. type GetBluetoothAdapterStateSuccessCallback = (
  15463. result: GetBluetoothAdapterStateSuccessCallbackResult
  15464. ) => void
  15465. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15466. type GetBluetoothDevicesCompleteCallback = (res: BluetoothError) => void
  15467. /** 接口调用失败的回调函数 */
  15468. type GetBluetoothDevicesFailCallback = (res: BluetoothError) => void
  15469. /** 接口调用成功的回调函数 */
  15470. type GetBluetoothDevicesSuccessCallback = (
  15471. result: GetBluetoothDevicesSuccessCallbackResult
  15472. ) => void
  15473. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15474. type GetChannelsLiveInfoCompleteCallback = (
  15475. res: GeneralCallbackResult
  15476. ) => void
  15477. /** 接口调用失败的回调函数 */
  15478. type GetChannelsLiveInfoFailCallback = (res: GeneralCallbackResult) => void
  15479. /** 接口调用成功的回调函数 */
  15480. type GetChannelsLiveInfoSuccessCallback = (
  15481. result: GetChannelsLiveInfoSuccessCallbackResult
  15482. ) => void
  15483. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15484. type GetChannelsLiveNoticeInfoCompleteCallback = (
  15485. res: GeneralCallbackResult
  15486. ) => void
  15487. /** 接口调用失败的回调函数 */
  15488. type GetChannelsLiveNoticeInfoFailCallback = (
  15489. res: GeneralCallbackResult
  15490. ) => void
  15491. /** 接口调用成功的回调函数 */
  15492. type GetChannelsLiveNoticeInfoSuccessCallback = (
  15493. result: GetChannelsLiveNoticeInfoSuccessCallbackResult
  15494. ) => void
  15495. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15496. type GetClipboardDataCompleteCallback = (res: GeneralCallbackResult) => void
  15497. /** 接口调用失败的回调函数 */
  15498. type GetClipboardDataFailCallback = (res: GeneralCallbackResult) => void
  15499. /** 接口调用成功的回调函数 */
  15500. type GetClipboardDataSuccessCallback = (
  15501. option: GetClipboardDataSuccessCallbackOption
  15502. ) => void
  15503. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15504. type GetConnectedBluetoothDevicesCompleteCallback = (
  15505. res: BluetoothError
  15506. ) => void
  15507. /** 接口调用失败的回调函数 */
  15508. type GetConnectedBluetoothDevicesFailCallback = (
  15509. res: BluetoothError
  15510. ) => void
  15511. /** 接口调用成功的回调函数 */
  15512. type GetConnectedBluetoothDevicesSuccessCallback = (
  15513. result: GetConnectedBluetoothDevicesSuccessCallbackResult
  15514. ) => void
  15515. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15516. type GetExtConfigCompleteCallback = (res: GeneralCallbackResult) => void
  15517. /** 接口调用失败的回调函数 */
  15518. type GetExtConfigFailCallback = (res: GeneralCallbackResult) => void
  15519. /** 接口调用成功的回调函数 */
  15520. type GetExtConfigSuccessCallback = (
  15521. result: GetExtConfigSuccessCallbackResult
  15522. ) => void
  15523. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15524. type GetFileInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15525. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15526. type GetFriendCloudStorageCompleteCallback = (
  15527. res: GeneralCallbackResult
  15528. ) => void
  15529. /** 接口调用失败的回调函数 */
  15530. type GetFriendCloudStorageFailCallback = (
  15531. res: GeneralCallbackResult
  15532. ) => void
  15533. /** 接口调用成功的回调函数 */
  15534. type GetFriendCloudStorageSuccessCallback = (
  15535. result: GetFriendCloudStorageSuccessCallbackResult
  15536. ) => void
  15537. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15538. type GetFriendsStateDataCompleteCallback = (
  15539. res: GeneralCallbackResult
  15540. ) => void
  15541. /** 接口调用失败的回调函数 */
  15542. type GetFriendsStateDataFailCallback = (res: GeneralCallbackResult) => void
  15543. /** 接口调用成功的回调函数 */
  15544. type GetFriendsStateDataSuccessCallback = (result: Res) => void
  15545. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15546. type GetGroupCloudStorageCompleteCallback = (
  15547. res: GeneralCallbackResult
  15548. ) => void
  15549. /** 接口调用失败的回调函数 */
  15550. type GetGroupCloudStorageFailCallback = (res: GeneralCallbackResult) => void
  15551. /** 接口调用成功的回调函数 */
  15552. type GetGroupCloudStorageSuccessCallback = (
  15553. result: GetGroupCloudStorageSuccessCallbackResult
  15554. ) => void
  15555. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15556. type GetGroupEnterInfoCompleteCallback = (
  15557. res: GeneralCallbackResult
  15558. ) => void
  15559. /** 接口调用失败的回调函数 */
  15560. type GetGroupEnterInfoFailCallback = (res: GeneralCallbackResult) => void
  15561. /** 接口调用成功的回调函数 */
  15562. type GetGroupEnterInfoSuccessCallback = (
  15563. result: GetGroupEnterInfoSuccessCallbackResult
  15564. ) => void
  15565. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15566. type GetGroupInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15567. /** 接口调用失败的回调函数 */
  15568. type GetGroupInfoFailCallback = (res: GeneralCallbackResult) => void
  15569. /** 接口调用成功的回调函数 */
  15570. type GetGroupInfoSuccessCallback = (
  15571. result: GetGroupInfoSuccessCallbackResult
  15572. ) => void
  15573. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15574. type GetLastRoomInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15575. /** 接口调用失败的回调函数 */
  15576. type GetLastRoomInfoFailCallback = (res: GeneralCallbackResult) => void
  15577. /** 接口调用成功的回调函数 */
  15578. type GetLastRoomInfoSuccessCallback = (
  15579. result: GetLastRoomInfoSuccessCallbackResult
  15580. ) => void
  15581. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15582. type GetLatestUserKeyCompleteCallback = (res: GeneralCallbackResult) => void
  15583. /** 接口调用失败的回调函数 */
  15584. type GetLatestUserKeyFailCallback = (res: GeneralCallbackResult) => void
  15585. /** 接口调用成功的回调函数 */
  15586. type GetLatestUserKeySuccessCallback = (
  15587. result: GetLatestUserKeySuccessCallbackResult
  15588. ) => void
  15589. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15590. type GetLocalIPAddressCompleteCallback = (
  15591. res: GeneralCallbackResult
  15592. ) => void
  15593. /** 接口调用失败的回调函数 */
  15594. type GetLocalIPAddressFailCallback = (res: GeneralCallbackResult) => void
  15595. /** 接口调用成功的回调函数 */
  15596. type GetLocalIPAddressSuccessCallback = (
  15597. result: GetLocalIPAddressSuccessCallbackResult
  15598. ) => void
  15599. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15600. type GetLocationCompleteCallback = (res: GeneralCallbackResult) => void
  15601. /** 接口调用失败的回调函数 */
  15602. type GetLocationFailCallback = (res: GeneralCallbackResult) => void
  15603. /** 接口调用成功的回调函数 */
  15604. type GetLocationSuccessCallback = (
  15605. result: GetLocationSuccessCallbackResult
  15606. ) => void
  15607. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15608. type GetLostFramesCompleteCallback = (res: GeneralCallbackResult) => void
  15609. /** 接口调用失败的回调函数 */
  15610. type GetLostFramesFailCallback = (res: GeneralCallbackResult) => void
  15611. /** 接口调用成功的回调函数 */
  15612. type GetLostFramesSuccessCallback = (
  15613. result: GetLostFramesSuccessCallbackResult
  15614. ) => void
  15615. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15616. type GetNetworkTypeCompleteCallback = (res: GeneralCallbackResult) => void
  15617. /** 接口调用失败的回调函数 */
  15618. type GetNetworkTypeFailCallback = (res: GeneralCallbackResult) => void
  15619. /** 接口调用成功的回调函数 */
  15620. type GetNetworkTypeSuccessCallback = (
  15621. result: GetNetworkTypeSuccessCallbackResult
  15622. ) => void
  15623. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15624. type GetPotentialFriendListCompleteCallback = (
  15625. res: GeneralCallbackResult
  15626. ) => void
  15627. /** 接口调用失败的回调函数 */
  15628. type GetPotentialFriendListFailCallback = (
  15629. res: GeneralCallbackResult
  15630. ) => void
  15631. /** 接口调用成功的回调函数 */
  15632. type GetPotentialFriendListSuccessCallback = (
  15633. result: GetPotentialFriendListSuccessCallbackResult
  15634. ) => void
  15635. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15636. type GetRandomValuesCompleteCallback = (res: GeneralCallbackResult) => void
  15637. /** 接口调用失败的回调函数 */
  15638. type GetRandomValuesFailCallback = (res: GeneralCallbackResult) => void
  15639. /** 接口调用成功的回调函数 */
  15640. type GetRandomValuesSuccessCallback = (
  15641. result: GetRandomValuesSuccessCallbackResult
  15642. ) => void
  15643. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15644. type GetRoomInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15645. /** 接口调用失败的回调函数 */
  15646. type GetRoomInfoFailCallback = (res: GeneralCallbackResult) => void
  15647. /** 接口调用成功的回调函数 */
  15648. type GetRoomInfoSuccessCallback = (
  15649. result: GetRoomInfoSuccessCallbackResult
  15650. ) => void
  15651. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15652. type GetSavedFileListCompleteCallback = (res: GeneralCallbackResult) => void
  15653. /** 接口调用失败的回调函数 */
  15654. type GetSavedFileListFailCallback = (res: GeneralCallbackResult) => void
  15655. /** 接口调用成功的回调函数 */
  15656. type GetSavedFileListSuccessCallback = (
  15657. result: GetSavedFileListSuccessCallbackResult
  15658. ) => void
  15659. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15660. type GetScreenBrightnessCompleteCallback = (
  15661. res: GeneralCallbackResult
  15662. ) => void
  15663. /** 接口调用失败的回调函数 */
  15664. type GetScreenBrightnessFailCallback = (res: GeneralCallbackResult) => void
  15665. /** 接口调用成功的回调函数 */
  15666. type GetScreenBrightnessSuccessCallback = (
  15667. option: GetScreenBrightnessSuccessCallbackOption
  15668. ) => void
  15669. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15670. type GetSettingCompleteCallback = (res: GeneralCallbackResult) => void
  15671. /** 接口调用失败的回调函数 */
  15672. type GetSettingFailCallback = (res: GeneralCallbackResult) => void
  15673. /** 接口调用成功的回调函数 */
  15674. type GetSettingSuccessCallback = (
  15675. result: GetSettingSuccessCallbackResult
  15676. ) => void
  15677. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15678. type GetShareInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15679. /** 接口调用失败的回调函数 */
  15680. type GetShareInfoFailCallback = (res: GeneralCallbackResult) => void
  15681. /** 接口调用成功的回调函数 */
  15682. type GetShareInfoSuccessCallback = (
  15683. result: GetGroupEnterInfoSuccessCallbackResult
  15684. ) => void
  15685. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15686. type GetStorageCompleteCallback = (res: GeneralCallbackResult) => void
  15687. /** 接口调用失败的回调函数 */
  15688. type GetStorageFailCallback = (res: GeneralCallbackResult) => void
  15689. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15690. type GetStorageInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15691. /** 接口调用失败的回调函数 */
  15692. type GetStorageInfoFailCallback = (res: GeneralCallbackResult) => void
  15693. /** 接口调用成功的回调函数 */
  15694. type GetStorageInfoSuccessCallback = (
  15695. option: GetStorageInfoSuccessCallbackOption
  15696. ) => void
  15697. /** 接口调用成功的回调函数 */
  15698. type GetStorageSuccessCallback<T = any> = (
  15699. result: GetStorageSuccessCallbackResult<T>
  15700. ) => void
  15701. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15702. type GetSystemInfoAsyncCompleteCallback = (
  15703. res: GeneralCallbackResult
  15704. ) => void
  15705. /** 接口调用失败的回调函数 */
  15706. type GetSystemInfoAsyncFailCallback = (res: GeneralCallbackResult) => void
  15707. /** 接口调用成功的回调函数 */
  15708. type GetSystemInfoAsyncSuccessCallback = (result: SystemInfo) => void
  15709. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15710. type GetSystemInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15711. /** 接口调用失败的回调函数 */
  15712. type GetSystemInfoFailCallback = (res: GeneralCallbackResult) => void
  15713. /** 接口调用成功的回调函数 */
  15714. type GetSystemInfoSuccessCallback = (result: SystemInfo) => void
  15715. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15716. type GetTextLineHeightCompleteCallback = (
  15717. res: GeneralCallbackResult
  15718. ) => void
  15719. /** 接口调用失败的回调函数 */
  15720. type GetTextLineHeightFailCallback = (res: GeneralCallbackResult) => void
  15721. /** 接口调用成功的回调函数 */
  15722. type GetTextLineHeightSuccessCallback = (res: GeneralCallbackResult) => void
  15723. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15724. type GetUserCloudStorageCompleteCallback = (
  15725. res: GeneralCallbackResult
  15726. ) => void
  15727. /** 接口调用失败的回调函数 */
  15728. type GetUserCloudStorageFailCallback = (res: GeneralCallbackResult) => void
  15729. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15730. type GetUserCloudStorageKeysCompleteCallback = (
  15731. res: GeneralCallbackResult
  15732. ) => void
  15733. /** 接口调用失败的回调函数 */
  15734. type GetUserCloudStorageKeysFailCallback = (
  15735. res: GeneralCallbackResult
  15736. ) => void
  15737. /** 接口调用成功的回调函数 */
  15738. type GetUserCloudStorageKeysSuccessCallback = (
  15739. result: GetUserCloudStorageKeysSuccessCallbackResult
  15740. ) => void
  15741. /** 接口调用成功的回调函数 */
  15742. type GetUserCloudStorageSuccessCallback = (
  15743. result: GetUserCloudStorageSuccessCallbackResult
  15744. ) => void
  15745. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15746. type GetUserInfoCompleteCallback = (res: GeneralCallbackResult) => void
  15747. /** 接口调用失败的回调函数 */
  15748. type GetUserInfoFailCallback = (res: GeneralCallbackResult) => void
  15749. /** 接口调用成功的回调函数 */
  15750. type GetUserInfoSuccessCallback = (
  15751. result: GetUserInfoSuccessCallbackResult
  15752. ) => void
  15753. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15754. type GetUserInteractiveStorageCompleteCallback = (
  15755. res: GeneralCallbackResult
  15756. ) => void
  15757. /** 接口调用失败的回调函数 */
  15758. type GetUserInteractiveStorageFailCallback = (
  15759. result: GetUserInteractiveStorageFailCallbackResult
  15760. ) => void
  15761. /** 接口调用成功的回调函数 */
  15762. type GetUserInteractiveStorageSuccessCallback = (
  15763. result: GetUserInteractiveStorageSuccessCallbackResult,
  15764. /** 加密算法的初始向量,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
  15765. iv: string
  15766. ) => void
  15767. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15768. type GetWeRunDataCompleteCallback = (res: GeneralCallbackResult) => void
  15769. /** 接口调用失败的回调函数 */
  15770. type GetWeRunDataFailCallback = (res: GeneralCallbackResult) => void
  15771. /** 接口调用成功的回调函数 */
  15772. type GetWeRunDataSuccessCallback = (
  15773. result: GetWeRunDataSuccessCallbackResult
  15774. ) => void
  15775. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15776. type HideKeyboardCompleteCallback = (res: GeneralCallbackResult) => void
  15777. /** 接口调用失败的回调函数 */
  15778. type HideKeyboardFailCallback = (res: GeneralCallbackResult) => void
  15779. /** 接口调用成功的回调函数 */
  15780. type HideKeyboardSuccessCallback = (res: GeneralCallbackResult) => void
  15781. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15782. type HideLoadingCompleteCallback = (res: GeneralCallbackResult) => void
  15783. /** 接口调用失败的回调函数 */
  15784. type HideLoadingFailCallback = (res: GeneralCallbackResult) => void
  15785. /** 接口调用成功的回调函数 */
  15786. type HideLoadingSuccessCallback = (res: GeneralCallbackResult) => void
  15787. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15788. type HideShareMenuCompleteCallback = (res: GeneralCallbackResult) => void
  15789. /** 接口调用失败的回调函数 */
  15790. type HideShareMenuFailCallback = (res: GeneralCallbackResult) => void
  15791. /** 接口调用成功的回调函数 */
  15792. type HideShareMenuSuccessCallback = (res: GeneralCallbackResult) => void
  15793. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15794. type HideToastCompleteCallback = (res: GeneralCallbackResult) => void
  15795. /** 接口调用失败的回调函数 */
  15796. type HideToastFailCallback = (res: GeneralCallbackResult) => void
  15797. /** 接口调用成功的回调函数 */
  15798. type HideToastSuccessCallback = (res: GeneralCallbackResult) => void
  15799. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15800. type InitFaceDetectCompleteCallback = (res: GeneralCallbackResult) => void
  15801. /** 接口调用失败的回调函数 */
  15802. type InitFaceDetectFailCallback = (res: GeneralCallbackResult) => void
  15803. /** 接口调用成功的回调函数 */
  15804. type InitFaceDetectSuccessCallback = (res: GeneralCallbackResult) => void
  15805. /** 音频播放错误事件的回调函数 */
  15806. type InnerAudioContextOffErrorCallback = (
  15807. result: InnerAudioContextOnErrorCallbackResult
  15808. ) => void
  15809. /** 音频播放进度更新事件的回调函数 */
  15810. type InnerAudioContextOffTimeUpdateCallback = (
  15811. res: GeneralCallbackResult
  15812. ) => void
  15813. /** 音频播放错误事件的回调函数 */
  15814. type InnerAudioContextOnErrorCallback = (
  15815. result: InnerAudioContextOnErrorCallbackResult
  15816. ) => void
  15817. /** 音频停止事件的回调函数 */
  15818. type InnerAudioContextOnStopCallback = (res: GeneralCallbackResult) => void
  15819. /** 音频播放进度更新事件的回调函数 */
  15820. type InnerAudioContextOnTimeUpdateCallback = (
  15821. res: GeneralCallbackResult
  15822. ) => void
  15823. /** 插屏错误事件的回调函数 */
  15824. type InterstitialAdOffErrorCallback = (
  15825. result: InterstitialAdOnErrorCallbackResult
  15826. ) => void
  15827. /** 插屏错误事件的回调函数 */
  15828. type InterstitialAdOnErrorCallback = (
  15829. result: InterstitialAdOnErrorCallbackResult
  15830. ) => void
  15831. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15832. type InviteFriendCompleteCallback = (res: GeneralCallbackResult) => void
  15833. /** 接口调用失败的回调函数 */
  15834. type InviteFriendFailCallback = (res: GeneralCallbackResult) => void
  15835. /** 接口调用成功的回调函数 */
  15836. type InviteFriendSuccessCallback = (res: GeneralCallbackResult) => void
  15837. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15838. type IsBluetoothDevicePairedCompleteCallback = (
  15839. res: GeneralCallbackResult
  15840. ) => void
  15841. /** 接口调用失败的回调函数 */
  15842. type IsBluetoothDevicePairedFailCallback = (
  15843. res: GeneralCallbackResult
  15844. ) => void
  15845. /** 接口调用成功的回调函数 */
  15846. type IsBluetoothDevicePairedSuccessCallback = (
  15847. res: GeneralCallbackResult
  15848. ) => void
  15849. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15850. type JoinRoomCompleteCallback = (res: GeneralCallbackResult) => void
  15851. /** 接口调用失败的回调函数 */
  15852. type JoinRoomFailCallback = (res: GeneralCallbackResult) => void
  15853. /** 接口调用成功的回调函数 */
  15854. type JoinRoomSuccessCallback = (
  15855. result: JoinRoomSuccessCallbackResult
  15856. ) => void
  15857. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15858. type JoinVoIPChatCompleteCallback = (res: JoinVoIPChatError) => void
  15859. /** 接口调用失败的回调函数 */
  15860. type JoinVoIPChatFailCallback = (res: JoinVoIPChatError) => void
  15861. /** 接口调用成功的回调函数 */
  15862. type JoinVoIPChatSuccessCallback = (
  15863. result: JoinVoIPChatSuccessCallbackResult
  15864. ) => void
  15865. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15866. type KickoutMemberCompleteCallback = (res: GeneralCallbackResult) => void
  15867. /** 接口调用失败的回调函数 */
  15868. type KickoutMemberFailCallback = (res: GeneralCallbackResult) => void
  15869. /** 接口调用成功的回调函数 */
  15870. type KickoutMemberSuccessCallback = (res: GeneralCallbackResult) => void
  15871. /** 分包加载进度变化事件的回调函数 */
  15872. type LoadSubpackageTaskOnProgressUpdateCallback = (
  15873. result: LoadSubpackageTaskOnProgressUpdateCallbackResult
  15874. ) => void
  15875. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15876. type LoginCompleteCallback = (res: GeneralCallbackResult) => void
  15877. /** 接口调用失败的回调函数 */
  15878. type LoginFailCallback = (res: GeneralCallbackResult) => void
  15879. /** 接口调用成功的回调函数 */
  15880. type LoginSuccessCallback = (result: LoginSuccessCallbackResult) => void
  15881. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15882. type MakeBluetoothPairCompleteCallback = (
  15883. res: GeneralCallbackResult
  15884. ) => void
  15885. /** 接口调用失败的回调函数 */
  15886. type MakeBluetoothPairFailCallback = (res: GeneralCallbackResult) => void
  15887. /** 接口调用成功的回调函数 */
  15888. type MakeBluetoothPairSuccessCallback = (res: GeneralCallbackResult) => void
  15889. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15890. type MemberLeaveRoomCompleteCallback = (res: GeneralCallbackResult) => void
  15891. /** 接口调用失败的回调函数 */
  15892. type MemberLeaveRoomFailCallback = (res: GeneralCallbackResult) => void
  15893. /** 接口调用成功的回调函数 */
  15894. type MemberLeaveRoomSuccessCallback = (res: GeneralCallbackResult) => void
  15895. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15896. type MkdirCompleteCallback = (res: GeneralCallbackResult) => void
  15897. /** 接口调用失败的回调函数 */
  15898. type MkdirFailCallback = (result: MkdirFailCallbackResult) => void
  15899. /** 接口调用成功的回调函数 */
  15900. type MkdirSuccessCallback = (res: GeneralCallbackResult) => void
  15901. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15902. type ModifyFriendInteractiveStorageCompleteCallback = (
  15903. res: GeneralCallbackResult
  15904. ) => void
  15905. /** 接口调用失败的回调函数 */
  15906. type ModifyFriendInteractiveStorageFailCallback = (
  15907. result: ModifyFriendInteractiveStorageFailCallbackResult
  15908. ) => void
  15909. /** 接口调用成功的回调函数 */
  15910. type ModifyFriendInteractiveStorageSuccessCallback = (
  15911. res: GeneralCallbackResult
  15912. ) => void
  15913. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15914. type NavigateToMiniProgramCompleteCallback = (
  15915. res: GeneralCallbackResult
  15916. ) => void
  15917. /** 接口调用失败的回调函数 */
  15918. type NavigateToMiniProgramFailCallback = (
  15919. res: GeneralCallbackResult
  15920. ) => void
  15921. /** 接口调用成功的回调函数 */
  15922. type NavigateToMiniProgramSuccessCallback = (
  15923. res: GeneralCallbackResult
  15924. ) => void
  15925. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  15926. type NotifyBLECharacteristicValueChangeCompleteCallback = (
  15927. res: BluetoothError
  15928. ) => void
  15929. /** 接口调用失败的回调函数 */
  15930. type NotifyBLECharacteristicValueChangeFailCallback = (
  15931. res: BluetoothError
  15932. ) => void
  15933. /** 接口调用成功的回调函数 */
  15934. type NotifyBLECharacteristicValueChangeSuccessCallback = (
  15935. res: BluetoothError
  15936. ) => void
  15937. /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
  15938. type OffAddToFavoritesCallback = (
  15939. result: OnAddToFavoritesCallbackResult
  15940. ) => void
  15941. /** 音频因为受到系统占用而被中断开始事件的回调函数 */
  15942. type OffAudioInterruptionBeginCallback = (
  15943. res: GeneralCallbackResult
  15944. ) => void
  15945. /** 音频中断结束事件的回调函数 */
  15946. type OffAudioInterruptionEndCallback = (res: GeneralCallbackResult) => void
  15947. /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
  15948. type OffBLEMTUChangeCallback = (
  15949. result: OnBLEMTUChangeCallbackResult
  15950. ) => void
  15951. /** 当前外围设备被连接或断开连接事件的回调函数 */
  15952. type OffBLEPeripheralConnectionStateChangedCallback = (
  15953. result: OnBLEPeripheralConnectionStateChangedCallbackResult
  15954. ) => void
  15955. /** 的回调函数 */
  15956. type OffBeKickedOutCallback = (result: OnBeKickedOutCallbackResult) => void
  15957. /** Beacon 服务状态变化事件的回调函数 */
  15958. type OffBeaconServiceChangeCallback = (res: GeneralCallbackResult) => void
  15959. /** Beacon 设备更新事件的回调函数 */
  15960. type OffBeaconUpdateCallback = (res: GeneralCallbackResult) => void
  15961. /** 的回调函数 */
  15962. type OffBroadcastCallback = (result: OnBroadcastCallbackResult) => void
  15963. /** 音频进入可以播放状态的事件的回调函数 */
  15964. type OffCanplayCallback = (res: GeneralCallbackResult) => void
  15965. /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
  15966. type OffCharacteristicReadRequestCallback = (
  15967. result: OnCharacteristicReadRequestCallbackResult
  15968. ) => void
  15969. /** 特征订阅事件的回调函数 */
  15970. type OffCharacteristicSubscribedCallback = (
  15971. result: OnCharacteristicSubscribedCallbackResult
  15972. ) => void
  15973. /** 取消特征订阅事件的回调函数 */
  15974. type OffCharacteristicUnsubscribedCallback = (
  15975. result: OnCharacteristicSubscribedCallbackResult
  15976. ) => void
  15977. /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
  15978. type OffCharacteristicWriteRequestCallback = (
  15979. result: OnCharacteristicWriteRequestCallbackResult
  15980. ) => void
  15981. /** Transfer-Encoding Chunk Received 事件的回调函数 */
  15982. type OffChunkReceivedCallback = (
  15983. result: RequestTaskOnChunkReceivedCallbackResult
  15984. ) => void
  15985. /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
  15986. type OffCopyUrlCallback = (result: OnCopyUrlCallbackResult) => void
  15987. /** 横竖屏切换事件的回调函数 */
  15988. type OffDeviceOrientationChangeCallback = (
  15989. result: OnDeviceOrientationChangeCallbackResult
  15990. ) => void
  15991. /** 断开连接,收到此事件的回调函数 */
  15992. type OffDisconnectCallback = (
  15993. result: GameServerManagerOnDisconnectCallbackResult
  15994. ) => void
  15995. type OffEndedCallback = (res: GeneralCallbackResult) => void
  15996. /** 的回调函数 */
  15997. type OffGameEndCallback = (result: OnGameEndCallbackResult) => void
  15998. /** 的回调函数 */
  15999. type OffGameStartCallback = (res: GeneralCallbackResult) => void
  16000. /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
  16001. type OffHandoffCallback = (result: OnHandoffCallbackResult) => void
  16002. /** HTTP Response Header 事件的回调函数 */
  16003. type OffHeadersReceivedCallback = (
  16004. result: OnHeadersReceivedCallbackResult
  16005. ) => void
  16006. type OffHideCallback = (res: GeneralCallbackResult) => void
  16007. /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
  16008. type OffInviteCallback = (result: OnInviteCallbackResult) => void
  16009. /** 键盘按键按下事件的回调函数 */
  16010. type OffKeyDownCallback = (result: OnKeyDownCallbackResult) => void
  16011. /** 键盘按键弹起事件的回调函数 */
  16012. type OffKeyUpCallback = (result: OnKeyDownCallbackResult) => void
  16013. /** 监听键盘收起的事件的回调函数 */
  16014. type OffKeyboardCompleteCallback = (
  16015. result: OnKeyboardInputCallbackResult
  16016. ) => void
  16017. /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
  16018. type OffKeyboardConfirmCallback = (
  16019. result: OnKeyboardInputCallbackResult
  16020. ) => void
  16021. /** 键盘输入事件的回调函数 */
  16022. type OffKeyboardInputCallback = (
  16023. result: OnKeyboardInputCallbackResult
  16024. ) => void
  16025. /** 开始监听数据包消息的事件的回调函数 */
  16026. type OffListeningCallback = (res: GeneralCallbackResult) => void
  16027. type OffLoadCallback = (res: GeneralCallbackResult) => void
  16028. /** 的回调函数 */
  16029. type OffLockStepErrorCallback = (
  16030. result: OnLockStepErrorCallbackResult
  16031. ) => void
  16032. /** 用户登出游戏服务事件的回调函数 */
  16033. type OffLogoutCallback = (res: GeneralCallbackResult) => void
  16034. /** 游戏匹配成功的事件的回调函数 */
  16035. type OffMatchCallback = (
  16036. result: GameServerManagerOnMatchCallbackResult
  16037. ) => void
  16038. /** 收到消息的事件的回调函数 */
  16039. type OffMessageCallback = (result: UDPSocketOnMessageCallbackResult) => void
  16040. /** 鼠标按键按下事件的回调函数 */
  16041. type OffMouseDownCallback = (result: OnMouseDownCallbackResult) => void
  16042. /** 鼠标移动事件的回调函数 */
  16043. type OffMouseMoveCallback = (result: OnMouseMoveCallbackResult) => void
  16044. /** 鼠标按键弹起事件的回调函数 */
  16045. type OffMouseUpCallback = (result: OnMouseDownCallbackResult) => void
  16046. /** 弱网状态变化事件的回调函数 */
  16047. type OffNetworkWeakChangeCallback = (
  16048. result: OnNetworkWeakChangeCallbackResult
  16049. ) => void
  16050. type OffPauseCallback = (res: GeneralCallbackResult) => void
  16051. type OffPlayCallback = (res: GeneralCallbackResult) => void
  16052. /** 视频下载(缓冲)事件的回调函数 */
  16053. type OffProgressCallback = (result: OnProgressCallbackResult) => void
  16054. /** 的回调函数 */
  16055. type OffRoomInfoChangeCallback = (
  16056. result: GameServerManagerOnRoomInfoChangeCallbackResult
  16057. ) => void
  16058. /** 音频完成跳转操作的事件的回调函数 */
  16059. type OffSeekedCallback = (res: GeneralCallbackResult) => void
  16060. /** 音频进行跳转操作的事件的回调函数 */
  16061. type OffSeekingCallback = (res: GeneralCallbackResult) => void
  16062. /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
  16063. type OffShareAppMessageCallback = (
  16064. result: OnShareAppMessageCallbackResult
  16065. ) => void
  16066. /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
  16067. type OffShareTimelineCallback = (
  16068. result: OnShareTimelineCallbackResult
  16069. ) => void
  16070. /** 小游戏回到前台的事件的回调函数 */
  16071. type OffShowCallback = (result: OnShowCallbackResult) => void
  16072. /** 的回调函数 */
  16073. type OffStateUpdateCallback = (
  16074. result: GameServerManagerOnStateUpdateCallbackResult
  16075. ) => void
  16076. /** 音频停止事件的回调函数 */
  16077. type OffStopCallback = (res: GeneralCallbackResult) => void
  16078. /** 的回调函数 */
  16079. type OffSyncFrameCallback = (result: OnSyncFrameCallbackResult) => void
  16080. /** 触点失效事件的回调函数 */
  16081. type OffTouchCancelCallback = (result: OnTouchStartCallbackResult) => void
  16082. /** 触摸结束事件的回调函数 */
  16083. type OffTouchEndCallback = (result: OnTouchStartCallbackResult) => void
  16084. /** 触点移动事件的回调函数 */
  16085. type OffTouchMoveCallback = (result: OnTouchStartCallbackResult) => void
  16086. /** 开始触摸事件的回调函数 */
  16087. type OffTouchStartCallback = (result: OnTouchStartCallbackResult) => void
  16088. /** 未处理的 Promise 拒绝事件的回调函数 */
  16089. type OffUnhandledRejectionCallback = (
  16090. result: OnUnhandledRejectionCallbackResult
  16091. ) => void
  16092. /** 房间状态变化事件的回调函数 */
  16093. type OffVoIPChatStateChangedCallback = (
  16094. result: OnVoIPChatStateChangedCallbackResult
  16095. ) => void
  16096. type OffWaitingCallback = (res: GeneralCallbackResult) => void
  16097. /** 鼠标滚轮事件的回调函数 */
  16098. type OffWheelCallback = (result: OnWheelCallbackResult) => void
  16099. /** 窗口尺寸变化事件的回调函数 */
  16100. type OffWindowResizeCallback = (
  16101. result: OnWindowResizeCallbackResult
  16102. ) => void
  16103. /** 加速度数据事件的回调函数 */
  16104. type OnAccelerometerChangeCallback = (
  16105. result: OnAccelerometerChangeCallbackResult
  16106. ) => void
  16107. /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
  16108. type OnAddToFavoritesCallback = (
  16109. result: OnAddToFavoritesCallbackResult
  16110. ) => void
  16111. /** 音频因为受到系统占用而被中断开始事件的回调函数 */
  16112. type OnAudioInterruptionBeginCallback = (res: GeneralCallbackResult) => void
  16113. /** 音频中断结束事件的回调函数 */
  16114. type OnAudioInterruptionEndCallback = (res: GeneralCallbackResult) => void
  16115. /** 蓝牙低功耗设备的特征值变化事件的回调函数 */
  16116. type OnBLECharacteristicValueChangeCallback = (
  16117. result: OnBLECharacteristicValueChangeCallbackResult
  16118. ) => void
  16119. /** 蓝牙低功耗连接状态的改变事件的回调函数 */
  16120. type OnBLEConnectionStateChangeCallback = (
  16121. result: OnBLEConnectionStateChangeCallbackResult
  16122. ) => void
  16123. /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
  16124. type OnBLEMTUChangeCallback = (result: OnBLEMTUChangeCallbackResult) => void
  16125. /** 当前外围设备被连接或断开连接事件的回调函数 */
  16126. type OnBLEPeripheralConnectionStateChangedCallback = (
  16127. result: OnBLEPeripheralConnectionStateChangedCallbackResult
  16128. ) => void
  16129. /** 的回调函数 */
  16130. type OnBeKickedOutCallback = (result: OnBeKickedOutCallbackResult) => void
  16131. /** Beacon 服务状态变化事件的回调函数 */
  16132. type OnBeaconServiceChangeCallback = (
  16133. result: OnBeaconServiceChangeCallbackResult
  16134. ) => void
  16135. /** Beacon 设备更新事件的回调函数 */
  16136. type OnBeaconUpdateCallback = (result: OnBeaconUpdateCallbackResult) => void
  16137. /** 蓝牙适配器状态变化事件的回调函数 */
  16138. type OnBluetoothAdapterStateChangeCallback = (
  16139. result: OnBluetoothAdapterStateChangeCallbackResult
  16140. ) => void
  16141. /** 搜索到新设备的事件的回调函数 */
  16142. type OnBluetoothDeviceFoundCallback = (
  16143. result: OnBluetoothDeviceFoundCallbackResult
  16144. ) => void
  16145. /** 的回调函数 */
  16146. type OnBroadcastCallback = (result: OnBroadcastCallbackResult) => void
  16147. /** 摄像头返回实时帧数据的回调函数 */
  16148. type OnCameraFrameCallback = (result: OnCameraFrameCallbackResult) => void
  16149. /** 音频进入可以播放状态的事件的回调函数 */
  16150. type OnCanplayCallback = (res: GeneralCallbackResult) => void
  16151. /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
  16152. type OnCharacteristicReadRequestCallback = (
  16153. result: OnCharacteristicReadRequestCallbackResult
  16154. ) => void
  16155. /** 特征订阅事件的回调函数 */
  16156. type OnCharacteristicSubscribedCallback = (
  16157. result: OnCharacteristicSubscribedCallbackResult
  16158. ) => void
  16159. /** 取消特征订阅事件的回调函数 */
  16160. type OnCharacteristicUnsubscribedCallback = (
  16161. result: OnCharacteristicSubscribedCallbackResult
  16162. ) => void
  16163. /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
  16164. type OnCharacteristicWriteRequestCallback = (
  16165. result: OnCharacteristicWriteRequestCallbackResult
  16166. ) => void
  16167. /** 向微信后台请求检查更新结果事件的回调函数 */
  16168. type OnCheckForUpdateCallback = (
  16169. result: OnCheckForUpdateCallbackResult
  16170. ) => void
  16171. /** Transfer-Encoding Chunk Received 事件的回调函数 */
  16172. type OnChunkReceivedCallback = (
  16173. result: RequestTaskOnChunkReceivedCallbackResult
  16174. ) => void
  16175. /** 罗盘数据变化事件的回调函数 */
  16176. type OnCompassChangeCallback = (
  16177. result: OnCompassChangeCallbackResult
  16178. ) => void
  16179. /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
  16180. type OnCopyUrlCallback = (result: OnCopyUrlCallbackResult) => void
  16181. /** 设备方向变化事件的回调函数 */
  16182. type OnDeviceMotionChangeCallback = (
  16183. result: OnDeviceMotionChangeCallbackResult
  16184. ) => void
  16185. /** 横竖屏切换事件的回调函数 */
  16186. type OnDeviceOrientationChangeCallback = (
  16187. result: OnDeviceOrientationChangeCallbackResult
  16188. ) => void
  16189. /** 断开连接,收到此事件的回调函数 */
  16190. type OnDisconnectCallback = (
  16191. result: GameServerManagerOnDisconnectCallbackResult
  16192. ) => void
  16193. type OnEndedCallback = (res: GeneralCallbackResult) => void
  16194. /** 已录制完指定帧大小的文件事件的回调函数 */
  16195. type OnFrameRecordedCallback = (
  16196. result: OnFrameRecordedCallbackResult
  16197. ) => void
  16198. /** 的回调函数 */
  16199. type OnGameEndCallback = (result: OnGameEndCallbackResult) => void
  16200. /** 的回调函数 */
  16201. type OnGameStartCallback = (res: GeneralCallbackResult) => void
  16202. /** 陀螺仪数据变化事件的回调函数 */
  16203. type OnGyroscopeChangeCallback = (
  16204. result: OnGyroscopeChangeCallbackResult
  16205. ) => void
  16206. /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
  16207. type OnHandoffCallback = (result: OnHandoffCallbackResult) => void
  16208. /** HTTP Response Header 事件的回调函数 */
  16209. type OnHeadersReceivedCallback = (
  16210. result: OnHeadersReceivedCallbackResult
  16211. ) => void
  16212. type OnHideCallback = (res: GeneralCallbackResult) => void
  16213. /** 录音因为受到系统占用而被中断开始事件的回调函数 */
  16214. type OnInterruptionBeginCallback = (res: GeneralCallbackResult) => void
  16215. /** 录音中断结束事件的回调函数 */
  16216. type OnInterruptionEndCallback = (res: GeneralCallbackResult) => void
  16217. /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
  16218. type OnInviteCallback = (result: OnInviteCallbackResult) => void
  16219. /** 键盘按键按下事件的回调函数 */
  16220. type OnKeyDownCallback = (result: OnKeyDownCallbackResult) => void
  16221. /** 键盘按键弹起事件的回调函数 */
  16222. type OnKeyUpCallback = (result: OnKeyDownCallbackResult) => void
  16223. /** 监听键盘收起的事件的回调函数 */
  16224. type OnKeyboardCompleteCallback = (
  16225. result: OnKeyboardInputCallbackResult
  16226. ) => void
  16227. /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
  16228. type OnKeyboardConfirmCallback = (
  16229. result: OnKeyboardInputCallbackResult
  16230. ) => void
  16231. type OnKeyboardHeightChangeCallback = (
  16232. result: OnKeyboardHeightChangeCallbackResult
  16233. ) => void
  16234. /** 键盘输入事件的回调函数 */
  16235. type OnKeyboardInputCallback = (
  16236. result: OnKeyboardInputCallbackResult
  16237. ) => void
  16238. /** 开始监听数据包消息的事件的回调函数 */
  16239. type OnListeningCallback = (res: GeneralCallbackResult) => void
  16240. type OnLoadCallback = (res: GeneralCallbackResult) => void
  16241. /** 的回调函数 */
  16242. type OnLockStepErrorCallback = (
  16243. result: OnLockStepErrorCallbackResult
  16244. ) => void
  16245. /** 用户登出游戏服务事件的回调函数 */
  16246. type OnLogoutCallback = (res: GeneralCallbackResult) => void
  16247. /** 游戏匹配成功的事件的回调函数 */
  16248. type OnMatchCallback = (
  16249. result: GameServerManagerOnMatchCallbackResult
  16250. ) => void
  16251. /** 内存不足告警事件的回调函数 */
  16252. type OnMemoryWarningCallback = (
  16253. result: OnMemoryWarningCallbackResult
  16254. ) => void
  16255. /** 鼠标按键按下事件的回调函数 */
  16256. type OnMouseDownCallback = (result: OnMouseDownCallbackResult) => void
  16257. /** 鼠标移动事件的回调函数 */
  16258. type OnMouseMoveCallback = (result: OnMouseMoveCallbackResult) => void
  16259. /** 鼠标按键弹起事件的回调函数 */
  16260. type OnMouseUpCallback = (result: OnMouseDownCallbackResult) => void
  16261. /** 网络状态变化事件的回调函数 */
  16262. type OnNetworkStatusChangeCallback = (
  16263. result: OnNetworkStatusChangeCallbackResult
  16264. ) => void
  16265. /** 弱网状态变化事件的回调函数 */
  16266. type OnNetworkWeakChangeCallback = (
  16267. result: OnNetworkWeakChangeCallbackResult
  16268. ) => void
  16269. /** WebSocket 连接打开事件的回调函数 */
  16270. type OnOpenCallback = (result: OnOpenCallbackResult) => void
  16271. type OnPauseCallback = (res: GeneralCallbackResult) => void
  16272. type OnPlayCallback = (res: GeneralCallbackResult) => void
  16273. /** worker线程被系统回收事件的回调函数 */
  16274. type OnProcessKilledCallback = (res: GeneralCallbackResult) => void
  16275. /** 视频下载(缓冲)事件的回调函数 */
  16276. type OnProgressCallback = (result: OnProgressCallbackResult) => void
  16277. /** 录音继续事件的回调函数 */
  16278. type OnResumeCallback = (res: GeneralCallbackResult) => void
  16279. /** 的回调函数 */
  16280. type OnRoomInfoChangeCallback = (
  16281. result: GameServerManagerOnRoomInfoChangeCallbackResult
  16282. ) => void
  16283. /** 音频完成跳转操作的事件的回调函数 */
  16284. type OnSeekedCallback = (res: GeneralCallbackResult) => void
  16285. /** 音频进行跳转操作的事件的回调函数 */
  16286. type OnSeekingCallback = (res: GeneralCallbackResult) => void
  16287. /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
  16288. type OnShareAppMessageCallback = (
  16289. result: OnShareAppMessageCallbackResult
  16290. ) => void
  16291. /** 的回调函数 */
  16292. type OnShareMessageToFriendCallback = (
  16293. result: OnShareMessageToFriendCallbackResult
  16294. ) => void
  16295. /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
  16296. type OnShareTimelineCallback = (
  16297. result: OnShareTimelineCallbackResult
  16298. ) => void
  16299. /** 小游戏回到前台的事件的回调函数 */
  16300. type OnShowCallback = (result: OnShowCallbackResult) => void
  16301. /** WebSocket 连接关闭事件的回调函数 */
  16302. type OnSocketCloseCallback = (
  16303. result: SocketTaskOnCloseCallbackResult
  16304. ) => void
  16305. /** WebSocket 错误事件的回调函数 */
  16306. type OnSocketErrorCallback = (result: GeneralCallbackResult) => void
  16307. /** WebSocket 接受到服务器的消息事件的回调函数 */
  16308. type OnSocketMessageCallback = (
  16309. result: SocketTaskOnMessageCallbackResult
  16310. ) => void
  16311. /** WebSocket 连接打开事件的回调函数 */
  16312. type OnSocketOpenCallback = (result: OnSocketOpenCallbackResult) => void
  16313. /** 录音开始事件的回调函数 */
  16314. type OnStartCallback = (res: GeneralCallbackResult) => void
  16315. /** 的回调函数 */
  16316. type OnStateUpdateCallback = (
  16317. result: GameServerManagerOnStateUpdateCallbackResult
  16318. ) => void
  16319. /** 的回调函数 */
  16320. type OnSyncFrameCallback = (result: OnSyncFrameCallbackResult) => void
  16321. /** 触点失效事件的回调函数 */
  16322. type OnTouchCancelCallback = (result: OnTouchStartCallbackResult) => void
  16323. /** 触摸结束事件的回调函数 */
  16324. type OnTouchEndCallback = (result: OnTouchStartCallbackResult) => void
  16325. /** 触点移动事件的回调函数 */
  16326. type OnTouchMoveCallback = (result: OnTouchStartCallbackResult) => void
  16327. /** 开始触摸事件的回调函数 */
  16328. type OnTouchStartCallback = (result: OnTouchStartCallbackResult) => void
  16329. /** 未处理的 Promise 拒绝事件的回调函数 */
  16330. type OnUnhandledRejectionCallback = (
  16331. result: OnUnhandledRejectionCallbackResult
  16332. ) => void
  16333. /** 小程序更新失败事件的回调函数 */
  16334. type OnUpdateFailedCallback = (res: GeneralCallbackResult) => void
  16335. /** 小程序有版本更新事件的回调函数 */
  16336. type OnUpdateReadyCallback = (res: GeneralCallbackResult) => void
  16337. /** 用户主动截屏事件的回调函数 */
  16338. type OnUserCaptureScreenCallback = (res: GeneralCallbackResult) => void
  16339. /** 被动断开实时语音通话事件的回调函数 */
  16340. type OnVoIPChatInterruptedCallback = (
  16341. result: OnVoIPChatInterruptedCallbackResult
  16342. ) => void
  16343. /** 实时语音通话成员在线状态变化事件的回调函数 */
  16344. type OnVoIPChatMembersChangedCallback = (
  16345. result: OnVoIPChatMembersChangedCallbackResult
  16346. ) => void
  16347. /** 实时语音通话成员通话状态变化事件的回调函数 */
  16348. type OnVoIPChatSpeakersChangedCallback = (
  16349. result: OnVoIPChatSpeakersChangedCallbackResult
  16350. ) => void
  16351. /** 房间状态变化事件的回调函数 */
  16352. type OnVoIPChatStateChangedCallback = (
  16353. result: OnVoIPChatStateChangedCallbackResult
  16354. ) => void
  16355. type OnWaitingCallback = (res: GeneralCallbackResult) => void
  16356. /** 鼠标滚轮事件的回调函数 */
  16357. type OnWheelCallback = (result: OnWheelCallbackResult) => void
  16358. /** 窗口尺寸变化事件的回调函数 */
  16359. type OnWindowResizeCallback = (result: OnWindowResizeCallbackResult) => void
  16360. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16361. type OpenBluetoothAdapterCompleteCallback = (res: BluetoothError) => void
  16362. /** 接口调用失败的回调函数 */
  16363. type OpenBluetoothAdapterFailCallback = (res: BluetoothError) => void
  16364. /** 接口调用成功的回调函数 */
  16365. type OpenBluetoothAdapterSuccessCallback = (res: BluetoothError) => void
  16366. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16367. type OpenCardCompleteCallback = (res: GeneralCallbackResult) => void
  16368. /** 接口调用失败的回调函数 */
  16369. type OpenCardFailCallback = (res: GeneralCallbackResult) => void
  16370. /** 接口调用成功的回调函数 */
  16371. type OpenCardSuccessCallback = (res: GeneralCallbackResult) => void
  16372. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16373. type OpenChannelsActivityCompleteCallback = (
  16374. res: GeneralCallbackResult
  16375. ) => void
  16376. /** 接口调用失败的回调函数 */
  16377. type OpenChannelsActivityFailCallback = (res: GeneralCallbackResult) => void
  16378. /** 接口调用成功的回调函数 */
  16379. type OpenChannelsActivitySuccessCallback = (
  16380. res: GeneralCallbackResult
  16381. ) => void
  16382. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16383. type OpenChannelsEventCompleteCallback = (
  16384. res: GeneralCallbackResult
  16385. ) => void
  16386. /** 接口调用失败的回调函数 */
  16387. type OpenChannelsEventFailCallback = (res: GeneralCallbackResult) => void
  16388. /** 接口调用成功的回调函数 */
  16389. type OpenChannelsEventSuccessCallback = (res: GeneralCallbackResult) => void
  16390. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16391. type OpenChannelsLiveCompleteCallback = (res: GeneralCallbackResult) => void
  16392. /** 接口调用失败的回调函数 */
  16393. type OpenChannelsLiveFailCallback = (res: GeneralCallbackResult) => void
  16394. /** 接口调用成功的回调函数 */
  16395. type OpenChannelsLiveSuccessCallback = (res: GeneralCallbackResult) => void
  16396. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16397. type OpenChannelsUserProfileCompleteCallback = (
  16398. res: GeneralCallbackResult
  16399. ) => void
  16400. /** 接口调用失败的回调函数 */
  16401. type OpenChannelsUserProfileFailCallback = (
  16402. res: GeneralCallbackResult
  16403. ) => void
  16404. /** 接口调用成功的回调函数 */
  16405. type OpenChannelsUserProfileSuccessCallback = (
  16406. res: GeneralCallbackResult
  16407. ) => void
  16408. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16409. type OpenCompleteCallback = (res: GeneralCallbackResult) => void
  16410. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16411. type OpenCustomerServiceConversationCompleteCallback = (
  16412. res: GeneralCallbackResult
  16413. ) => void
  16414. /** 接口调用失败的回调函数 */
  16415. type OpenCustomerServiceConversationFailCallback = (
  16416. res: GeneralCallbackResult
  16417. ) => void
  16418. /** 接口调用成功的回调函数 */
  16419. type OpenCustomerServiceConversationSuccessCallback = (
  16420. res: GeneralCallbackResult
  16421. ) => void
  16422. /** 接口调用失败的回调函数 */
  16423. type OpenFailCallback = (result: OpenFailCallbackResult) => void
  16424. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16425. type OpenSettingCompleteCallback = (res: GeneralCallbackResult) => void
  16426. /** 接口调用失败的回调函数 */
  16427. type OpenSettingFailCallback = (res: GeneralCallbackResult) => void
  16428. /** 接口调用成功的回调函数 */
  16429. type OpenSettingSuccessCallback = (
  16430. result: OpenSettingSuccessCallbackResult
  16431. ) => void
  16432. /** 接口调用成功的回调函数 */
  16433. type OpenSuccessCallback = (result: OpenSuccessCallbackResult) => void
  16434. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16435. type OwnerLeaveRoomCompleteCallback = (res: GeneralCallbackResult) => void
  16436. /** 接口调用失败的回调函数 */
  16437. type OwnerLeaveRoomFailCallback = (res: GeneralCallbackResult) => void
  16438. /** 接口调用成功的回调函数 */
  16439. type OwnerLeaveRoomSuccessCallback = (res: GeneralCallbackResult) => void
  16440. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16441. type PreviewImageCompleteCallback = (res: GeneralCallbackResult) => void
  16442. /** 接口调用失败的回调函数 */
  16443. type PreviewImageFailCallback = (res: GeneralCallbackResult) => void
  16444. /** 接口调用成功的回调函数 */
  16445. type PreviewImageSuccessCallback = (res: GeneralCallbackResult) => void
  16446. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16447. type PreviewMediaCompleteCallback = (res: GeneralCallbackResult) => void
  16448. /** 接口调用失败的回调函数 */
  16449. type PreviewMediaFailCallback = (res: GeneralCallbackResult) => void
  16450. /** 接口调用成功的回调函数 */
  16451. type PreviewMediaSuccessCallback = (res: GeneralCallbackResult) => void
  16452. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16453. type ReadBLECharacteristicValueCompleteCallback = (
  16454. res: BluetoothError
  16455. ) => void
  16456. /** 接口调用失败的回调函数 */
  16457. type ReadBLECharacteristicValueFailCallback = (res: BluetoothError) => void
  16458. /** 接口调用成功的回调函数 */
  16459. type ReadBLECharacteristicValueSuccessCallback = (
  16460. res: BluetoothError
  16461. ) => void
  16462. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16463. type ReadCompleteCallback = (res: GeneralCallbackResult) => void
  16464. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16465. type ReadCompressedFileCompleteCallback = (
  16466. res: GeneralCallbackResult
  16467. ) => void
  16468. /** 接口调用失败的回调函数 */
  16469. type ReadCompressedFileFailCallback = (
  16470. result: ReadCompressedFileFailCallbackResult
  16471. ) => void
  16472. /** 接口调用成功的回调函数 */
  16473. type ReadCompressedFileSuccessCallback = (
  16474. result: ReadCompressedFileSuccessCallbackResult
  16475. ) => void
  16476. /** 接口调用失败的回调函数 */
  16477. type ReadFailCallback = (result: ReadFailCallbackResult) => void
  16478. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16479. type ReadFileCompleteCallback = (res: GeneralCallbackResult) => void
  16480. /** 接口调用失败的回调函数 */
  16481. type ReadFileFailCallback = (result: ReadFileFailCallbackResult) => void
  16482. /** 接口调用成功的回调函数 */
  16483. type ReadFileSuccessCallback = (
  16484. result: ReadFileSuccessCallbackResult
  16485. ) => void
  16486. /** 接口调用成功的回调函数 */
  16487. type ReadSuccessCallback = (result: ReadSuccessCallbackResult) => void
  16488. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16489. type ReadZipEntryCompleteCallback = (res: GeneralCallbackResult) => void
  16490. /** 接口调用失败的回调函数 */
  16491. type ReadZipEntryFailCallback = (result: ReadFileFailCallbackResult) => void
  16492. /** 接口调用成功的回调函数 */
  16493. type ReadZipEntrySuccessCallback = (
  16494. result: ReadZipEntrySuccessCallbackResult
  16495. ) => void
  16496. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16497. type ReaddirCompleteCallback = (res: GeneralCallbackResult) => void
  16498. /** 接口调用失败的回调函数 */
  16499. type ReaddirFailCallback = (result: ReaddirFailCallbackResult) => void
  16500. /** 接口调用成功的回调函数 */
  16501. type ReaddirSuccessCallback = (result: ReaddirSuccessCallbackResult) => void
  16502. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16503. type ReconnectCompleteCallback = (res: GeneralCallbackResult) => void
  16504. /** 接口调用失败的回调函数 */
  16505. type ReconnectFailCallback = (res: GeneralCallbackResult) => void
  16506. /** 接口调用成功的回调函数 */
  16507. type ReconnectSuccessCallback = (
  16508. result: ReconnectSuccessCallbackResult
  16509. ) => void
  16510. /** 录音结束事件的回调函数 */
  16511. type RecorderManagerOnStopCallback = (result: OnStopCallbackResult) => void
  16512. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16513. type RemoveSavedFileCompleteCallback = (res: GeneralCallbackResult) => void
  16514. /** 接口调用失败的回调函数 */
  16515. type RemoveSavedFileFailCallback = (
  16516. result: RemoveSavedFileFailCallbackResult
  16517. ) => void
  16518. /** 接口调用成功的回调函数 */
  16519. type RemoveSavedFileSuccessCallback = (res: GeneralCallbackResult) => void
  16520. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16521. type RemoveServiceCompleteCallback = (res: GeneralCallbackResult) => void
  16522. /** 接口调用失败的回调函数 */
  16523. type RemoveServiceFailCallback = (res: GeneralCallbackResult) => void
  16524. /** 接口调用成功的回调函数 */
  16525. type RemoveServiceSuccessCallback = (res: GeneralCallbackResult) => void
  16526. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16527. type RemoveStorageCompleteCallback = (res: GeneralCallbackResult) => void
  16528. /** 接口调用失败的回调函数 */
  16529. type RemoveStorageFailCallback = (res: GeneralCallbackResult) => void
  16530. /** 接口调用成功的回调函数 */
  16531. type RemoveStorageSuccessCallback = (res: GeneralCallbackResult) => void
  16532. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16533. type RemoveUserCloudStorageCompleteCallback = (
  16534. res: GeneralCallbackResult
  16535. ) => void
  16536. /** 接口调用失败的回调函数 */
  16537. type RemoveUserCloudStorageFailCallback = (
  16538. res: GeneralCallbackResult
  16539. ) => void
  16540. /** 接口调用成功的回调函数 */
  16541. type RemoveUserCloudStorageSuccessCallback = (
  16542. res: GeneralCallbackResult
  16543. ) => void
  16544. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16545. type RenameCompleteCallback = (res: GeneralCallbackResult) => void
  16546. /** 接口调用失败的回调函数 */
  16547. type RenameFailCallback = (result: RenameFailCallbackResult) => void
  16548. /** 接口调用成功的回调函数 */
  16549. type RenameSuccessCallback = (res: GeneralCallbackResult) => void
  16550. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16551. type RequestCompleteCallback = (res: GeneralCallbackResult) => void
  16552. /** 接口调用失败的回调函数 */
  16553. type RequestFailCallback = (res: GeneralCallbackResult) => void
  16554. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16555. type RequestMidasFriendPaymentCompleteCallback = (
  16556. res: MidasFriendPaymentError
  16557. ) => void
  16558. /** 接口调用失败的回调函数 */
  16559. type RequestMidasFriendPaymentFailCallback = (
  16560. res: MidasFriendPaymentError
  16561. ) => void
  16562. /** 接口调用成功的回调函数 */
  16563. type RequestMidasFriendPaymentSuccessCallback = (
  16564. result: RequestMidasFriendPaymentSuccessCallbackResult
  16565. ) => void
  16566. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16567. type RequestMidasPaymentCompleteCallback = (res: MidasPaymentError) => void
  16568. /** 接口调用失败的回调函数 */
  16569. type RequestMidasPaymentFailCallback = (res: MidasPaymentError) => void
  16570. /** 接口调用成功的回调函数 */
  16571. type RequestMidasPaymentSuccessCallback = (
  16572. result: GeneralCallbackResult
  16573. ) => void
  16574. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16575. type RequestSubscribeMessageCompleteCallback = (
  16576. res: GeneralCallbackResult
  16577. ) => void
  16578. /** 接口调用失败的回调函数 */
  16579. type RequestSubscribeMessageFailCallback = (
  16580. result: RequestSubscribeMessageFailCallbackResult
  16581. ) => void
  16582. /** 接口调用成功的回调函数 */
  16583. type RequestSubscribeMessageSuccessCallback = (
  16584. result: RequestSubscribeMessageSuccessCallbackResult
  16585. ) => void
  16586. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16587. type RequestSubscribeSystemMessageCompleteCallback = (
  16588. res: GeneralCallbackResult
  16589. ) => void
  16590. /** 接口调用失败的回调函数 */
  16591. type RequestSubscribeSystemMessageFailCallback = (
  16592. result: RequestSubscribeMessageFailCallbackResult
  16593. ) => void
  16594. /** 接口调用成功的回调函数 */
  16595. type RequestSubscribeSystemMessageSuccessCallback = (
  16596. result: RequestSubscribeSystemMessageSuccessCallbackResult
  16597. ) => void
  16598. /** 接口调用成功的回调函数 */
  16599. type RequestSuccessCallback<
  16600. T extends string | IAnyObject | ArrayBuffer =
  16601. | string
  16602. | IAnyObject
  16603. | ArrayBuffer
  16604. > = (result: RequestSuccessCallbackResult<T>) => void
  16605. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16606. type RestartCompleteCallback = (res: GeneralCallbackResult) => void
  16607. /** 接口调用失败的回调函数 */
  16608. type RestartFailCallback = (res: GeneralCallbackResult) => void
  16609. /** 接口调用成功的回调函数 */
  16610. type RestartSuccessCallback = (res: GeneralCallbackResult) => void
  16611. /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
  16612. type RewardedVideoAdOffCloseCallback = (
  16613. result: RewardedVideoAdOnCloseCallbackResult
  16614. ) => void
  16615. /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
  16616. type RewardedVideoAdOnCloseCallback = (
  16617. result: RewardedVideoAdOnCloseCallbackResult
  16618. ) => void
  16619. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16620. type RmdirCompleteCallback = (res: GeneralCallbackResult) => void
  16621. /** 接口调用失败的回调函数 */
  16622. type RmdirFailCallback = (result: RmdirFailCallbackResult) => void
  16623. /** 接口调用成功的回调函数 */
  16624. type RmdirSuccessCallback = (res: GeneralCallbackResult) => void
  16625. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16626. type SaveFileCompleteCallback = (res: GeneralCallbackResult) => void
  16627. /** 接口调用失败的回调函数 */
  16628. type SaveFileFailCallback = (result: SaveFileFailCallbackResult) => void
  16629. /** 接口调用成功的回调函数 */
  16630. type SaveFileSuccessCallback = (
  16631. result: SaveFileSuccessCallbackResult
  16632. ) => void
  16633. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16634. type SaveFileToDiskCompleteCallback = (res: GeneralCallbackResult) => void
  16635. /** 接口调用失败的回调函数 */
  16636. type SaveFileToDiskFailCallback = (res: GeneralCallbackResult) => void
  16637. /** 接口调用成功的回调函数 */
  16638. type SaveFileToDiskSuccessCallback = (res: GeneralCallbackResult) => void
  16639. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16640. type SaveImageToPhotosAlbumCompleteCallback = (
  16641. res: GeneralCallbackResult
  16642. ) => void
  16643. /** 接口调用失败的回调函数 */
  16644. type SaveImageToPhotosAlbumFailCallback = (
  16645. res: GeneralCallbackResult
  16646. ) => void
  16647. /** 接口调用成功的回调函数 */
  16648. type SaveImageToPhotosAlbumSuccessCallback = (
  16649. res: GeneralCallbackResult
  16650. ) => void
  16651. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16652. type ScanCodeCompleteCallback = (res: GeneralCallbackResult) => void
  16653. /** 接口调用失败的回调函数 */
  16654. type ScanCodeFailCallback = (res: GeneralCallbackResult) => void
  16655. /** 接口调用成功的回调函数 */
  16656. type ScanCodeSuccessCallback = (
  16657. result: ScanCodeSuccessCallbackResult
  16658. ) => void
  16659. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16660. type SendCompleteCallback = (res: GeneralCallbackResult) => void
  16661. /** 接口调用失败的回调函数 */
  16662. type SendFailCallback = (res: GeneralCallbackResult) => void
  16663. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16664. type SendSocketMessageCompleteCallback = (
  16665. res: GeneralCallbackResult
  16666. ) => void
  16667. /** 接口调用失败的回调函数 */
  16668. type SendSocketMessageFailCallback = (res: GeneralCallbackResult) => void
  16669. /** 接口调用成功的回调函数 */
  16670. type SendSocketMessageSuccessCallback = (res: GeneralCallbackResult) => void
  16671. /** 接口调用成功的回调函数 */
  16672. type SendSuccessCallback = (res: GeneralCallbackResult) => void
  16673. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16674. type SetBLEMTUCompleteCallback = (res: GeneralCallbackResult) => void
  16675. /** 接口调用失败的回调函数 */
  16676. type SetBLEMTUFailCallback = (result: SetBLEMTUFailCallbackResult) => void
  16677. /** 接口调用成功的回调函数 */
  16678. type SetBLEMTUSuccessCallback = (
  16679. result: SetBLEMTUSuccessCallbackResult
  16680. ) => void
  16681. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16682. type SetClipboardDataCompleteCallback = (res: GeneralCallbackResult) => void
  16683. /** 接口调用失败的回调函数 */
  16684. type SetClipboardDataFailCallback = (res: GeneralCallbackResult) => void
  16685. /** 接口调用成功的回调函数 */
  16686. type SetClipboardDataSuccessCallback = (res: GeneralCallbackResult) => void
  16687. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16688. type SetEnableDebugCompleteCallback = (res: GeneralCallbackResult) => void
  16689. /** 接口调用失败的回调函数 */
  16690. type SetEnableDebugFailCallback = (res: GeneralCallbackResult) => void
  16691. /** 接口调用成功的回调函数 */
  16692. type SetEnableDebugSuccessCallback = (res: GeneralCallbackResult) => void
  16693. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16694. type SetInnerAudioOptionCompleteCallback = (
  16695. res: GeneralCallbackResult
  16696. ) => void
  16697. /** 接口调用失败的回调函数 */
  16698. type SetInnerAudioOptionFailCallback = (res: GeneralCallbackResult) => void
  16699. /** 接口调用成功的回调函数 */
  16700. type SetInnerAudioOptionSuccessCallback = (
  16701. res: GeneralCallbackResult
  16702. ) => void
  16703. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16704. type SetKeepScreenOnCompleteCallback = (res: GeneralCallbackResult) => void
  16705. /** 接口调用失败的回调函数 */
  16706. type SetKeepScreenOnFailCallback = (res: GeneralCallbackResult) => void
  16707. /** 接口调用成功的回调函数 */
  16708. type SetKeepScreenOnSuccessCallback = (res: GeneralCallbackResult) => void
  16709. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16710. type SetMenuStyleCompleteCallback = (res: GeneralCallbackResult) => void
  16711. /** 接口调用失败的回调函数 */
  16712. type SetMenuStyleFailCallback = (res: GeneralCallbackResult) => void
  16713. /** 接口调用成功的回调函数 */
  16714. type SetMenuStyleSuccessCallback = (res: GeneralCallbackResult) => void
  16715. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16716. type SetScreenBrightnessCompleteCallback = (
  16717. res: GeneralCallbackResult
  16718. ) => void
  16719. /** 接口调用失败的回调函数 */
  16720. type SetScreenBrightnessFailCallback = (res: GeneralCallbackResult) => void
  16721. /** 接口调用成功的回调函数 */
  16722. type SetScreenBrightnessSuccessCallback = (
  16723. res: GeneralCallbackResult
  16724. ) => void
  16725. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16726. type SetStateCompleteCallback = (res: GeneralCallbackResult) => void
  16727. /** 接口调用失败的回调函数 */
  16728. type SetStateFailCallback = (res: GeneralCallbackResult) => void
  16729. /** 接口调用成功的回调函数 */
  16730. type SetStateSuccessCallback = (res: GeneralCallbackResult) => void
  16731. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16732. type SetStatusBarStyleCompleteCallback = (
  16733. res: GeneralCallbackResult
  16734. ) => void
  16735. /** 接口调用失败的回调函数 */
  16736. type SetStatusBarStyleFailCallback = (res: GeneralCallbackResult) => void
  16737. /** 接口调用成功的回调函数 */
  16738. type SetStatusBarStyleSuccessCallback = (res: GeneralCallbackResult) => void
  16739. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16740. type SetStorageCompleteCallback = (res: GeneralCallbackResult) => void
  16741. /** 接口调用失败的回调函数 */
  16742. type SetStorageFailCallback = (res: GeneralCallbackResult) => void
  16743. /** 接口调用成功的回调函数 */
  16744. type SetStorageSuccessCallback = (res: GeneralCallbackResult) => void
  16745. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16746. type SetUserCloudStorageCompleteCallback = (
  16747. res: GeneralCallbackResult
  16748. ) => void
  16749. /** 接口调用失败的回调函数 */
  16750. type SetUserCloudStorageFailCallback = (res: GeneralCallbackResult) => void
  16751. /** 接口调用成功的回调函数 */
  16752. type SetUserCloudStorageSuccessCallback = (
  16753. res: GeneralCallbackResult
  16754. ) => void
  16755. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16756. type SetWindowSizeCompleteCallback = (res: GeneralCallbackResult) => void
  16757. /** 接口调用失败的回调函数 */
  16758. type SetWindowSizeFailCallback = (res: GeneralCallbackResult) => void
  16759. /** 接口调用成功的回调函数 */
  16760. type SetWindowSizeSuccessCallback = (res: GeneralCallbackResult) => void
  16761. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16762. type ShareMessageToFriendCompleteCallback = (
  16763. res: GeneralCallbackResult
  16764. ) => void
  16765. /** 接口调用失败的回调函数 */
  16766. type ShareMessageToFriendFailCallback = (res: GeneralCallbackResult) => void
  16767. /** 接口调用成功的回调函数 */
  16768. type ShareMessageToFriendSuccessCallback = (
  16769. res: GeneralCallbackResult
  16770. ) => void
  16771. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16772. type ShowActionSheetCompleteCallback = (res: GeneralCallbackResult) => void
  16773. /** 接口调用失败的回调函数 */
  16774. type ShowActionSheetFailCallback = (res: GeneralCallbackResult) => void
  16775. /** 接口调用成功的回调函数 */
  16776. type ShowActionSheetSuccessCallback = (
  16777. result: ShowActionSheetSuccessCallbackResult
  16778. ) => void
  16779. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16780. type ShowKeyboardCompleteCallback = (res: GeneralCallbackResult) => void
  16781. /** 接口调用失败的回调函数 */
  16782. type ShowKeyboardFailCallback = (res: GeneralCallbackResult) => void
  16783. /** 接口调用成功的回调函数 */
  16784. type ShowKeyboardSuccessCallback = (res: GeneralCallbackResult) => void
  16785. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16786. type ShowLoadingCompleteCallback = (res: GeneralCallbackResult) => void
  16787. /** 接口调用失败的回调函数 */
  16788. type ShowLoadingFailCallback = (res: GeneralCallbackResult) => void
  16789. /** 接口调用成功的回调函数 */
  16790. type ShowLoadingSuccessCallback = (res: GeneralCallbackResult) => void
  16791. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16792. type ShowModalCompleteCallback = (res: GeneralCallbackResult) => void
  16793. /** 接口调用失败的回调函数 */
  16794. type ShowModalFailCallback = (res: GeneralCallbackResult) => void
  16795. /** 接口调用成功的回调函数 */
  16796. type ShowModalSuccessCallback = (
  16797. result: ShowModalSuccessCallbackResult
  16798. ) => void
  16799. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16800. type ShowShareImageMenuCompleteCallback = (
  16801. res: GeneralCallbackResult
  16802. ) => void
  16803. /** 接口调用失败的回调函数 */
  16804. type ShowShareImageMenuFailCallback = (res: GeneralCallbackResult) => void
  16805. /** 接口调用成功的回调函数 */
  16806. type ShowShareImageMenuSuccessCallback = (
  16807. res: GeneralCallbackResult
  16808. ) => void
  16809. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16810. type ShowShareMenuCompleteCallback = (res: GeneralCallbackResult) => void
  16811. /** 接口调用失败的回调函数 */
  16812. type ShowShareMenuFailCallback = (res: GeneralCallbackResult) => void
  16813. /** 接口调用成功的回调函数 */
  16814. type ShowShareMenuSuccessCallback = (res: GeneralCallbackResult) => void
  16815. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16816. type ShowToastCompleteCallback = (res: GeneralCallbackResult) => void
  16817. /** 接口调用失败的回调函数 */
  16818. type ShowToastFailCallback = (res: GeneralCallbackResult) => void
  16819. /** 接口调用成功的回调函数 */
  16820. type ShowToastSuccessCallback = (res: GeneralCallbackResult) => void
  16821. /** 接口调用失败的回调函数 */
  16822. type SocketTaskCloseFailCallback = (res: GeneralCallbackResult) => void
  16823. /** WebSocket 连接关闭事件的回调函数 */
  16824. type SocketTaskOnCloseCallback = (
  16825. result: SocketTaskOnCloseCallbackResult
  16826. ) => void
  16827. /** WebSocket 接受到服务器的消息事件的回调函数 */
  16828. type SocketTaskOnMessageCallback = (
  16829. result: SocketTaskOnMessageCallbackResult
  16830. ) => void
  16831. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16832. type StartAccelerometerCompleteCallback = (
  16833. res: GeneralCallbackResult
  16834. ) => void
  16835. /** 接口调用失败的回调函数 */
  16836. type StartAccelerometerFailCallback = (res: GeneralCallbackResult) => void
  16837. /** 接口调用成功的回调函数 */
  16838. type StartAccelerometerSuccessCallback = (
  16839. res: GeneralCallbackResult
  16840. ) => void
  16841. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16842. type StartAdvertisingCompleteCallback = (res: GeneralCallbackResult) => void
  16843. /** 接口调用失败的回调函数 */
  16844. type StartAdvertisingFailCallback = (res: GeneralCallbackResult) => void
  16845. /** 接口调用成功的回调函数 */
  16846. type StartAdvertisingSuccessCallback = (res: GeneralCallbackResult) => void
  16847. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16848. type StartBeaconDiscoveryCompleteCallback = (res: BeaconError) => void
  16849. /** 接口调用失败的回调函数 */
  16850. type StartBeaconDiscoveryFailCallback = (res: BeaconError) => void
  16851. /** 接口调用成功的回调函数 */
  16852. type StartBeaconDiscoverySuccessCallback = (res: BeaconError) => void
  16853. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16854. type StartBluetoothDevicesDiscoveryCompleteCallback = (
  16855. res: BluetoothError
  16856. ) => void
  16857. /** 接口调用失败的回调函数 */
  16858. type StartBluetoothDevicesDiscoveryFailCallback = (
  16859. res: BluetoothError
  16860. ) => void
  16861. /** 接口调用成功的回调函数 */
  16862. type StartBluetoothDevicesDiscoverySuccessCallback = (
  16863. res: BluetoothError
  16864. ) => void
  16865. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16866. type StartCompassCompleteCallback = (res: GeneralCallbackResult) => void
  16867. /** 接口调用失败的回调函数 */
  16868. type StartCompassFailCallback = (res: GeneralCallbackResult) => void
  16869. /** 接口调用成功的回调函数 */
  16870. type StartCompassSuccessCallback = (res: GeneralCallbackResult) => void
  16871. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16872. type StartDeviceMotionListeningCompleteCallback = (
  16873. res: GeneralCallbackResult
  16874. ) => void
  16875. /** 接口调用失败的回调函数 */
  16876. type StartDeviceMotionListeningFailCallback = (
  16877. res: GeneralCallbackResult
  16878. ) => void
  16879. /** 接口调用成功的回调函数 */
  16880. type StartDeviceMotionListeningSuccessCallback = (
  16881. res: GeneralCallbackResult
  16882. ) => void
  16883. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16884. type StartGameCompleteCallback = (res: GeneralCallbackResult) => void
  16885. /** 接口调用失败的回调函数 */
  16886. type StartGameFailCallback = (res: GeneralCallbackResult) => void
  16887. /** 接口调用成功的回调函数 */
  16888. type StartGameSuccessCallback = (res: GeneralCallbackResult) => void
  16889. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16890. type StartGyroscopeCompleteCallback = (res: GeneralCallbackResult) => void
  16891. /** 接口调用失败的回调函数 */
  16892. type StartGyroscopeFailCallback = (res: GeneralCallbackResult) => void
  16893. /** 接口调用成功的回调函数 */
  16894. type StartGyroscopeSuccessCallback = (res: GeneralCallbackResult) => void
  16895. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16896. type StartHandoffCompleteCallback = (res: GeneralCallbackResult) => void
  16897. /** 接口调用失败的回调函数 */
  16898. type StartHandoffFailCallback = (res: GeneralCallbackResult) => void
  16899. /** 接口调用成功的回调函数 */
  16900. type StartHandoffSuccessCallback = (res: GeneralCallbackResult) => void
  16901. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16902. type StartMatchCompleteCallback = (res: GeneralCallbackResult) => void
  16903. /** 接口调用失败的回调函数 */
  16904. type StartMatchFailCallback = (res: GeneralCallbackResult) => void
  16905. /** 接口调用成功的回调函数 */
  16906. type StartMatchSuccessCallback = (res: GeneralCallbackResult) => void
  16907. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16908. type StartStateServiceCompleteCallback = (
  16909. res: GeneralCallbackResult
  16910. ) => void
  16911. /** 接口调用失败的回调函数 */
  16912. type StartStateServiceFailCallback = (res: GeneralCallbackResult) => void
  16913. /** 接口调用成功的回调函数 */
  16914. type StartStateServiceSuccessCallback = (res: GeneralCallbackResult) => void
  16915. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16916. type StatCompleteCallback = (res: GeneralCallbackResult) => void
  16917. /** 接口调用失败的回调函数 */
  16918. type StatFailCallback = (result: StatFailCallbackResult) => void
  16919. /** 接口调用成功的回调函数 */
  16920. type StatSuccessCallback = (result: StatSuccessCallbackResult) => void
  16921. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16922. type StopAccelerometerCompleteCallback = (
  16923. res: GeneralCallbackResult
  16924. ) => void
  16925. /** 接口调用失败的回调函数 */
  16926. type StopAccelerometerFailCallback = (res: GeneralCallbackResult) => void
  16927. /** 接口调用成功的回调函数 */
  16928. type StopAccelerometerSuccessCallback = (res: GeneralCallbackResult) => void
  16929. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16930. type StopAdvertisingCompleteCallback = (res: GeneralCallbackResult) => void
  16931. /** 接口调用失败的回调函数 */
  16932. type StopAdvertisingFailCallback = (res: GeneralCallbackResult) => void
  16933. /** 接口调用成功的回调函数 */
  16934. type StopAdvertisingSuccessCallback = (res: GeneralCallbackResult) => void
  16935. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16936. type StopBeaconDiscoveryCompleteCallback = (res: BeaconError) => void
  16937. /** 接口调用失败的回调函数 */
  16938. type StopBeaconDiscoveryFailCallback = (res: BeaconError) => void
  16939. /** 接口调用成功的回调函数 */
  16940. type StopBeaconDiscoverySuccessCallback = (res: BeaconError) => void
  16941. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16942. type StopBluetoothDevicesDiscoveryCompleteCallback = (
  16943. res: BluetoothError
  16944. ) => void
  16945. /** 接口调用失败的回调函数 */
  16946. type StopBluetoothDevicesDiscoveryFailCallback = (
  16947. res: BluetoothError
  16948. ) => void
  16949. /** 接口调用成功的回调函数 */
  16950. type StopBluetoothDevicesDiscoverySuccessCallback = (
  16951. res: BluetoothError
  16952. ) => void
  16953. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16954. type StopCompassCompleteCallback = (res: GeneralCallbackResult) => void
  16955. /** 接口调用失败的回调函数 */
  16956. type StopCompassFailCallback = (res: GeneralCallbackResult) => void
  16957. /** 接口调用成功的回调函数 */
  16958. type StopCompassSuccessCallback = (res: GeneralCallbackResult) => void
  16959. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16960. type StopDeviceMotionListeningCompleteCallback = (
  16961. res: GeneralCallbackResult
  16962. ) => void
  16963. /** 接口调用失败的回调函数 */
  16964. type StopDeviceMotionListeningFailCallback = (
  16965. res: GeneralCallbackResult
  16966. ) => void
  16967. /** 接口调用成功的回调函数 */
  16968. type StopDeviceMotionListeningSuccessCallback = (
  16969. res: GeneralCallbackResult
  16970. ) => void
  16971. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16972. type StopFaceDetectCompleteCallback = (res: GeneralCallbackResult) => void
  16973. /** 接口调用失败的回调函数 */
  16974. type StopFaceDetectFailCallback = (res: GeneralCallbackResult) => void
  16975. /** 接口调用成功的回调函数 */
  16976. type StopFaceDetectSuccessCallback = (res: GeneralCallbackResult) => void
  16977. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16978. type StopGyroscopeCompleteCallback = (res: GeneralCallbackResult) => void
  16979. /** 接口调用失败的回调函数 */
  16980. type StopGyroscopeFailCallback = (res: GeneralCallbackResult) => void
  16981. /** 接口调用成功的回调函数 */
  16982. type StopGyroscopeSuccessCallback = (res: GeneralCallbackResult) => void
  16983. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16984. type ToTempFilePathCompleteCallback = (res: GeneralCallbackResult) => void
  16985. /** 接口调用失败的回调函数 */
  16986. type ToTempFilePathFailCallback = (res: GeneralCallbackResult) => void
  16987. /** 接口调用成功的回调函数 */
  16988. type ToTempFilePathSuccessCallback = (
  16989. result: ToTempFilePathSuccessCallbackResult
  16990. ) => void
  16991. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  16992. type TruncateCompleteCallback = (res: GeneralCallbackResult) => void
  16993. /** 接口调用失败的回调函数 */
  16994. type TruncateFailCallback = (result: TruncateFailCallbackResult) => void
  16995. /** 接口调用成功的回调函数 */
  16996. type TruncateSuccessCallback = (res: GeneralCallbackResult) => void
  16997. type UDPSocketOffCloseCallback = (res: GeneralCallbackResult) => void
  16998. /** 错误事件的回调函数 */
  16999. type UDPSocketOffErrorCallback = (result: GeneralCallbackResult) => void
  17000. type UDPSocketOnCloseCallback = (res: GeneralCallbackResult) => void
  17001. type UDPSocketOnErrorCallback = (result: GeneralCallbackResult) => void
  17002. /** 收到消息的事件的回调函数 */
  17003. type UDPSocketOnMessageCallback = (
  17004. result: UDPSocketOnMessageCallbackResult
  17005. ) => void
  17006. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17007. type UnlinkCompleteCallback = (res: GeneralCallbackResult) => void
  17008. /** 接口调用失败的回调函数 */
  17009. type UnlinkFailCallback = (result: UnlinkFailCallbackResult) => void
  17010. /** 接口调用成功的回调函数 */
  17011. type UnlinkSuccessCallback = (res: GeneralCallbackResult) => void
  17012. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17013. type UnzipCompleteCallback = (res: GeneralCallbackResult) => void
  17014. /** 接口调用失败的回调函数 */
  17015. type UnzipFailCallback = (result: UnzipFailCallbackResult) => void
  17016. /** 接口调用成功的回调函数 */
  17017. type UnzipSuccessCallback = (res: GeneralCallbackResult) => void
  17018. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17019. type UpdateKeyboardCompleteCallback = (res: GeneralCallbackResult) => void
  17020. /** 接口调用失败的回调函数 */
  17021. type UpdateKeyboardFailCallback = (res: GeneralCallbackResult) => void
  17022. /** 接口调用成功的回调函数 */
  17023. type UpdateKeyboardSuccessCallback = (res: GeneralCallbackResult) => void
  17024. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17025. type UpdateReadyStatusCompleteCallback = (
  17026. res: GeneralCallbackResult
  17027. ) => void
  17028. /** 接口调用失败的回调函数 */
  17029. type UpdateReadyStatusFailCallback = (res: GeneralCallbackResult) => void
  17030. /** 接口调用成功的回调函数 */
  17031. type UpdateReadyStatusSuccessCallback = (res: GeneralCallbackResult) => void
  17032. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17033. type UpdateShareMenuCompleteCallback = (res: GeneralCallbackResult) => void
  17034. /** 接口调用失败的回调函数 */
  17035. type UpdateShareMenuFailCallback = (res: GeneralCallbackResult) => void
  17036. /** 接口调用成功的回调函数 */
  17037. type UpdateShareMenuSuccessCallback = (res: GeneralCallbackResult) => void
  17038. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17039. type UpdateVoIPChatMuteConfigCompleteCallback = (
  17040. res: GeneralCallbackResult
  17041. ) => void
  17042. /** 接口调用失败的回调函数 */
  17043. type UpdateVoIPChatMuteConfigFailCallback = (
  17044. res: GeneralCallbackResult
  17045. ) => void
  17046. /** 接口调用成功的回调函数 */
  17047. type UpdateVoIPChatMuteConfigSuccessCallback = (
  17048. res: GeneralCallbackResult
  17049. ) => void
  17050. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17051. type UpdateWeChatAppCompleteCallback = (res: GeneralCallbackResult) => void
  17052. /** 接口调用失败的回调函数 */
  17053. type UpdateWeChatAppFailCallback = (res: GeneralCallbackResult) => void
  17054. /** 接口调用成功的回调函数 */
  17055. type UpdateWeChatAppSuccessCallback = (res: GeneralCallbackResult) => void
  17056. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17057. type UploadFileCompleteCallback = (res: GeneralCallbackResult) => void
  17058. /** 接口调用失败的回调函数 */
  17059. type UploadFileFailCallback = (res: GeneralCallbackResult) => void
  17060. /** 接口调用成功的回调函数 */
  17061. type UploadFileSuccessCallback = (
  17062. result: UploadFileSuccessCallbackResult
  17063. ) => void
  17064. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17065. type UploadFrameCompleteCallback = (res: GeneralCallbackResult) => void
  17066. /** 接口调用失败的回调函数 */
  17067. type UploadFrameFailCallback = (res: GeneralCallbackResult) => void
  17068. /** 接口调用成功的回调函数 */
  17069. type UploadFrameSuccessCallback = (res: GeneralCallbackResult) => void
  17070. /** 上传进度变化事件的回调函数 */
  17071. type UploadTaskOffProgressUpdateCallback = (
  17072. result: UploadTaskOnProgressUpdateCallbackResult
  17073. ) => void
  17074. /** 上传进度变化事件的回调函数 */
  17075. type UploadTaskOnProgressUpdateCallback = (
  17076. result: UploadTaskOnProgressUpdateCallbackResult
  17077. ) => void
  17078. /** 用户信息按钮的点击事件的回调函数 */
  17079. type UserInfoButtonOffTapCallback = (result: OnTapCallbackResult) => void
  17080. /** 用户信息按钮的点击事件的回调函数 */
  17081. type UserInfoButtonOnTapCallback = (result: OnTapCallbackResult) => void
  17082. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17083. type VibrateLongCompleteCallback = (res: GeneralCallbackResult) => void
  17084. /** 接口调用失败的回调函数 */
  17085. type VibrateLongFailCallback = (res: GeneralCallbackResult) => void
  17086. /** 接口调用成功的回调函数 */
  17087. type VibrateLongSuccessCallback = (res: GeneralCallbackResult) => void
  17088. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17089. type VibrateShortCompleteCallback = (res: GeneralCallbackResult) => void
  17090. /** 接口调用失败的回调函数 */
  17091. type VibrateShortFailCallback = (res: GeneralCallbackResult) => void
  17092. /** 接口调用成功的回调函数 */
  17093. type VibrateShortSuccessCallback = (res: GeneralCallbackResult) => void
  17094. /** 视频错误事件的回调函数 */
  17095. type VideoOffErrorCallback = (result: VideoOnErrorCallbackResult) => void
  17096. /** 视频播放进度更新事件的回调函数 */
  17097. type VideoOffTimeUpdateCallback = (
  17098. result: OnTimeUpdateCallbackResult
  17099. ) => void
  17100. /** 视频错误事件的回调函数 */
  17101. type VideoOnErrorCallback = (result: VideoOnErrorCallbackResult) => void
  17102. /** 视频播放进度更新事件的回调函数 */
  17103. type VideoOnTimeUpdateCallback = (
  17104. result: OnTimeUpdateCallbackResult
  17105. ) => void
  17106. /** 主线程/Worker 线程向当前线程发送的消息的事件的回调函数 */
  17107. type WorkerOnMessageCallback = (
  17108. result: WorkerOnMessageCallbackResult
  17109. ) => void
  17110. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17111. type WriteBLECharacteristicValueCompleteCallback = (
  17112. res: BluetoothError
  17113. ) => void
  17114. /** 接口调用失败的回调函数 */
  17115. type WriteBLECharacteristicValueFailCallback = (res: BluetoothError) => void
  17116. /** 接口调用成功的回调函数 */
  17117. type WriteBLECharacteristicValueSuccessCallback = (
  17118. res: BluetoothError
  17119. ) => void
  17120. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17121. type WriteCharacteristicValueCompleteCallback = (
  17122. res: GeneralCallbackResult
  17123. ) => void
  17124. /** 接口调用失败的回调函数 */
  17125. type WriteCharacteristicValueFailCallback = (
  17126. res: GeneralCallbackResult
  17127. ) => void
  17128. /** 接口调用成功的回调函数 */
  17129. type WriteCharacteristicValueSuccessCallback = (
  17130. res: GeneralCallbackResult
  17131. ) => void
  17132. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17133. type WriteCompleteCallback = (res: GeneralCallbackResult) => void
  17134. /** 接口调用失败的回调函数 */
  17135. type WriteFailCallback = (result: WriteFailCallbackResult) => void
  17136. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  17137. type WriteFileCompleteCallback = (res: GeneralCallbackResult) => void
  17138. /** 接口调用失败的回调函数 */
  17139. type WriteFileFailCallback = (result: WriteFileFailCallbackResult) => void
  17140. /** 接口调用成功的回调函数 */
  17141. type WriteFileSuccessCallback = (res: GeneralCallbackResult) => void
  17142. /** 接口调用成功的回调函数 */
  17143. type WriteSuccessCallback = (result: WriteSuccessCallbackResult) => void
  17144. /** 接口调用失败的回调函数 */
  17145. type WxGetFileInfoFailCallback = (res: GeneralCallbackResult) => void
  17146. /** 接口调用成功的回调函数 */
  17147. type WxGetFileInfoSuccessCallback = (
  17148. result: WxGetFileInfoSuccessCallbackResult
  17149. ) => void
  17150. /** 全局错误事件的回调函数 */
  17151. type WxOffErrorCallback = (result: WxOnErrorCallbackResult) => void
  17152. /** 全局错误事件的回调函数 */
  17153. type WxOnErrorCallback = (result: WxOnErrorCallbackResult) => void
  17154. }
  17155. /** [cancelAnimationFrame(number requestID)](https://developers.weixin.qq.com/minigame/dev/api/render/frame/cancelAnimationFrame.html)
  17156. *
  17157. * 取消由 requestAnimationFrame 添加到计划中的动画帧请求 */
  17158. declare function cancelAnimationFrame(requestID: number): void
  17159. /** [number requestAnimationFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/render/frame/requestAnimationFrame.html)
  17160. *
  17161. * 在下次进行重绘时执行。 */
  17162. declare function requestAnimationFrame(
  17163. /** 执行的 callback */
  17164. callback: (...args: any[]) => any
  17165. ): number