12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221 |
- /*! *****************************************************************************
- Copyright (c) 2022 Tencent, Inc. All rights reserved.
- Permission is hereby granted, free of charge, to any person obtaining a copy of
- this software and associated documentation files (the "Software"), to deal in
- the Software without restriction, including without limitation the rights to
- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
- of the Software, and to permit persons to whom the Software is furnished to do
- so, subject to the following conditions:
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
- ***************************************************************************** */
- declare namespace WechatMinigame {
- interface AccessFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory ${path}': 文件/目录不存在;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface AccessOption {
- /** 要判断是否存在的文件/目录路径 (本地路径) */
- path: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: AccessCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: AccessFailCallback
- /** 接口调用成功的回调函数 */
- success?: AccessSuccessCallback
- }
- /** 帐号信息 */
- interface AccountInfo {
- /** 小程序帐号信息 */
- miniProgram: MiniProgram
- /** 插件帐号信息(仅在插件中调用时包含这一项) */
- plugin: Plugin
- }
- interface AddCardOption {
- /** 需要添加的卡券列表 */
- cardList: AddCardRequestInfo[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: AddCardCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: AddCardFailCallback
- /** 接口调用成功的回调函数 */
- success?: AddCardSuccessCallback
- }
- /** 需要添加的卡券列表 */
- interface AddCardRequestInfo {
- /** 卡券的扩展参数。需将 CardExt 对象 JSON 序列化为**字符串**传入 */
- cardExt: string
- /** 卡券 ID */
- cardId: string
- }
- /** 卡券添加结果列表 */
- interface AddCardResponseInfo {
- /** 卡券的扩展参数,结构请参考下文 */
- cardExt: string
- /** 用户领取到卡券的 ID */
- cardId: string
- /** 加密 code,为用户领取到卡券的code加密后的字符串,解密请参照:[code 解码接口](https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1499332673_Unm7V) */
- code: string
- /** 是否成功 */
- isSuccess: boolean
- }
- interface AddCardSuccessCallbackResult {
- /** 卡券添加结果列表 */
- cardList: AddCardResponseInfo[]
- errMsg: string
- }
- interface AddServiceOption {
- /** 描述service的Object */
- service: BLEPeripheralService
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: AddServiceCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: AddServiceFailCallback
- /** 接口调用成功的回调函数 */
- success?: AddServiceSuccessCallback
- }
- /** 广播自定义参数 */
- interface AdvertiseReqObj {
- /** 需要基础库: `2.20.1`
- *
- * 以 beacon 设备形式广播的参数。 */
- beacon?: BeaconInfoObj
- /** 当前设备是否可连接 */
- connectable?: boolean
- /** 广播中 deviceName 字段,默认为空 */
- deviceName?: string
- /** 广播的制造商信息。仅安卓支持,iOS 因系统限制无法定制。 */
- manufacturerData?: ManufacturerData[]
- /** 要广播的服务 UUID 列表。使用 16/32 位 UUID 时请参考注意事项。 */
- serviceUuids?: string[]
- }
- interface AppendFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 文件不存在;
- * - 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface AppendFileOption {
- /** 要追加的文本或二进制数据 */
- data: string | ArrayBuffer
- /** 要追加内容的文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: AppendFileCompleteCallback
- /** 指定写入文件的字符编码
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 接口调用失败的回调函数 */
- fail?: AppendFileFailCallback
- /** 接口调用成功的回调函数 */
- success?: AppendFileSuccessCallback
- }
- /** 需要基础库: `2.19.0`
- *
- * AudioBuffer接口表示存在内存里的一段短小的音频资源,利用[WebAudioContext.decodeAudioData](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.decodeAudioData.html)方法从一个音频文件构建,或者利用 [AudioContext.createBuffer](#)从原始数据构建。把音频放入AudioBuffer后,可以传入到一个 AudioBufferSourceNode进行播放。 */
- interface AudioBuffer {
- /** 返回存储在缓存区的PCM数据的时长(单位为秒) */
- duration: number
- /** 返回存储在缓存区的PCM数据的采样帧率 */
- length: number
- /** 储存在缓存区的PCM数据的通道数 */
- numberOfChannels: number
- /** 存储在缓存区的PCM数据的采样率(单位为sample/s) */
- sampleRate: number
- }
- interface AuthPrivateMessageOption {
- /** shareTicket。可以从 wx.onShow 中获取。详情 [shareTicket](#) */
- shareTicket: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: AuthPrivateMessageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: AuthPrivateMessageFailCallback
- /** 接口调用成功的回调函数 */
- success?: AuthPrivateMessageSuccessCallback
- }
- interface AuthPrivateMessageSuccessCallbackResult {
- /** 经过加密的activityId,解密后可得到原始的activityId。若解密后得到的activityId可以与开发者后台的活动id对应上则验证通过,否则表明valid字段不可靠(被篡改) 详细见[加密数据解密算法](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html) */
- encryptedData: string
- /** 错误信息 */
- errMsg: string
- /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- iv: string
- /** 验证是否通过 */
- valid: boolean
- }
- /** 用户授权设置信息,详情参考[权限](#) */
- interface AuthSetting {
- /** 是否授权使用你的微信朋友信息,对应开放数据域内的 [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) 接口。 */
- 'scope.WxFriendInteraction'?: boolean
- /** 是否授权用户信息,对应接口 [wx.getUserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.getUserInfo.html) */
- 'scope.userInfo'?: boolean
- /** 是否授权地理位置,对应接口 [wx.getLocation](https://developers.weixin.qq.com/minigame/dev/api/location/wx.getLocation.html) */
- 'scope.userLocation'?: boolean
- /** 是否授权微信运动步数,对应接口 [wx.getWeRunData](https://developers.weixin.qq.com/minigame/dev/api/open-api/werun/wx.getWeRunData.html) */
- 'scope.werun'?: boolean
- /** 是否授权保存到相册,对应接口 [wx.saveImageToPhotosAlbum](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.saveImageToPhotosAlbum.html) */
- 'scope.writePhotosAlbum'?: boolean
- }
- interface AuthorizeOption {
- /** 需要获取权限的 scope,详见 [scope 列表](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html#scope-列表) */
- scope: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: AuthorizeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: AuthorizeFailCallback
- /** 接口调用成功的回调函数 */
- success?: AuthorizeSuccessCallback
- }
- /** 设备特征列表 */
- interface BLECharacteristic {
- /** 该特征支持的操作类型 */
- properties: BLECharacteristicProperties
- /** 蓝牙设备特征的 UUID */
- uuid: string
- }
- /** 该特征支持的操作类型 */
- interface BLECharacteristicProperties {
- /** 该特征是否支持 indicate 操作 */
- indicate: boolean
- /** 该特征是否支持 notify 操作 */
- notify: boolean
- /** 该特征是否支持 read 操作 */
- read: boolean
- /** 该特征是否支持 write 操作 */
- write: boolean
- }
- /** 描述service的Object */
- interface BLEPeripheralService {
- /** characteristics列表 */
- characteristics: Characteristic[]
- /** 蓝牙服务的 UUID */
- uuid: string
- }
- /** 设备服务列表 */
- interface BLEService {
- /** 该服务是否为主服务 */
- isPrimary: boolean
- /** 蓝牙设备服务的 UUID */
- uuid: string
- }
- /** banner 广告组件。banner 广告组件是一个原生组件,层级比普通组件高。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。 */
- interface BannerAd {
- /** banner 广告组件的样式。style 上的属性的值仅为开发者设置的值,banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。 */
- style: BannerAdStyle
- }
- interface BannerAdOnErrorCallbackResult {
- /** 需要基础库: `2.2.2`
- *
- * 错误码
- *
- * 可选值:
- * - 1000: 后端接口调用失败;
- * - 1001: 参数错误;
- * - 1002: 广告单元无效;
- * - 1003: 内部错误;
- * - 1004: 无合适的广告;
- * - 1005: 广告组件审核中;
- * - 1006: 广告组件被驳回;
- * - 1007: 广告组件被封禁;
- * - 1008: 广告单元已关闭; */
- errCode: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008
- /** 错误信息 */
- errMsg: string
- }
- /** banner 广告组件的样式。style 上的属性的值仅为开发者设置的值,banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。 */
- interface BannerAdStyle {
- /** banner 广告组件的高度 */
- height: number
- /** banner 广告组件的左上角横坐标 */
- left: number
- /** banner 广告组件经过缩放后真实的高度 */
- realHeight: number
- /** banner 广告组件经过缩放后真实的宽度 */
- realWidth: number
- /** banner 广告组件的左上角纵坐标 */
- top: number
- /** banner 广告组件的宽度。最小 300,最大至 `屏幕宽度`(屏幕宽度可以通过 wx.getSystemInfoSync() 获取)。 */
- width: number
- }
- /** Beacon 设备 */
- interface BeaconInfo {
- /** Beacon 设备的距离,单位 m。iOS 上,proximity 为 0 时,accuracy 为 -1。 */
- accuracy: number
- /** Beacon 设备的主 ID */
- major: number
- /** Beacon 设备的次 ID */
- minor: number
- /** 表示设备距离的枚举值(仅iOS)
- *
- * 可选值:
- * - 0: 信号太弱不足以计算距离,或非 iOS 设备;
- * - 1: 十分近;
- * - 2: 比较近;
- * - 3: 远; */
- proximity: 0 | 1 | 2 | 3
- /** 表示设备的信号强度,单位 dBm */
- rssi: number
- /** Beacon 设备广播的 UUID */
- uuid: string
- }
- /** 需要基础库: `2.20.1`
- *
- * 以 beacon 设备形式广播的参数。 */
- interface BeaconInfoObj {
- /** Beacon 设备的主 ID */
- major: number
- /** Beacon 设备的次 ID */
- minor: number
- /** Beacon 设备广播的 UUID */
- uuid: string
- /** 用于判断距离设备 1 米时 RSSI 大小的参考值 */
- measuredPower?: number
- }
- interface BlueToothDevice {
- /** 当前蓝牙设备的信号强度,单位 dBm */
- RSSI: number
- /** 当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。 */
- advertisData: ArrayBuffer
- /** 当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段 */
- advertisServiceUUIDs: string[]
- /** 蓝牙设备 id */
- deviceId: string
- /** 当前蓝牙设备的广播数据段中的 LocalName 数据段 */
- localName: string
- /** 蓝牙设备名称,某些设备可能没有 */
- name: string
- /** 当前蓝牙设备的广播数据段中的 ServiceData 数据段 */
- serviceData: IAnyObject
- }
- /** 搜索到的设备列表 */
- interface BluetoothDeviceInfo {
- /** 用于区分设备的 id */
- deviceId: string
- /** 蓝牙设备名称,某些设备可能没有 */
- name: string
- }
- interface BroadcastInRoomOption {
- /** 广播内容 */
- msg: string
- /** 给座位号为哪些的玩家发送信息,不填代表给房间所有人发送 */
- toPosNumList: number[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: BroadcastInRoomCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: BroadcastInRoomFailCallback
- /** 接口调用成功的回调函数 */
- success?: BroadcastInRoomSuccessCallback
- }
- /** 对局回放的按钮的配置。对局回放按钮的文案不能随意设置,只能选择预设的文案模版。 */
- interface ButtonShare {
- /** 对局回放的按钮的模版。
- *
- * 可选值:
- * - 'enter': 马上玩;
- * - 'challenge': 去挑战;
- * - 'play': 去挑战; */
- template?: 'enter' | 'challenge' | 'play'
- }
- /** 对局回放的按钮。只能选择预设的文案模版。 */
- interface ButtonShareOption {
- /** 对局回放的按钮的模版。
- *
- * 可选值:
- * - 'enter': 马上玩;
- * - 'challenge': 去挑战;
- * - 'play': 玩一把; */
- template?: 'enter' | 'challenge' | 'play'
- }
- /** 相机对象 */
- interface Camera {
- /** 摄像头朝向 */
- devicePosition: string
- /** 闪光灯,值为 auto, on, off */
- flash: string
- /** 相机的高度 */
- height: number
- /** 帧数据图像尺寸,值为 small, medium, large */
- size: string
- /** 相机的宽度 */
- width: number
- /** 相机的左上角横坐标 */
- x: number
- /** 相机的左上角纵坐标 */
- y: number
- }
- interface CancelMatchOption {
- /** 需要取消匹配的matchId */
- matchId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CancelMatchCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CancelMatchFailCallback
- /** 接口调用成功的回调函数 */
- success?: CancelMatchSuccessCallback
- }
- /** 画布对象 */
- interface Canvas {
- /** 画布的高度 */
- height: number
- /** 画布的宽度 */
- width: number
- }
- interface ChangeSeatOption {
- /** 座位号,从 0 开始 */
- posNum: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ChangeSeatCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ChangeSeatFailCallback
- /** 接口调用成功的回调函数 */
- success?: ChangeSeatSuccessCallback
- }
- /** characteristics列表 */
- interface Characteristic {
- /** characteristic 的 UUID */
- uuid: string
- /** 描述符数据 */
- descriptors?: Descriptor[]
- /** 特征权限 */
- permission?: CharacteristicPermission
- /** 特征支持的操作 */
- properties?: CharacteristicProperties
- /** 特征对应的二进制值 */
- value?: ArrayBuffer
- }
- /** 特征权限 */
- interface CharacteristicPermission {
- /** 加密读请求 */
- readEncryptionRequired?: boolean
- /** 可读 */
- readable?: boolean
- /** 加密写请求 */
- writeEncryptionRequired?: boolean
- /** 可写 */
- writeable?: boolean
- }
- /** 特征支持的操作 */
- interface CharacteristicProperties {
- /** 回包 */
- indicate?: boolean
- /** 订阅 */
- notify?: boolean
- /** 读 */
- read?: boolean
- /** 写 */
- write?: boolean
- /** 无回复写 */
- writeNoResponse?: boolean
- }
- interface CheckHandoffEnabledOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CheckHandoffEnabledCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CheckHandoffEnabledFailCallback
- /** 接口调用成功的回调函数 */
- success?: CheckHandoffEnabledSuccessCallback
- }
- interface CheckHandoffEnabledSuccessCallbackResult {
- /** 错误码,0未知,1用户取消,2电脑未登录,3电脑版本过低,4暂未支持 */
- errCode: number
- /** 是否可以进行接力 */
- isEnabled: boolean
- errMsg: string
- }
- interface CheckIsUserAdvisedToRestOption {
- /** 今天已经玩游戏的时间,单位:秒 */
- todayPlayedTime: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CheckIsUserAdvisedToRestCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CheckIsUserAdvisedToRestFailCallback
- /** 接口调用成功的回调函数 */
- success?: CheckIsUserAdvisedToRestSuccessCallback
- }
- interface CheckIsUserAdvisedToRestSuccessCallbackResult {
- /** 是否建议用户休息 */
- result: boolean
- errMsg: string
- }
- interface CheckSessionOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CheckSessionCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CheckSessionFailCallback
- /** 接口调用成功的回调函数 */
- success?: CheckSessionSuccessCallback
- }
- interface ChooseImageOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ChooseImageCompleteCallback
- /** 最多可以选择的图片张数 */
- count?: number
- /** 接口调用失败的回调函数 */
- fail?: ChooseImageFailCallback
- /** 所选的图片的尺寸
- *
- * 可选值:
- * - 'original': 原图;
- * - 'compressed': 压缩图; */
- sizeType?: Array<'original' | 'compressed'>
- /** 选择图片的来源
- *
- * 可选值:
- * - 'album': 从相册选图;
- * - 'camera': 使用相机; */
- sourceType?: Array<'album' | 'camera'>
- /** 接口调用成功的回调函数 */
- success?: ChooseImageSuccessCallback
- }
- interface ChooseImageSuccessCallbackResult {
- /** 图片的本地临时文件路径列表 (本地路径) */
- tempFilePaths: string[]
- /** 需要基础库: `1.2.0`
- *
- * 图片的本地临时文件列表 */
- tempFiles: ImageFile[]
- errMsg: string
- }
- interface ClearStorageOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ClearStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ClearStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: ClearStorageSuccessCallback
- }
- /** 菜单按钮的布局位置信息 */
- interface ClientRect {
- /** 下边界坐标,单位:px */
- bottom: number
- /** 高度,单位:px */
- height: number
- /** 左边界坐标,单位:px */
- left: number
- /** 右边界坐标,单位:px */
- right: number
- /** 上边界坐标,单位:px */
- top: number
- /** 宽度,单位:px */
- width: number
- }
- interface CloseBLEConnectionOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CloseBLEConnectionCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CloseBLEConnectionFailCallback
- /** 接口调用成功的回调函数 */
- success?: CloseBLEConnectionSuccessCallback
- }
- interface CloseBluetoothAdapterOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CloseBluetoothAdapterCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CloseBluetoothAdapterFailCallback
- /** 接口调用成功的回调函数 */
- success?: CloseBluetoothAdapterSuccessCallback
- }
- interface CloseFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'bad file descriptor': 无效的文件描述符; */
- errMsg: string
- }
- interface CloseSocketOption {
- /** 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 */
- code?: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CloseSocketCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CloseSocketFailCallback
- /** 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。 */
- reason?: string
- /** 接口调用成功的回调函数 */
- success?: CloseSocketSuccessCallback
- }
- interface CloseSyncOption {
- /** 需要被关闭的文件描述符。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) 接口获得 */
- fd: string
- }
- interface ConnectOption {
- /** 要发消息的地址 */
- address: string
- /** 要发送消息的端口号 */
- port: number
- }
- interface ConnectSocketOption {
- /** 开发者服务器 wss 接口地址 */
- url: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ConnectSocketCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ConnectSocketFailCallback
- /** HTTP Header,Header 中不能设置 Referer */
- header?: IAnyObject
- /** 需要基础库: `2.8.0`
- *
- * 是否开启压缩扩展 */
- perMessageDeflate?: boolean
- /** 需要基础库: `1.4.0`
- *
- * 子协议数组 */
- protocols?: string[]
- /** 接口调用成功的回调函数 */
- success?: ConnectSocketSuccessCallback
- /** 需要基础库: `2.4.0`
- *
- * 建立 TCP 连接的时候的 TCP_NODELAY 设置 */
- tcpNoDelay?: boolean
- /** 需要基础库: `2.10.0`
- *
- * 超时时间,单位为毫秒 */
- timeout?: number
- }
- /** 一个字典对象,它指定是否应该禁用规范化(默认启用规范化) */
- interface Constraints {
- /** 如果指定为true则禁用标准化,默认为false */
- disableNormalization?: boolean
- }
- /** webgl 上下文属性,仅当 contextType 为 webgl 时有效 */
- interface ContextAttributes {
- /** 需要基础库: `2.11.0`
- *
- * 是否开启透明通道,仅当 contextType 为 webgl 时有效。(开启后,配合wx.createVideo({underGameView: true}) 即可在video组件之上渲染主屏画布) */
- alpha?: number
- /** 表示是否抗锯齿 */
- antialias?: boolean
- /** 抗锯齿样本数。最小值为 2,最大不超过系统限制数量,仅 iOS 支持 */
- antialiasSamples?: number
- /** 表示是否绘图完成后是否保留绘图缓冲区 */
- preserveDrawingBuffer?: boolean
- }
- interface CopyFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail permission denied, copyFile ${srcPath} -> ${destPath}': 指定目标文件路径没有写权限;
- * - 'fail no such file or directory, copyFile ${srcPath} -> ${destPath}': 源文件不存在,或目标文件路径的上层目录不存在;
- * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface CopyFileOption {
- /** 目标文件路径,支持本地路径 */
- destPath: string
- /** 源文件路径,支持本地路径 */
- srcPath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CopyFileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CopyFileFailCallback
- /** 接口调用成功的回调函数 */
- success?: CopyFileSuccessCallback
- }
- interface CreateBLEConnectionOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CreateBLEConnectionCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CreateBLEConnectionFailCallback
- /** 接口调用成功的回调函数 */
- success?: CreateBLEConnectionSuccessCallback
- /** 超时时间,单位 ms,不填表示不会超时 */
- timeout?: number
- }
- interface CreateBLEPeripheralServerOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CreateBLEPeripheralServerCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CreateBLEPeripheralServerFailCallback
- /** 接口调用成功的回调函数 */
- success?: CreateBLEPeripheralServerSuccessCallback
- }
- interface CreateBLEPeripheralServerSuccessCallbackResult {
- /** [BLEPeripheralServer](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.html)
- *
- * 外围设备的服务端。 */
- server: BLEPeripheralServer
- errMsg: string
- }
- interface CreateBannerAdOption {
- /** 广告单元 id */
- adUnitId: string
- /** banner 广告组件的样式 */
- style: CreateBannerAdStyleOption
- /** 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(该参数不传入时 Banner 广告不会自动刷新) */
- adIntervals?: number
- }
- /** banner 广告组件的样式 */
- interface CreateBannerAdStyleOption {
- /** banner 广告组件的高度 */
- height: number
- /** banner 广告组件的左上角横坐标 */
- left: number
- /** banner 广告组件的左上角纵坐标 */
- top: number
- /** banner 广告组件的宽度 */
- width: number
- }
- interface CreateCameraOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CreateCameraCompleteCallback
- /** 摄像头朝向,值为 front, back */
- devicePosition?: string
- /** 接口调用失败的回调函数 */
- fail?: CreateCameraFailCallback
- /** 闪光灯,值为 auto, on, off */
- flash?: string
- /** 相机的高度 */
- height?: number
- /** 帧数据图像尺寸,值为 small, medium, large */
- size?: string
- /** 接口调用成功的回调函数 */
- success?: CreateCameraSuccessCallback
- /** 相机的宽度 */
- width?: number
- /** 相机的左上角横坐标 */
- x?: number
- /** 相机的左上角纵坐标 */
- y?: number
- }
- interface CreateCustomAdOption {
- /** 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(仅对支持自动刷新的模板生效) */
- adIntervals: number
- /** 广告单元 id */
- adUnitId: string
- /** 原生模板广告组件的样式 */
- style: CreateCustomAdStyleOption
- }
- /** 原生模板广告组件的样式 */
- interface CreateCustomAdStyleOption {
- /** (只对小程序适用) 原生模板广告组件是否固定屏幕位置(不跟随屏幕滚动) */
- fixed: boolean
- /** 原生模板广告组件的左上角横坐标 */
- left: number
- /** 原生模板广告组件的左上角纵坐标 */
- top: number
- }
- interface CreateGameBannerOption {
- /** 推荐单元 id */
- adUnitId: string
- /** 小游戏推荐banner组件样式 */
- style: CreateGameBannerStyleOption
- }
- /** 小游戏推荐banner组件样式 */
- interface CreateGameBannerStyleOption {
- /** 小游戏推荐banner组件左上角横坐标 */
- left: number
- /** 小游戏推荐banner组件左上角纵坐标 */
- top: number
- }
- interface CreateGameClubButtonOption {
- /** 游戏圈按钮的图标,仅当 object.type 参数为 image 时有效。
- *
- * 可选值:
- * - 'green': 绿色的图标;
- * - 'white': 白色的图标;
- * - 'dark': 有黑色圆角背景的白色图标;
- * - 'light': 有白色圆角背景的绿色图标; */
- icon: 'green' | 'white' | 'dark' | 'light'
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- interface CreateGameIconOption {
- /** 推荐单元 id */
- adUnitId: string
- /** 游戏icon的数量,请注意,正式版下面渲染出来的icon数量会小于等于count,请注册做好样式兼容 */
- count: number
- /** 数组的每一项可以针对对应的icon设置位置和样式等信息,style的每一项称为styleItem */
- style: any[]
- }
- interface CreateGamePortalOption {
- /** 推荐单元 id。 */
- adUnitId: string
- }
- interface CreateGameRecorderShareButtonOption {
- /** 对局回放的分享参数。 */
- share: ShareOption
- /** 按钮的样式 */
- style: CreateGameRecorderShareButtonStyleOption
- /** 图标的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。 */
- icon?: string
- /** 按钮的背景图片的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。 */
- image?: string
- /** 按钮的文本。 */
- text?: string
- }
- /** 按钮的样式 */
- interface CreateGameRecorderShareButtonStyleOption {
- /** 文本的颜色。 */
- color?: string
- /** 文本的字体大小。最小 17,最大 22。 */
- fontSize?: number
- /** 按钮的高度,最小 40 逻辑像素 */
- height?: number
- /** 图标和文本之间的距离,最小 8 逻辑像素 */
- iconMarginRight?: number
- /** 左上角横坐标,单位 逻辑像素 */
- left?: number
- /** 按钮的左内边距,最小 16 逻辑像素。 */
- paddingLeft?: number
- /** 按钮的右内边距,最小 16 逻辑像素。 */
- paddingRight?: number
- /** 左上角纵坐标,单位 逻辑像素 */
- top?: number
- }
- interface CreateGridAdOption {
- /** grid(格子) 广告广告组件的主题,提供 `white` `black` 两种主题选择。 */
- adTheme: string
- /** 广告单元 id */
- adUnitId: string
- /** grid(格子) 广告组件的格子个数,可设置爱5,8两种格子个数样式,默认值为5 */
- gridCount: number
- /** grid(格子) 广告组件的样式 */
- style: CreateGridAdStyleOption
- /** 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(该参数不传入时 grid(格子) 广告不会自动刷新) */
- adIntervals?: number
- }
- /** grid(格子) 广告组件的样式 */
- interface CreateGridAdStyleOption {
- /** grid(格子) 广告组件的高度 */
- height: number
- /** grid(格子) 广告组件的左上角横坐标 */
- left: number
- /** grid(格子) 广告组件的左上角纵坐标 */
- top: number
- /** grid(格子) 广告组件的宽度 */
- width: number
- }
- interface CreateInnerAudioContextOption {
- /** 需要基础库: `2.19.0`
- *
- * 是否使用 WebAudio 作为底层音频驱动,默认关闭。对于短音频、播放频繁的音频建议开启此选项,开启后将获得更优的性能表现。由于开启此选项后也会带来一定的内存增长,因此对于长音频建议关闭此选项。 */
- useWebAudioImplement?: boolean
- }
- interface CreateInterstitialAdOption {
- /** 广告单元 id */
- adUnitId: string
- }
- interface CreateOpenSettingButtonOption {
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- interface CreateRewardedVideoAdOption {
- /** 广告单元 id */
- adUnitId: string
- /** 需要基础库: `2.8.0`
- *
- * 是否启用多例模式,默认为false */
- multiton?: boolean
- }
- interface CreateRoomOption {
- /** 房间最大人数 */
- maxMemberNum: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CreateRoomCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: CreateRoomFailCallback
- /** 游戏对局时长,到达指定时长时游戏会结束,最大值 3600。 */
- gameLastTime?: number
- /** 游戏自定义的关于个人的扩展信息,其他人可在 `MemberInfo` 中读取到,最多 32 个字节 */
- memberExtInfo?: string
- /** 是否需要生成游戏随机种子,设置为 true,房间信息会携带 gameSeed 属性 */
- needGameSeed?: boolean
- /** 是否需要用户头像和昵称
- *
- * 可选值:
- * - 'true': 需要用户头像和昵称,则每个加入房间的人必须授权过用户信息,MemberInfo 中会有 headimage 和 nickname;
- * - 'false': 不需要用户头像和昵称,MemberInfo 中不会有 headimage 和 nickname; */
- needUserInfo?: 'true' | 'false'
- /** 游戏自定义的关于房间扩展信息,其他人可在 `RoomInfo` 中读取到最多 32 个字节 */
- roomExtInfo?: string
- /** 需要满足百分比的玩家都发送了开始指令才能启动游戏。有效范围 0~100,0 表示只要有一个人调用开始就启动,100 表示要求所有人都开始才能启动。 */
- startPercent?: number
- /** 接口调用成功的回调函数 */
- success?: CreateRoomSuccessCallback
- }
- interface CreateRoomSuccessCallbackDataResult {
- /** 房间唯一标识 */
- accessInfo: string
- /** 用户在房间内的唯一标识 */
- clientId: number
- }
- interface CreateRoomSuccessCallbackResult {
- data: CreateRoomSuccessCallbackDataResult
- errMsg: string
- }
- interface CreateUserInfoButtonOption {
- /** 是否带上登录态信息。当 withCredentials 为 true 时,要求此前有调用过 wx.login 且登录态尚未过期,此时返回的数据会包含 encryptedData, iv 等敏感信息;当 withCredentials 为 false 时,不要求有登录态,返回的数据不包含 encryptedData, iv 等敏感信息。 */
- withCredentials: boolean
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 描述用户信息的语言
- *
- * 可选值:
- * - 'en': 英文;
- * - 'zh_CN': 简体中文;
- * - 'zh_TW': 繁体中文; */
- lang?: 'en' | 'zh_CN' | 'zh_TW'
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- interface CreateVideoOption {
- /** 视频的资源地址 */
- src: string
- /** 视频跳转后自动暂停播放 */
- autoPauseIfNavigate?: boolean
- /** 视频跳转原生页后自动暂停播放 */
- autoPauseIfOpenNative?: boolean
- /** 视频是否自动播放 */
- autoplay?: boolean
- /** 需要基础库: `2.12.0`
- *
- * 视频背景颜色 */
- backgroundColor?: string
- /** 视频是否显示控件 */
- controls?: boolean
- /** 是否开启双击播放的手势 */
- enablePlayGesture?: boolean
- /** 是否启用手势控制播放进度 */
- enableProgressGesture?: boolean
- /** 视频的高度 */
- height?: number
- /** 视频的初始播放位置,单位为 s 秒 */
- initialTime?: number
- /** 视频是否为直播 */
- live?: boolean
- /** 视频是否是否循环播放 */
- loop?: boolean
- /** 视频是否禁音播放 */
- muted?: boolean
- /** 需要基础库: `2.4.0`
- *
- * 视频是否遵循系统静音开关设置(仅iOS) */
- obeyMuteSwitch?: boolean
- /** 视频的缩放模式
- *
- * 可选值:
- * - 'fill': 填充,视频拉伸填满整个容器,不保证保持原有长宽比例;
- * - 'contain': 包含,保持原有长宽比例。保证视频尺寸一定可以在容器里面放得下。因此,可能会有部分空白;
- * - 'cover': 覆盖,保持原有长宽比例。保证视频尺寸一定大于容器尺寸,宽度和高度至少有一个和容器一致。因此,视频有部分会看不见; */
- objectFit?: 'fill' | 'contain' | 'cover'
- /** 视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5 */
- playbackRate?: number
- /** 视频的封面 */
- poster?: string
- /** 是否显示视频中央的播放按钮 */
- showCenterPlayBtn?: boolean
- /** 需要基础库: `2.12.0`
- *
- * 是否显示视频底部进度条 */
- showProgress?: boolean
- /** 需要基础库: `2.12.0`
- *
- * 是否显示控制栏的进度条 */
- showProgressInControlMode?: boolean
- /** 需要基础库: `2.11.0`
- *
- * 视频是否显示在游戏画布之下(配合 Canvas.getContext('webgl', {alpha: true}) 使主屏canvas实现透明效果) */
- underGameView?: boolean
- /** 视频的宽度 */
- width?: number
- /** 视频的左上角横坐标 */
- x?: number
- /** 视频的左上角纵坐标 */
- y?: number
- }
- /** 可选参数 */
- interface CreateWorkerOption {
- /** 需要基础库: `2.13.0`
- *
- * 是否使用实验worker。在iOS下,实验worker的JS运行效率比非实验worker提升近十倍,如需在worker内进行重度计算的建议开启此选项。同时,实验worker存在极小概率会在系统资源紧张时被系统回收,因此建议配合 worker.onProcessKilled 事件使用,在worker被回收后可重新创建一个。 */
- useExperimentalWorker?: boolean
- }
- /** 原生模板广告组件。原生模板广告组件是一个原生组件,层级比普通组件高。原生模板广告组件默认是隐藏的,需要调用 CustomAd.show() 将其显示。如果宽度可配置,原生模板广告会根据开发者设置的宽度进行等比缩放。 */
- interface CustomAd {
- /** 原生模板广告组件的样式 */
- style: CustomAdStyle
- }
- interface CustomAdOnErrorCallbackResult {
- /** 需要基础库: `2.2.2`
- *
- * 错误码
- *
- * 可选值:
- * - 1000: 后端接口调用失败;
- * - 1001: 参数错误;
- * - 1002: 广告单元无效;
- * - 1003: 内部错误;
- * - 1004: 无合适的广告;
- * - 1005: 广告组件审核中;
- * - 1006: 广告组件被驳回;
- * - 1007: 广告组件被封禁;
- * - 1008: 广告单元已关闭;
- * - 2001: 模板渲染错误;
- * - 2002: 模板为空;
- * - 2003: 模板解析失败;
- * - 2004: 触发频率限制;
- * - 2005: 触发频率限制; */
- errCode:
- | 1000
- | 1001
- | 1002
- | 1003
- | 1004
- | 1005
- | 1006
- | 1007
- | 1008
- | 2001
- | 2002
- | 2003
- | 2004
- | 2005
- /** 错误信息 */
- errMsg: string
- }
- /** 原生模板广告组件的样式 */
- interface CustomAdStyle {
- /** (只对小程序适用) 原生模板广告组件是否固定屏幕位置(不跟随屏幕滚动) */
- fixed: boolean
- /** 原生模板广告组件的左上角横坐标 */
- left: number
- /** 原生模板广告组件的左上角纵坐标 */
- top: number
- }
- interface DecodeOption {
- /** 要解码的 ArrayBuffer */
- data: ArrayBuffer
- /** 编码的格式 */
- format: string
- }
- /** 描述符数据 */
- interface Descriptor {
- /** Descriptor 的 UUID */
- uuid: string
- /** 描述符的权限 */
- permission?: DescriptorPermission
- /** 描述符数据 */
- value?: ArrayBuffer
- }
- /** 描述符的权限 */
- interface DescriptorPermission {
- /** 读 */
- read?: boolean
- /** 写 */
- write?: boolean
- }
- interface DownloadFileOption {
- /** 下载资源的 url */
- url: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: DownloadFileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: DownloadFileFailCallback
- /** 需要基础库: `1.8.0`
- *
- * 指定文件下载后存储的路径 (本地路径) */
- filePath?: string
- /** HTTP 请求的 Header,Header 中不能设置 Referer */
- header?: IAnyObject
- /** 接口调用成功的回调函数 */
- success?: DownloadFileSuccessCallback
- /** 需要基础库: `2.10.0`
- *
- * 超时时间,单位为毫秒 */
- timeout?: number
- }
- interface DownloadFileSuccessCallbackResult {
- /** 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 */
- filePath: string
- /** 需要基础库: `2.10.4`
- *
- * 网络请求过程中一些调试信息,[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html) */
- profile: RequestProfile
- /** 开发者服务器返回的 HTTP 状态码 */
- statusCode: number
- /** 临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件 */
- tempFilePath: string
- errMsg: string
- }
- interface DownloadTaskOnProgressUpdateCallbackResult {
- /** 下载进度百分比 */
- progress: number
- /** 预期需要下载的数据总长度,单位 Bytes */
- totalBytesExpectedToWrite: number
- /** 已经下载的数据长度,单位 Bytes */
- totalBytesWritten: number
- }
- interface EncodeOption {
- /** 要编码的字符串 */
- data: string
- /** 编码的格式 */
- format: string
- }
- interface EndGameOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: EndGameCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: EndGameFailCallback
- /** 接口调用成功的回调函数 */
- success?: EndGameSuccessCallback
- }
- interface EndStateServiceOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: EndStateServiceCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: EndStateServiceFailCallback
- /** 接口调用成功的回调函数 */
- success?: EndStateServiceSuccessCallback
- }
- /** 启动参数 */
- interface EnterOptionsGame {
- /** 启动小游戏的 query 参数 */
- query: IAnyObject
- /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
- referrerInfo: EnterOptionsGameReferrerInfo
- /** 启动小游戏的[场景值](https://developers.weixin.qq.com/minigame/dev/guide/framework/scene.html) */
- scene: number
- /** 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
- *
- * 可选值:
- * - 1: 微信联系人单聊;
- * - 2: 企业微信联系人单聊;
- * - 3: 普通微信群聊;
- * - 4: 企业微信互通群聊; */
- chatType?: 1 | 2 | 3 | 4
- /** shareTicket,详见[获取更多转发信息](#) */
- shareTicket?: string
- }
- /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
- interface EnterOptionsGameReferrerInfo {
- /** 来源小程序、公众号或 App 的 appId */
- appId: string
- /** 来源小程序传过来的数据,scene=1037或1038时支持 */
- extraData: IAnyObject
- }
- /** 文件读取结果。res.entries 是一个对象,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。 */
- interface EntriesResult {
- /** 文件路径 */
- [path: string]: ZipFileItem
- }
- /** 要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件) */
- interface EntryItem {
- /** 压缩包内文件路径 */
- path: string
- /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
- length?: number
- /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
- position?: number
- }
- interface ExitMiniProgramOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ExitMiniProgramCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ExitMiniProgramFailCallback
- /** 接口调用成功的回调函数 */
- success?: ExitMiniProgramSuccessCallback
- }
- interface ExitVoIPChatOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ExitVoIPChatCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ExitVoIPChatFailCallback
- /** 接口调用成功的回调函数 */
- success?: ExitVoIPChatSuccessCallback
- }
- /** 人脸角度信息,取值范围 [-1, 1],数值越接近 0 表示越正对摄像头 */
- interface FaceAngel {
- /** 仰俯角(点头) */
- pitch: number
- /** 翻滚角(左右倾) */
- roll: number
- /** 偏航角(摇头) */
- yaw: number
- }
- /** 人脸置信度,取值范围 [0, 1],数值越大置信度越高(遮挡越少) */
- interface FaceConf {
- /** 整体可信度 */
- global: number
- /** 左眼可信度 */
- leftEye: number
- /** 嘴巴可信度 */
- mouth: number
- /** 鼻子可信度 */
- nose: number
- /** 右眼可信度 */
- rightEye: number
- }
- interface FaceDetectOption {
- /** 图像像素点数据,每四项表示一个像素点的 RGBA */
- frameBuffer: ArrayBuffer
- /** 图像高度 */
- height: number
- /** 图像宽度 */
- width: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: FaceDetectCompleteCallback
- /** 是否返回当前图像的人脸角度信息 */
- enableAngle?: boolean
- /** 是否返回当前图像的人脸的置信度(可表示器官遮挡情况) */
- enableConf?: boolean
- /** 是否返回多张人脸的信息 */
- enableMultiFace?: boolean
- /** 是否返回当前图像的人脸(106 个点) */
- enablePoint?: boolean
- /** 接口调用失败的回调函数 */
- fail?: FaceDetectFailCallback
- /** 接口调用成功的回调函数 */
- success?: FaceDetectSuccessCallback
- }
- interface FaceDetectSuccessCallbackResult {
- /** 人脸角度信息,取值范围 [-1, 1],数值越接近 0 表示越正对摄像头 */
- angleArray: FaceAngel
- /** 人脸置信度,取值范围 [0, 1],数值越大置信度越高(遮挡越少) */
- confArray: FaceConf
- /** 脸部正方框数值,对象包含 height, weight, originX, originY 四个属性 */
- detectRect: IAnyObject
- /** 多人模式(enableMultiFace)下的人脸信息,每个对象包含上述其它属性 */
- faceInfo: IAnyObject[]
- /** 人脸 106 个点位置数组,数组每个对象包含 x 和 y */
- pointArray: IAnyObject[]
- /** 脸部中心点横坐标,检测不到人脸则为 -1 */
- x: number
- /** 脸部中心点纵坐标,检测不到人脸则为 -1 */
- y: number
- errMsg: string
- }
- /** 用户点击后打开意见反馈页面的按钮 */
- interface FeedbackButton {
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- /** 文件数组 */
- interface FileItem {
- /** 文件保存时的时间戳,从1970/01/01 08:00:00 到当前时间的秒数 */
- createTime: number
- /** 文件路径 (本地路径) */
- filePath: string
- /** 本地文件大小,以字节为单位 */
- size: number
- }
- interface FileSystemManagerCloseOption {
- /** 需要被关闭的文件描述符。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) 接口获得 */
- fd: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CloseCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: FileSystemManagerCloseFailCallback
- /** 接口调用成功的回调函数 */
- success?: CloseSuccessCallback
- }
- interface FileSystemManagerGetFileInfoOption {
- /** 要读取的文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetFileInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: FileSystemManagerGetFileInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: FileSystemManagerGetFileInfoSuccessCallback
- }
- interface FileSystemManagerGetFileInfoSuccessCallbackResult {
- /** 文件大小,以字节为单位 */
- size: number
- errMsg: string
- }
- /** 视频帧数据,若取不到则返回 null。当缓冲区为空的时候可能暂停取不到数据。 */
- interface FrameDataOptions {
- /** 帧数据 */
- data: ArrayBuffer
- /** 帧数据高度 */
- height: number
- /** 帧原始 dts */
- pkDts: number
- /** 帧原始 pts */
- pkPts: number
- /** 帧数据宽度 */
- width: number
- }
- /** 用户信息 */
- interface FriendInfo {
- /** 用户的微信头像 url */
- avatarUrl: string
- /** 用户的微信昵称 */
- nickname: string
- /** 用户 openid */
- openid: string
- }
- interface FstatFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'bad file descriptor': 无效的文件描述符;
- * - 'fail permission denied': 指定的 fd 路径没有读权限; */
- errMsg: string
- }
- interface FstatOption {
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: FstatCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: FstatFailCallback
- /** 接口调用成功的回调函数 */
- success?: FstatSuccessCallback
- }
- interface FstatSuccessCallbackResult {
- /** [Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)
- *
- * Stats 对象,包含了文件的状态信息 */
- stats: Stats
- errMsg: string
- }
- interface FstatSyncOption {
- /** 文件描述符。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) 接口获得 */
- fd: string
- }
- interface FtruncateFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'bad file descriptor': 无效的文件描述符;
- * - 'fail permission denied': 指定的 fd 没有写权限;
- * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
- * - 'fail sdcard not mounted': android sdcard 挂载失败; */
- errMsg: string
- }
- interface FtruncateOption {
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 截断位置,默认0。如果 length 小于文件长度(单位:字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
- length: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: FtruncateCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: FtruncateFailCallback
- /** 接口调用成功的回调函数 */
- success?: FtruncateSuccessCallback
- }
- interface FtruncateSyncOption {
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 截断位置,默认0。如果 length 小于文件长度(单位:字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
- length: number
- }
- /** 小游戏推荐banner组件。小游戏推荐banner组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。小游戏推荐banner组件默认是隐藏的,需要调用 GameBanner.show() 将其显示。 */
- interface GameBanner {
- /** 是否已销毁的标记位 */
- isDestroyed: boolean
- /** 小游戏推荐banner组件的样式。style 上的属性的值仅为开发者设置的值,开发者设置的异常值会被忽略,最终的尺寸和位置信息通过GameBanner.onResize() 事件获得。 */
- style: GameBannerStyle
- }
- interface GameBannerOnErrorCallbackResult {
- /** 错误码
- *
- * 可选值:
- * - 1000: 内部错误;
- * - 1001: 参数错误;
- * - 1002: 无效的推荐位,请检查推荐id是否正确;
- * - 1004: 无合适的推荐;
- * - 1008: 推荐单元已关闭; */
- errCode: 1000 | 1001 | 1002 | 1004 | 1008
- /** 需要基础库: `2.7.7`
- *
- * 错误信息 */
- errMsg: string
- }
- /** 小游戏推荐banner组件的样式。style 上的属性的值仅为开发者设置的值,开发者设置的异常值会被忽略,最终的尺寸和位置信息通过GameBanner.onResize() 事件获得。 */
- interface GameBannerStyle {
- /** 小游戏推荐banner组件的左上角横坐标 */
- left: number
- /** 小游戏推荐banner组件的左上角纵坐标 */
- top: number
- }
- /** 游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈。更多关于游戏圈的信息见 [游戏圈使用指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/game-club.html) */
- interface GameClubButton {
- /** 游戏圈按钮的图标,仅当 type 参数为 image 时有效。
- *
- * 可选值:
- * - 'green': 绿色的图标;
- * - 'white': 白色的图标;
- * - 'dark': 有黑色圆角背景的白色图标;
- * - 'light': 有白色圆角背景的绿色图标; */
- icon: 'green' | 'white' | 'dark' | 'light'
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- /** 小游戏推荐icon组件。小游戏推荐icon组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。小游戏推荐icon组件默认是隐藏的,需要调用 GameIcon.show() 将其显示。 */
- interface GameIcon {
- /** 单个游戏icon的位置和样式等信息 */
- iconItem: IconItem
- /** 每个icon渲染出来之后都有位置、尺寸和样式等信息,统一由icons数组维护,数组的每一项称为iconItem */
- icons: any[]
- /** 是否已销毁的标记位 */
- isDestroyed: boolean
- }
- /** 小游戏推荐弹窗组件。小游戏推荐弹窗组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。小游戏推荐弹窗组件默认是隐藏的,需要调用 GamePortal.show() 将其显示。 */
- interface GamePortal {
- /** 组件是否已销毁的标记位。 */
- isDestroyed: boolean
- }
- interface GamePortalOnErrorCallbackResult {
- /** 错误码
- *
- * 可选值:
- * - 1000: 内部错误;
- * - 1001: 参数错误;
- * - 1002: 无效的推荐位,请检查推荐位id是否正确;
- * - 1004: 无合适的推荐;
- * - 1008: 推荐位已关闭; */
- errCode: 1000 | 1001 | 1002 | 1004 | 1008
- /** 需要基础库: `2.7.7`
- *
- * 错误信息 */
- errMsg: string
- }
- /** 需要基础库: `2.8.0`
- *
- * 游戏对局回放分享按钮。按钮在被用户点击后会发起对最近一次录制完成的游戏对局回放的分享。 */
- interface GameRecorderShareButton {
- /** 对局回放的分享参数。 */
- share: Share
- /** 按钮的样式 */
- style: GameRecorderShareButtonStyle
- /** 图标的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。icon尺寸固定,高16px,宽24px。 */
- icon?: string
- /** 按钮的背景图片的 url。支持 http/https 开头的网络资源和 wxfile:// 开头的本地资源。如果不设置则使用默认图标。 */
- image?: string
- /** 按钮的文本。 */
- text?: string
- }
- /** 按钮的样式 */
- interface GameRecorderShareButtonStyle {
- /** 按钮背景颜色,十六进制颜色值,'transparent'为透明背景。 */
- backgroundColor?: string
- /** 按钮圆角大小,单位为逻辑像素。 */
- borderRadius?: number
- /** 文本的颜色。 */
- color?: string
- /** 文本的字体大小。最小 17,最大 22。 */
- fontSize?: number
- /** 按钮的高度,最小 40 逻辑像素 */
- height?: number
- /** 图标和文本之间的距离,最小 8 逻辑像素 */
- iconMarginRight?: number
- /** 左上角横坐标,单位 逻辑像素 */
- left?: number
- /** 按钮的左内边距,最小 16 逻辑像素。 */
- paddingLeft?: number
- /** 按钮的右内边距,最小 16 逻辑像素。 */
- paddingRight?: number
- /** 左上角纵坐标,单位 逻辑像素 */
- top?: number
- }
- interface GameRecorderStartOption {
- /** 视频比特率(kbps),默认值1000,最大值 3000,最小值 600 */
- bitrate?: number
- /** 视频的时长限制,单位为秒(s)。最大值 7200,最小值 5,到达指定时长后不会再录入。但还需要手动调用 [GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html) 来结束录制。 */
- duration?: number
- /** 视频 fps */
- fps?: number
- /** 视频关键帧间隔 */
- gop?: number
- /** 需要基础库: `2.10.0`
- *
- * 是否录制游戏音效(仅iOS支持) */
- hookBgm?: boolean
- }
- interface GameServerManagerOnDisconnectCallbackResult {
- res: OnDisconnectCallbackResult
- }
- interface GameServerManagerOnMatchCallbackResult {
- res: OnMatchCallbackResult
- }
- interface GameServerManagerOnRoomInfoChangeCallbackResult {
- res: OnRoomInfoChangeCallbackResult
- }
- interface GameServerManagerOnStateUpdateCallbackResult {
- res: OnStateUpdateCallbackResult
- }
- interface GeneralCallbackResult {
- /** 错误信息 */
- errMsg: string
- }
- interface GetAvailableAudioSourcesOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetAvailableAudioSourcesCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetAvailableAudioSourcesFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetAvailableAudioSourcesSuccessCallback
- }
- interface GetAvailableAudioSourcesSuccessCallbackResult {
- /** 支持的音频输入源列表,可在 [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
- *
- * 可选值:
- * - 'auto': 自动设置,默认使用手机麦克风,插上耳麦后自动切换使用耳机麦克风,所有平台适用;
- * - 'buildInMic': 手机麦克风,仅限 iOS;
- * - 'headsetMic': 耳机麦克风,仅限 iOS;
- * - 'mic': 麦克风(没插耳麦时是手机麦克风,插耳麦时是耳机麦克风),仅限 Android;
- * - 'camcorder': 同 mic,适用于录制音视频内容,仅限 Android;
- * - 'voice_communication': 同 mic,适用于实时沟通,仅限 Android;
- * - 'voice_recognition': 同 mic,适用于语音识别,仅限 Android; */
- audioSources: Array<
- | 'auto'
- | 'buildInMic'
- | 'headsetMic'
- | 'mic'
- | 'camcorder'
- | 'voice_communication'
- | 'voice_recognition'
- >
- errMsg: string
- }
- interface GetBLEDeviceCharacteristicsOption {
- /** 蓝牙设备 id。需要已经通过 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 建立连接 */
- deviceId: string
- /** 蓝牙服务 UUID。需要先调用 [wx.getBLEDeviceServices](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceServices.html) 获取 */
- serviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBLEDeviceCharacteristicsCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBLEDeviceCharacteristicsFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBLEDeviceCharacteristicsSuccessCallback
- }
- interface GetBLEDeviceCharacteristicsSuccessCallbackResult {
- /** 设备特征列表 */
- characteristics: BLECharacteristic[]
- errMsg: string
- }
- interface GetBLEDeviceRSSIOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBLEDeviceRSSICompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBLEDeviceRSSIFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBLEDeviceRSSISuccessCallback
- }
- interface GetBLEDeviceRSSISuccessCallbackResult {
- /** 信号强度,单位 dBm */
- RSSI: number
- errMsg: string
- }
- interface GetBLEDeviceServicesOption {
- /** 蓝牙设备 id。需要已经通过 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 建立连接 */
- deviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBLEDeviceServicesCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBLEDeviceServicesFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBLEDeviceServicesSuccessCallback
- }
- interface GetBLEDeviceServicesSuccessCallbackResult {
- /** 设备服务列表 */
- services: BLEService[]
- errMsg: string
- }
- interface GetBLEMTUOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBLEMTUCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBLEMTUFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBLEMTUSuccessCallback
- /** 写模式 (iOS 特有参数)
- *
- * 可选值:
- * - 'write': 有回复写;
- * - 'writeNoResponse': 无回复写; */
- writeType?: 'write' | 'writeNoResponse'
- }
- interface GetBLEMTUSuccessCallbackResult {
- /** 最大传输单元 */
- mtu: number
- errMsg: string
- }
- interface GetBatteryInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBatteryInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBatteryInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBatteryInfoSuccessCallback
- }
- interface GetBatteryInfoSuccessCallbackResult {
- /** 是否正在充电中 */
- isCharging: boolean
- /** 设备电量,范围 1 - 100 */
- level: number
- errMsg: string
- }
- interface GetBatteryInfoSyncResult {
- /** 是否正在充电中 */
- isCharging: boolean
- /** 设备电量,范围 1 - 100 */
- level: number
- }
- interface GetBeaconsOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBeaconsCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBeaconsFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBeaconsSuccessCallback
- }
- interface GetBeaconsSuccessCallbackResult {
- /** Beacon 设备列表 */
- beacons: BeaconInfo[]
- errMsg: string
- }
- interface GetBluetoothAdapterStateOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBluetoothAdapterStateCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBluetoothAdapterStateFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBluetoothAdapterStateSuccessCallback
- }
- interface GetBluetoothAdapterStateSuccessCallbackResult {
- /** 蓝牙适配器是否可用 */
- available: boolean
- /** 是否正在搜索设备 */
- discovering: boolean
- errMsg: string
- }
- interface GetBluetoothDevicesOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetBluetoothDevicesCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetBluetoothDevicesFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetBluetoothDevicesSuccessCallback
- }
- interface GetBluetoothDevicesSuccessCallbackResult {
- /** UUID 对应的已连接设备列表 */
- devices: BlueToothDevice[]
- errMsg: string
- }
- interface GetChannelsLiveInfoOption {
- /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
- finderUserName: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetChannelsLiveInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetChannelsLiveInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetChannelsLiveInfoSuccessCallback
- }
- interface GetChannelsLiveInfoSuccessCallbackResult {
- /** 直播主题 */
- description: string
- /** 直播 feedId */
- feedId: string
- /** 视频号头像 */
- headUrl: string
- /** 视频号昵称 */
- nickname: string
- /** 直播 nonceId */
- nonceId: string
- /** 直播状态,2直播中,3直播结束 */
- status: number
- errMsg: string
- }
- interface GetChannelsLiveNoticeInfoOption {
- /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
- finderUserName: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetChannelsLiveNoticeInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetChannelsLiveNoticeInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetChannelsLiveNoticeInfoSuccessCallback
- }
- interface GetChannelsLiveNoticeInfoSuccessCallbackResult {
- /** 直播封面 */
- headUrl: string
- /** 视频号昵称 */
- nickname: string
- /** 预告 id */
- noticeId: string
- /** 是否可预约 */
- reservable: boolean
- /** 开始时间 */
- startTime: string
- /** 预告状态:0可用 1取消 2已用 */
- status: number
- errMsg: string
- }
- interface GetClipboardDataOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetClipboardDataCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetClipboardDataFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetClipboardDataSuccessCallback
- }
- interface GetClipboardDataSuccessCallbackOption {
- /** 剪贴板的内容 */
- data: string
- }
- interface GetConnectedBluetoothDevicesOption {
- /** 蓝牙设备主服务的 UUID 列表(支持 16/32/128 位 UUID) */
- services: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetConnectedBluetoothDevicesCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetConnectedBluetoothDevicesFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetConnectedBluetoothDevicesSuccessCallback
- }
- interface GetConnectedBluetoothDevicesSuccessCallbackResult {
- /** 搜索到的设备列表 */
- devices: BluetoothDeviceInfo[]
- errMsg: string
- }
- interface GetExtConfigOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetExtConfigCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetExtConfigFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetExtConfigSuccessCallback
- }
- interface GetExtConfigSuccessCallbackResult {
- /** 第三方平台自定义的数据 */
- extConfig: IAnyObject
- errMsg: string
- }
- interface GetFileInfoFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail file not exist': 指定的 filePath 找不到文件; */
- errMsg: string
- }
- interface GetFriendCloudStorageOption {
- /** 要拉取的 key 列表 */
- keyList: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetFriendCloudStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetFriendCloudStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetFriendCloudStorageSuccessCallback
- }
- interface GetFriendCloudStorageSuccessCallbackResult {
- /** 同玩好友的托管数据 */
- data: UserGameData[]
- errMsg: string
- }
- interface GetFriendsStateDataOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetFriendsStateDataCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetFriendsStateDataFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetFriendsStateDataSuccessCallback
- }
- interface GetGroupCloudStorageOption {
- /** 要拉取的 key 列表 */
- keyList: string[]
- /** 群分享对应的 shareTicket */
- shareTicket: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetGroupCloudStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetGroupCloudStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetGroupCloudStorageSuccessCallback
- }
- interface GetGroupCloudStorageSuccessCallbackResult {
- /** 群同玩成员的托管数据 */
- data: UserGameData[]
- errMsg: string
- }
- interface GetGroupEnterInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetGroupEnterInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetGroupEnterInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetGroupEnterInfoSuccessCallback
- }
- interface GetGroupEnterInfoSuccessCallbackResult {
- /** 需要基础库: `2.7.0`
- *
- * 敏感数据对应的云 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) */
- cloudID: string
- /** 包括敏感数据在内的完整转发信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- encryptedData: string
- /** 错误信息 */
- errMsg: string
- /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- iv: string
- }
- interface GetGroupInfoOption {
- /** 群 openGId,可通过 `wx.getShareInfo` 获取 */
- openGId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetGroupInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetGroupInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetGroupInfoSuccessCallback
- }
- interface GetGroupInfoSuccessCallbackResult {
- /** 群名称 */
- name: string
- errMsg: string
- }
- interface GetLastRoomInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetLastRoomInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetLastRoomInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetLastRoomInfoSuccessCallback
- }
- interface GetLastRoomInfoSuccessCallbackDataResult {
- /** 最近参与房间的 accessInfo */
- accessInfo: string
- /** 最近参与房间的详细信息 */
- roomInfo: RoomInfo
- }
- interface GetLastRoomInfoSuccessCallbackResult {
- data: GetLastRoomInfoSuccessCallbackDataResult
- errMsg: string
- }
- interface GetLatestUserKeyOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetLatestUserKeyCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetLatestUserKeyFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetLatestUserKeySuccessCallback
- }
- interface GetLatestUserKeySuccessCallbackResult {
- /** 用户加密密钥 */
- encryptKey: string
- /** 密钥过期时间 */
- expireTime: number
- /** 密钥初始向量 */
- iv: string
- /** 密钥版本 */
- version: number
- errMsg: string
- }
- interface GetLocalIPAddressOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetLocalIPAddressCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetLocalIPAddressFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetLocalIPAddressSuccessCallback
- }
- interface GetLocalIPAddressSuccessCallbackResult {
- /** 错误信息 */
- errMsg: string
- /** 本机局域网IP地址 */
- localip: string
- }
- interface GetLocationOption {
- /** 需要基础库: `1.6.0`
- *
- * 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 */
- altitude?: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetLocationCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetLocationFailCallback
- /** 需要基础库: `2.9.0`
- *
- * 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 */
- highAccuracyExpireTime?: number
- /** 需要基础库: `2.9.0`
- *
- * 开启高精度定位 */
- isHighAccuracy?: boolean
- /** 接口调用成功的回调函数 */
- success?: GetLocationSuccessCallback
- /** wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标 */
- type?: string
- }
- interface GetLocationSuccessCallbackResult {
- /** 位置的精确度,反应与真实位置之间的接近程度,可以理解成10即与真实位置相差10m,越小越精确 */
- accuracy: number
- /** 需要基础库: `1.2.0`
- *
- * 高度,单位 m */
- altitude: number
- /** 需要基础库: `1.2.0`
- *
- * 水平精度,单位 m */
- horizontalAccuracy: number
- /** 纬度,范围为 -90~90,负数表示南纬 */
- latitude: number
- /** 经度,范围为 -180~180,负数表示西经 */
- longitude: number
- /** 速度,单位 m/s */
- speed: number
- /** 需要基础库: `1.2.0`
- *
- * 垂直精度,单位 m(Android 无法获取,返回 0) */
- verticalAccuracy: number
- errMsg: string
- }
- interface GetLogManagerOption {
- /** 需要基础库: `2.3.2`
- *
- * 取值为0/1,取值为0表示会把 `App`、`Page` 的生命周期函数和 `wx` 命名空间下的函数调用写入日志,取值为1则不会。默认值是 0 */
- level?: number
- }
- interface GetLostFramesOption {
- /** 起始帧号。不填或非法值默认从第 1 帧开始补 */
- beginFrameId: number
- /** 结尾帧号。不填或非法值默认补到当前最新帧 */
- endFrameId: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetLostFramesCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetLostFramesFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetLostFramesSuccessCallback
- }
- interface GetLostFramesSuccessCallbackDataResult {
- /** 丢失的帧数组 */
- frameList: any[]
- }
- interface GetLostFramesSuccessCallbackResult {
- data: GetLostFramesSuccessCallbackDataResult
- errMsg: string
- }
- interface GetNetworkTypeOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetNetworkTypeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetNetworkTypeFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetNetworkTypeSuccessCallback
- }
- interface GetNetworkTypeSuccessCallbackResult {
- /** 网络类型
- *
- * 可选值:
- * - 'wifi': wifi 网络;
- * - '2g': 2g 网络;
- * - '3g': 3g 网络;
- * - '4g': 4g 网络;
- * - '5g': 5g 网络;
- * - 'unknown': Android 下不常见的网络类型;
- * - 'none': 无网络; */
- networkType: 'wifi' | '2g' | '3g' | '4g' | '5g' | 'unknown' | 'none'
- /** 信号强弱,单位 dbm */
- signalStrength: number
- errMsg: string
- }
- interface GetPotentialFriendListOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetPotentialFriendListCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetPotentialFriendListFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetPotentialFriendListSuccessCallback
- }
- interface GetPotentialFriendListSuccessCallbackResult {
- /** 可能对游戏感兴趣的未注册好友名单 */
- list: FriendInfo[]
- errMsg: string
- }
- interface GetRandomValuesOption {
- /** 整数,生成随机数的字节数,最大 1048576 */
- length: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetRandomValuesCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetRandomValuesFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetRandomValuesSuccessCallback
- }
- interface GetRandomValuesSuccessCallbackResult {
- /** 随机数内容,长度为传入的字节数 */
- randomValues: ArrayBuffer
- errMsg: string
- }
- interface GetRoomInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetRoomInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetRoomInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetRoomInfoSuccessCallback
- }
- interface GetRoomInfoSuccessCallbackDataResult {
- roomInfo: RoomInfo
- }
- interface GetRoomInfoSuccessCallbackResult {
- data: GetRoomInfoSuccessCallbackDataResult
- errMsg: string
- }
- interface GetSavedFileListOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetSavedFileListCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetSavedFileListFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetSavedFileListSuccessCallback
- }
- interface GetSavedFileListSuccessCallbackResult {
- /** 文件数组 */
- fileList: FileItem[]
- errMsg: string
- }
- interface GetScreenBrightnessOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetScreenBrightnessCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetScreenBrightnessFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetScreenBrightnessSuccessCallback
- }
- interface GetScreenBrightnessSuccessCallbackOption {
- /** 屏幕亮度值,范围 0 ~ 1,0 最暗,1 最亮 */
- value: number
- }
- interface GetSettingOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetSettingCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetSettingFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetSettingSuccessCallback
- /** 需要基础库: `2.10.1`
- *
- * 是否同时获取用户订阅消息的订阅状态,默认不获取。注意:withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择,不再询问”的订阅消息。 */
- withSubscriptions?: boolean
- }
- interface GetSettingSuccessCallbackResult {
- /** [AuthSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/AuthSetting.html)
- *
- * 用户授权结果 */
- authSetting: AuthSetting
- /** [SubscriptionsSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/SubscriptionsSetting.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 用户订阅消息设置,接口参数`withSubscriptions`值为`true`时才会返回。 */
- subscriptionsSetting: SubscriptionsSetting
- /** [AuthSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/AuthSetting.html)
- *
- * 在插件中调用时,当前宿主小程序的用户授权结果 */
- miniprogramAuthSetting?: AuthSetting
- errMsg: string
- }
- interface GetShareInfoOption {
- /** shareTicket */
- shareTicket: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetShareInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetShareInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetShareInfoSuccessCallback
- /** 需要基础库: `1.9.90`
- *
- * 超时时间,单位 ms */
- timeout?: number
- }
- interface GetStorageInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetStorageInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetStorageInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetStorageInfoSuccessCallback
- }
- interface GetStorageInfoSuccessCallbackOption {
- /** 当前占用的空间大小, 单位 KB */
- currentSize: number
- /** 当前 storage 中所有的 key */
- keys: string[]
- /** 限制的空间大小,单位 KB */
- limitSize: number
- }
- interface GetStorageInfoSyncOption {
- /** 当前占用的空间大小, 单位 KB */
- currentSize: number
- /** 当前 storage 中所有的 key */
- keys: string[]
- /** 限制的空间大小,单位 KB */
- limitSize: number
- }
- interface GetStorageOption<T = any> {
- /** 本地缓存中指定的 key */
- key: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetStorageCompleteCallback
- /** 需要基础库: `2.21.3`
- *
- * 是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true */
- encrypt?: boolean
- /** 接口调用失败的回调函数 */
- fail?: GetStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetStorageSuccessCallback<T>
- }
- interface GetStorageSuccessCallbackResult<T = any> {
- /** key对应的内容 */
- data: T
- errMsg: string
- }
- interface GetSystemInfoAsyncOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetSystemInfoAsyncCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetSystemInfoAsyncFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetSystemInfoAsyncSuccessCallback
- }
- interface GetSystemInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetSystemInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetSystemInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetSystemInfoSuccessCallback
- }
- interface GetTextLineHeightOption {
- /** 字体名称 */
- fontFamily: string
- /** 文本的内容 */
- text: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetTextLineHeightCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetTextLineHeightFailCallback
- /** 字号 */
- fontSize?: number
- /** 字体样式
- *
- * 可选值:
- * - 'normal': 正常;
- * - 'italic': 斜体; */
- fontStyle?: 'normal' | 'italic'
- /** 字重
- *
- * 可选值:
- * - 'normal': 正常;
- * - 'bold': 粗体; */
- fontWeight?: 'normal' | 'bold'
- /** 接口调用成功的回调函数 */
- success?: GetTextLineHeightSuccessCallback
- }
- interface GetUserCloudStorageKeysOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetUserCloudStorageKeysCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetUserCloudStorageKeysFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetUserCloudStorageKeysSuccessCallback
- }
- interface GetUserCloudStorageKeysSuccessCallbackResult {
- /** 用户托管数据当中所有的 key 数组 */
- keys: string[]
- errMsg: string
- }
- interface GetUserCloudStorageOption {
- /** 要获取的 key 列表 */
- keyList: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetUserCloudStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetUserCloudStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetUserCloudStorageSuccessCallback
- }
- interface GetUserCloudStorageSuccessCallbackResult {
- /** 用户托管的 KV 数据列表 */
- KVDataList: KVData[]
- errMsg: string
- }
- interface GetUserInfoOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetUserInfoCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetUserInfoFailCallback
- /** 显示用户信息的语言
- *
- * 可选值:
- * - 'en': 英文;
- * - 'zh_CN': 简体中文;
- * - 'zh_TW': 繁体中文; */
- lang?: 'en' | 'zh_CN' | 'zh_TW'
- /** 接口调用成功的回调函数 */
- success?: GetUserInfoSuccessCallback
- /** 是否带上登录态信息。当 withCredentials 为 true 时,要求此前有调用过 wx.login 且登录态尚未过期,此时返回的数据会包含 encryptedData, iv 等敏感信息;当 withCredentials 为 false 时,不要求有登录态,返回的数据不包含 encryptedData, iv 等敏感信息。 */
- withCredentials?: boolean
- }
- interface GetUserInfoSuccessCallbackResult {
- /** 需要基础库: `2.7.0`
- *
- * 敏感数据对应的云 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) */
- cloudID: string
- /** 包括敏感数据在内的完整用户信息的加密数据,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
- encryptedData: string
- /** 加密算法的初始向量,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
- iv: string
- /** 不包括敏感信息的原始数据字符串,用于计算签名 */
- rawData: string
- /** 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- signature: string
- /** [UserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfo.html)
- *
- * 用户信息对象,不包含 openid 等敏感信息 */
- userInfo: UserInfo
- errMsg: string
- }
- interface GetUserInteractiveStorageFailCallbackResult {
- /** 错误码
- *
- * 可选值:
- * - -17008: 非法的 key; */
- errCode: -17008
- /** 错误信息 */
- errMsg: string
- }
- interface GetUserInteractiveStorageOption {
- /** 要获取的 key 列表 */
- keyList: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetUserInteractiveStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetUserInteractiveStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetUserInteractiveStorageSuccessCallback
- }
- interface GetUserInteractiveStorageSuccessCallbackResult {
- /** 敏感数据对应的云 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) */
- cloudID: string
- /** 加密数据,包含互动型托管数据的值。解密后的结果为一个 `KVDataList`,每一项为一个 `KVData`。 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
- encryptedData: string
- errMsg: string
- }
- interface GetWeRunDataOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetWeRunDataCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: GetWeRunDataFailCallback
- /** 接口调用成功的回调函数 */
- success?: GetWeRunDataSuccessCallback
- }
- interface GetWeRunDataSuccessCallbackResult {
- /** 需要基础库: `2.7.0`
- *
- * 敏感数据对应的云 ID,开通云开发的小程序才会返回,可通过云调用直接获取开放数据,详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#method-cloud) */
- cloudID: string
- /** 包括敏感数据在内的完整用户信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html)。解密后得到的数据结构见后文 */
- encryptedData: string
- /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- iv: string
- errMsg: string
- }
- /** grid(格子) 广告组件。grid(格子) 广告组件是一个原生组件,层级比普通组件高。grid(格子) 广告组件默认是隐藏的,需要调用 GridAd.show() 将其显示。grid(格子) 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 GridAd.onResize() 事件中提供。 */
- interface GridAd {
- /** grid(格子) 广告广告组件的主题,提供 `white` `black` 两种主题选择。 */
- adTheme: string
- /** grid(格子) 广告组件的格子个数,可设置爱5,8两种格子个数样式,默认值为5 */
- gridCount: number
- /** grid(格子) 广告广告组件的样式。style 上的属性的值仅为开发者设置的grid(格子) 广告) 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 GridAd.onResize() 事件获得。 */
- style: GridAdStyle
- }
- /** grid(格子) 广告广告组件的样式。style 上的属性的值仅为开发者设置的grid(格子) 广告) 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 GridAd.onResize() 事件获得。 */
- interface GridAdStyle {
- /** grid(格子) 广告组件的高度 */
- height: number
- /** grid(格子) 广告广告组件的左上角横坐标 */
- left: number
- /** grid(格子) 广告组件经过缩放后真实的高度 */
- realHeight: number
- /** grid(格子) 广告组件经过缩放后真实的宽度 */
- realWidth: number
- /** grid(格子) 广告组件的左上角纵坐标 */
- top: number
- /** grid(格子) 广告组件的宽度。最小 300,最大至 `屏幕宽度`(屏幕宽度可以通过 wx.getSystemInfoSync() 获取)。 */
- width: number
- }
- interface HideKeyboardOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: HideKeyboardCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: HideKeyboardFailCallback
- /** 接口调用成功的回调函数 */
- success?: HideKeyboardSuccessCallback
- }
- interface HideLoadingOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: HideLoadingCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: HideLoadingFailCallback
- /** 接口调用成功的回调函数 */
- success?: HideLoadingSuccessCallback
- }
- interface HideShareMenuOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: HideShareMenuCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: HideShareMenuFailCallback
- /** 需要基础库: `2.11.3`
- *
- * 本接口为 Beta 版本,暂只在 Android 平台支持。需要隐藏的转发按钮名称列表,默认['shareAppMessage', 'shareTimeline']。按钮名称合法值包含 "shareAppMessage"、"shareTimeline" 两种 */
- menus?: string[]
- /** 接口调用成功的回调函数 */
- success?: HideShareMenuSuccessCallback
- }
- interface HideToastOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: HideToastCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: HideToastFailCallback
- /** 接口调用成功的回调函数 */
- success?: HideToastSuccessCallback
- }
- /** 需要基础库: `2.12.3`
- *
- * 当前小程序运行的宿主环境 */
- interface Host {
- /** 宿主 app 对应的 appId */
- appId: string
- }
- /** 单个游戏icon的位置和样式等信息 */
- interface IconItem {
- /** 游戏名称是否隐藏 */
- appNameHidden: boolean
- /** 游戏icon的border颜色色值 */
- borderColor: string
- /** 游戏icon的border尺寸 */
- borderWidth: number
- /** 游戏名称的颜色色号 */
- color: string
- /** 游戏icon的X轴坐标 */
- left: number
- /** 游戏icon的宽高值 */
- size: number
- /** 游戏icon的Y轴坐标 */
- top: number
- }
- /** 图片对象 */
- interface Image {
- /** 图片的真实高度 */
- height: number
- /** 图片加载发生错误后触发的回调函数 */
- onerror: (...args: any[]) => any
- /** 图片加载完成后触发的回调函数 */
- onload: (...args: any[]) => any
- /** 图片的 URL */
- src: string
- /** 图片的真实宽度 */
- width: number
- }
- /** 需要基础库: `1.2.0`
- *
- * 图片的本地临时文件列表 */
- interface ImageFile {
- /** 本地临时文件路径 (本地路径) */
- path: string
- /** 本地临时文件大小,单位 B */
- size: number
- }
- interface InitFaceDetectOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: InitFaceDetectCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: InitFaceDetectFailCallback
- /** 接口调用成功的回调函数 */
- success?: InitFaceDetectSuccessCallback
- }
- /** 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)事件来处理这种情况。
- *
- * **支持格式**
- *
- * | 格式 | iOS | Android |
- * | ---- | ---- | ------- |
- * | flac | x | √ |
- * | m4a | √ | √ |
- * | ogg | x | √ |
- * | ape | x | √ |
- * | amr | x | √ |
- * | wma | x | √ |
- * | wav | √ | √ |
- * | mp3 | √ | √ |
- * | mp4 | x | √ |
- * | aac | √ | √ |
- * | aiff | √ | x |
- * | caf | √ | x |
- *
- * **示例代码**
- *
- * ```js
- const innerAudioContext = wx.createInnerAudioContext()
- innerAudioContext.autoplay = true
- innerAudioContext.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'
- innerAudioContext.onPlay(() => {
- console.log('开始播放')
- })
- innerAudioContext.onError((res) => {
- console.log(res.errMsg)
- console.log(res.errCode)
- })
- ``` */
- interface InnerAudioContext {
- /** 是否自动开始播放,默认为 `false` */
- autoplay: boolean
- /** 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲(只读) */
- buffered: number
- /** 当前音频的播放位置(单位 s)。只有在当前有合法的 src 时返回,时间保留小数点后 6 位(只读) */
- currentTime: number
- /** 当前音频的长度(单位 s)。只有在当前有合法的 src 时返回(只读) */
- duration: number
- /** 是否循环播放,默认为 `false` */
- loop: boolean
- /** 是否遵循系统静音开关,默认为 `true`。当此参数为 `false` 时,即使用户打开了静音开关,也能继续发出声音。从 2.3.0 版本开始此参数不生效,使用 [wx.setInnerAudioOption](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.setInnerAudioOption.html) 接口统一设置。 */
- obeyMuteSwitch: boolean
- /** 当前是是否暂停或停止状态(只读) */
- paused: boolean
- /** 需要基础库: `2.11.0`
- *
- * 播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本) */
- playbackRate: number
- /** 需要基础库: `2.13.0`
- *
- * `origin`: 发送完整的referrer; `no-referrer`: 不发送。格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本; */
- referrerPolicy: string
- /** 音频资源的地址,用于直接播放。[2.2.3](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 开始支持云文件ID */
- src: string
- /** 开始播放的位置(单位:s),默认为 0 */
- startTime: number
- /** 需要基础库: `1.9.90`
- *
- * 音量。范围 0~1。默认为 1 */
- volume: number
- }
- interface InnerAudioContextOnErrorCallbackResult {
- /** 可选值:
- * - 10001: 系统错误;
- * - 10002: 网络错误;
- * - 10003: 文件错误;
- * - 10004: 格式错误;
- * - -1: 未知错误; */
- errCode: 10001 | 10002 | 10003 | 10004 | -1
- errMsg: string
- }
- interface InterstitialAdOnErrorCallbackResult {
- /** 错误码
- *
- * 可选值:
- * - 1000: 后端接口调用失败;
- * - 1001: 参数错误;
- * - 1002: 广告单元无效;
- * - 1003: 内部错误;
- * - 1004: 无合适的广告;
- * - 1005: 广告组件审核中;
- * - 1006: 广告组件被驳回;
- * - 1007: 广告组件被封禁;
- * - 1008: 广告单元已关闭; */
- errCode: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008
- /** 错误信息 */
- errMsg: string
- }
- interface InviteFriendOption {
- /** 被邀请玩家的 openId */
- openId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: InviteFriendCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: InviteFriendFailCallback
- /** 接口调用成功的回调函数 */
- success?: InviteFriendSuccessCallback
- }
- interface IsBluetoothDevicePairedOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: IsBluetoothDevicePairedCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: IsBluetoothDevicePairedFailCallback
- /** 接口调用成功的回调函数 */
- success?: IsBluetoothDevicePairedSuccessCallback
- }
- interface JoinRoomOption {
- /** 游戏房间访问凭证 */
- accessInfo: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: JoinRoomCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: JoinRoomFailCallback
- /** 游戏自定义的关于个人的扩展信息,其他人可在 `MemberInfo` 中读取到,最多 32 个字节 */
- memberExtInfo?: string
- /** 接口调用成功的回调函数 */
- success?: JoinRoomSuccessCallback
- }
- interface JoinRoomSuccessCallbackDataResult {
- /** 用户在房间内的唯一标识 */
- clientId: number
- /** 加入房间后被分配的座位号 */
- myPos: number
- }
- interface JoinRoomSuccessCallbackResult {
- data: JoinRoomSuccessCallbackDataResult
- errMsg: string
- }
- interface JoinVoIPChatOption {
- /** 小游戏内此房间/群聊的 ID。同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 */
- groupId: string
- /** 验证所需的随机字符串 */
- nonceStr: string
- /** 签名,用于验证小游戏的身份 */
- signature: string
- /** 验证所需的时间戳 */
- timeStamp: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: JoinVoIPChatCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: JoinVoIPChatFailCallback
- /** 静音设置 */
- muteConfig?: MuteConfig
- /** 房间类型
- *
- * 可选值:
- * - 'voice': 音频房间,用于语音通话;
- * - 'video': 视频房间,结合 [voip-room](#) 组件可显示成员画面; */
- roomType?: 'voice' | 'video'
- /** 接口调用成功的回调函数 */
- success?: JoinVoIPChatSuccessCallback
- }
- interface JoinVoIPChatSuccessCallbackResult {
- /** 错误码 */
- errCode: number
- /** 调用结果 */
- errMsg: string
- /** 在此通话中的成员 openId 名单 */
- openIdList: string[]
- }
- /** 托管的 KV 数据
- *
- * **将排行榜显示在小游戏中心**
- *
- * 若开发者希望把游戏的排行榜显示于小游戏中心,则需要把排行榜数据存储到对应的key/value中,一个排行榜数据对应一个key,多个排行榜则多个key。同时在mp.weixin.qq.com的小游戏管理后台“设置-游戏-排行榜设置”下配置对应的key以及相关排行榜属性。且value的内容必须是JSON Object格式序列化的字符串,该JSON Object顶层必须包含 `wxgame` 字段,定义如下:
- *
- * | 属性名 | 类型 | 必填 | 说明 |
- * |-------------|--------|------|----------------------------------|
- * | score | Int32 | 是 | 该榜单对应分数值 |
- * | update_time | Int64 | 是 | 该分数最后更新时间,Unix时间戳 |
- *
- * 注意: `wxgame`下开发者不可自定义其他字段, `wxgame`同级开发者可自由定义,比如定义一个`detail` 字段,用于存储取得该分数的中间状态。
- *
- * ### 举例
- *
- * 比如某小游戏有一个分数排行榜,分数排行榜需要记录分数以及获得分数的耗时(游戏内的排行榜需要展示耗时),可以在`wxgame`同级别定义一个`cost_ms`字段,存储耗时的毫秒数。
- * 分配一个不和已定义的托管数据的key相冲突的key作为分数排行榜的key,如 "score"。
- *
- * 在玩家耗时36500ms后,获得本周最高分16分,则需要更新分数,假设当前时间戳为1513080573, 则完整 value在序列化之前的内容如下:
- * ```json
- {
- "wxgame": {
- "score":16,
- "update_time": 1513080573
- },
- "cost_ms":36500
- }
- ```
- *
- * 最终序列化为string后,value为`{\"wxgame\":{\"score\":16,\"update_time\": 1513080573},\"cost_ms\":36500}`。 */
- interface KVData {
- /** 数据的 key */
- key: string
- /** 数据的 value */
- value: string
- }
- interface KickoutMemberOption {
- /** 欲踢除的玩家的座位号 */
- kickoutPos: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: KickoutMemberCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: KickoutMemberFailCallback
- /** 接口调用成功的回调函数 */
- success?: KickoutMemberSuccessCallback
- }
- /** 启动参数 */
- interface LaunchOptionsGame {
- /** 启动小游戏的 query 参数 */
- query: IAnyObject
- /** 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 `{}`。(参见后文注意) */
- referrerInfo: EnterOptionsGameReferrerInfo
- /** 启动小游戏的[场景值](https://developers.weixin.qq.com/minigame/dev/devtools/interface/scene.html) */
- scene: number
- /** 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
- *
- * 可选值:
- * - 1: 微信联系人单聊;
- * - 2: 企业微信联系人单聊;
- * - 3: 普通微信群聊;
- * - 4: 企业微信互通群聊; */
- chatType?: 1 | 2 | 3 | 4
- /** shareTicket,详见[获取更多转发信息](#) */
- shareTicket?: string
- }
- interface LoadSubpackageOption {
- /** 分包加载结束回调事件(加载成功、失败都会执行) */
- complete: (...args: any[]) => any
- /** 分包加载失败回调事件 */
- fail: (...args: any[]) => any
- /** 分包的名字,可以填 name 或者 root。在独立分包内,填 \_\_GAME\_\_ 表示加载主包,详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
- name: string
- /** 分包加载成功回调事件 */
- success: (...args: any[]) => any
- }
- interface LoadSubpackageTaskOnProgressUpdateCallbackResult {
- /** 分包下载进度百分比 */
- progress: number
- /** 预期需要下载的数据总长度,单位 Bytes */
- totalBytesExpectedToWrite: number
- /** 已经下载的数据长度,单位 Bytes */
- totalBytesWritten: number
- }
- /** 接收端地址信息,2.18.0 起支持 */
- interface LocalInfo {
- /** 接收消息的 socket 的地址 */
- address: string
- /** 使用的协议族,为 IPv4 或者 IPv6 */
- family: string
- /** 端口号 */
- port: number
- }
- interface LoginOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: LoginCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: LoginFailCallback
- /** 接口调用成功的回调函数 */
- success?: LoginSuccessCallback
- /** 需要基础库: `1.9.90`
- *
- * 超时时间,单位ms */
- timeout?: number
- }
- interface LoginSuccessCallbackResult {
- /** 用户登录凭证(有效期五分钟)。开发者需要在开发者服务器后台调用 [auth.code2Session](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/login/auth.code2Session.html),使用 code 换取 openid、unionid、session_key 等信息 */
- code: string
- errMsg: string
- }
- interface MakeBluetoothPairOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** pin 码,Base64 格式。 */
- pin: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: MakeBluetoothPairCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: MakeBluetoothPairFailCallback
- /** 接口调用成功的回调函数 */
- success?: MakeBluetoothPairSuccessCallback
- /** 超时时间,单位 ms */
- timeout?: number
- }
- /** 广播的制造商信息。仅安卓支持,iOS 因系统限制无法定制。 */
- interface ManufacturerData {
- /** 制造商ID,0x 开头的十六进制 */
- manufacturerId: string
- /** 制造商信息 */
- manufacturerSpecificData?: ArrayBuffer
- }
- /** 匹配到的队伍信息 */
- interface MatchGroupInfo {
- /** 队伍的序号 */
- groupIndex: number
- /** 队伍中成员信息 */
- memberInfoList: MatchMemberInfo[]
- }
- /** 队伍中成员信息 */
- interface MatchMemberInfo {
- /** 队伍中成员的头像 */
- avatarUrl: string
- /** 成员的序号 */
- memberIndex: number
- /** 队伍中成员的昵称 */
- nickName: string
- /** 队伍中成员的openid */
- openId: string
- }
- /** MediaAudioPlayer 实例,可通过 [wx.createMediaAudioPlayer](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createMediaAudioPlayer.html) 接口获取实例。 */
- interface MediaAudioPlayer {
- /** 音量。范围 0~1。默认为 1 */
- volume: number
- }
- /** 需要预览的资源列表 */
- interface MediaSource {
- /** 图片或视频的地址 */
- url: string
- /** 视频的封面图片 */
- poster?: string
- /** 资源的类型,默认为图片
- *
- * 可选值:
- * - 'image': 图片;
- * - 'video': 视频; */
- type?: 'image' | 'video'
- }
- interface MemberLeaveRoomOption {
- /** 游戏房间访问凭证 */
- accessInfo: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: MemberLeaveRoomCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: MemberLeaveRoomFailCallback
- /** 接口调用成功的回调函数 */
- success?: MemberLeaveRoomSuccessCallback
- }
- /** 小程序帐号信息 */
- interface MiniProgram {
- /** 小程序 appId */
- appId: string
- /** 需要基础库: `2.10.0`
- *
- * 小程序版本
- *
- * 可选值:
- * - 'develop': 开发版;
- * - 'trial': 体验版;
- * - 'release': 正式版; */
- envVersion: 'develop' | 'trial' | 'release'
- /** 需要基础库: `2.10.2`
- *
- * 线上小程序版本号 */
- version: string
- }
- interface MkdirFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory ${dirPath}': 上级目录不存在(该错误仅在 recursive = false 时生效);
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- * - 'fail file already exists ${dirPath}': 有同名文件或目录(该错误仅在 recursive = false 时生效);
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface MkdirOption {
- /** 创建的目录路径 (本地路径) */
- dirPath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: MkdirCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: MkdirFailCallback
- /** 需要基础库: `2.3.0`
- *
- * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 */
- recursive?: boolean
- /** 接口调用成功的回调函数 */
- success?: MkdirSuccessCallback
- }
- interface ModifyFriendInteractiveStorageFailCallbackResult {
- /** 错误码
- *
- * 可选值:
- * - -17006: 非好友关系;
- * - -17007: 非法的 toUser openId;
- * - -17008: 非法的 key;
- * - -17009: 非法的 operation;
- * - -17010: 非法的操作数;
- * - -17011: JSServer 校验写操作失败; */
- errCode: -17006 | -17007 | -17008 | -17009 | -17010 | -17011
- /** 错误信息 */
- errMsg: string
- }
- interface ModifyFriendInteractiveStorageOption {
- /** 需要修改的数据的 key,目前可以为 '1' - '50' */
- key: string
- /** 需要修改的数值,目前只能为 1 */
- opNum: number
- /** 修改类型
- *
- * 可选值:
- * - 'add': 加; */
- operation: 'add'
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ModifyFriendInteractiveStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ModifyFriendInteractiveStorageFailCallback
- /** 需要基础库: `2.9.0`
- *
- * 分享图片地址,详见 wx.shareMessageToFriend 同名参数(需要配置模板规则) */
- imageUrl?: string
- /** 需要基础库: `2.9.0`
- *
- * 分享图片 ID,详见 wx.shareMessageToFriend 同名参数(需要配置模板规则) */
- imageUrlId?: string
- /** 需要基础库: `2.9.0`
- *
- * 是否静默修改(不弹框)。当进入场景是好友 [定向分享](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.shareMessageToFriend.html) 的卡片时有效,代表分享反馈操作,此时 `toUser` 默认为原分享者的 openId */
- quiet?: boolean
- /** 接口调用成功的回调函数 */
- success?: ModifyFriendInteractiveStorageSuccessCallback
- /** 需要基础库: `2.9.0`
- *
- * 分享标题,如果设置了这个值,则在交互成功后自动询问用户是否分享给好友(需要配置模板规则) */
- title?: string
- /** 目标好友的 openId */
- toUser?: string
- }
- /** 静音设置 */
- interface MuteConfig {
- /** 是否静音耳机 */
- muteEarphone?: boolean
- /** 是否静音麦克风 */
- muteMicrophone?: boolean
- }
- interface NavigateToMiniProgramOption {
- /** 要打开的小程序 appId */
- appId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: NavigateToMiniProgramCompleteCallback
- /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版,则打开的小程序必定是正式版。
- *
- * 可选值:
- * - 'develop': 开发版;
- * - 'trial': 体验版;
- * - 'release': 正式版; */
- envVersion?: 'develop' | 'trial' | 'release'
- /** 需要传递给目标小程序的数据,目标小程序可在 `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) 中可以获取到这份数据数据。 */
- extraData?: IAnyObject
- /** 接口调用失败的回调函数 */
- fail?: NavigateToMiniProgramFailCallback
- /** 打开的页面路径,如果为空则打开首页。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"。 */
- path?: string
- /** 需要基础库: `2.18.1`
- *
- * 小程序链接,当传递该参数后,可以不传 appId 和 path。链接可以通过【小程序菜单】->【复制链接】获取。 */
- shortLink?: string
- /** 接口调用成功的回调函数 */
- success?: NavigateToMiniProgramSuccessCallback
- }
- interface NotifyBLECharacteristicValueChangeOption {
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙设备 id */
- deviceId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- /** 是否启用 notify */
- state: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: NotifyBLECharacteristicValueChangeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: NotifyBLECharacteristicValueChangeFailCallback
- /** 接口调用成功的回调函数 */
- success?: NotifyBLECharacteristicValueChangeSuccessCallback
- /** 需要基础库: `2.4.0`
- *
- * 设置特征订阅类型,有效值有 `notification` 和 `indication` */
- type?: string
- }
- interface OnAccelerometerChangeCallbackResult {
- /** X 轴 */
- x: number
- /** Y 轴 */
- y: number
- /** Z 轴 */
- z: number
- }
- interface OnAddToFavoritesCallbackResult {
- /** 禁止收藏后长按转发,默认 false */
- disableForward: boolean
- /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
- imageUrl: string
- /** 查询字符串,必须是 key1=val1&key2=val2 的格式。从收藏进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。 */
- query: string
- /** 收藏标题,不传则默认使用当前小游戏的昵称。 */
- title: string
- }
- interface OnBLECharacteristicValueChangeCallbackResult {
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙设备 id */
- deviceId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- /** 特征最新的值 */
- value: ArrayBuffer
- }
- interface OnBLEConnectionStateChangeCallbackResult {
- /** 是否处于已连接状态 */
- connected: boolean
- /** 蓝牙设备 id */
- deviceId: string
- }
- interface OnBLEMTUChangeCallbackResult {
- /** 蓝牙设备 id */
- deviceId: string
- /** 最大传输单元 */
- mtu: number
- }
- interface OnBLEPeripheralConnectionStateChangedCallbackResult {
- /** 连接目前状态 */
- connected: boolean
- /** 连接状态变化的设备 id */
- deviceId: string
- /** server 的 UUID */
- serverId: string
- }
- interface OnBeKickedOutCallbackResult {
- res: IAnyObject
- }
- interface OnBeaconServiceChangeCallbackResult {
- /** 服务目前是否可用 */
- available: boolean
- /** 目前是否处于搜索状态 */
- discovering: boolean
- }
- interface OnBeaconUpdateCallbackResult {
- /** 当前搜寻到的所有 Beacon 设备列表 */
- beacons: BeaconInfo[]
- }
- interface OnBluetoothAdapterStateChangeCallbackResult {
- /** 蓝牙适配器是否可用 */
- available: boolean
- /** 蓝牙适配器是否处于搜索状态 */
- discovering: boolean
- }
- interface OnBluetoothDeviceFoundCallbackResult {
- /** 新搜索到的设备列表 */
- devices: BlueToothDevice[]
- }
- interface OnBroadcastCallbackResult {
- /** 广播消息 */
- msg: string
- }
- interface OnCameraFrameCallbackResult {
- /** 图像像素点数据,一维数组,每四项表示一个像素点的 rgba */
- data: ArrayBuffer
- /** 图像数据矩形的高度 */
- height: number
- /** 图像数据矩形的宽度 */
- width: number
- }
- interface OnCharacteristicReadRequestCallbackResult {
- /** 唯一标识码,调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 时使用 */
- callbackId: number
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- }
- interface OnCharacteristicSubscribedCallbackResult {
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- }
- interface OnCharacteristicWriteRequestCallbackResult {
- /** 唯一标识码,调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 时使用 */
- callbackId: number
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- /** 请求写入特征的二进制数据值 */
- value: ArrayBuffer
- }
- interface OnCheckForUpdateCallbackResult {
- /** 是否有新版本 */
- hasUpdate: boolean
- }
- /** 开发者服务器每次返回新chunk时的Response */
- interface OnChunkReceivedCallbackResult {
- /** 返回的chunk buffer */
- data: ArrayBuffer
- }
- interface OnCompassChangeCallbackResult {
- /** 需要基础库: `2.4.0`
- *
- * 精度 */
- accuracy: number | string
- /** 面对的方向度数 */
- direction: number
- }
- interface OnCopyUrlCallbackResult {
- /** 用短链打开小程序时当前页面携带的查询字符串。小程序中使用时,应在进入页面时调用 `wx.onCopyUrl` 自定义 `query`,退出页面时调用 `wx.offCopyUrl`,防止影响其它页面。 */
- query: string
- }
- interface OnDeviceMotionChangeCallbackResult {
- /** 当 手机坐标 X/Y 和 地球 X/Y 重合时,绕着 Z 轴转动的夹角为 alpha,范围值为 [0, 2*PI)。逆时针转动为正。 */
- alpha: number
- /** 当手机坐标 Y/Z 和地球 Y/Z 重合时,绕着 X 轴转动的夹角为 beta。范围值为 [-1*PI, PI) 。顶部朝着地球表面转动为正。也有可能朝着用户为正。 */
- beta: number
- /** 当手机 X/Z 和地球 X/Z 重合时,绕着 Y 轴转动的夹角为 gamma。范围值为 [-1*PI/2, PI/2)。右边朝着地球表面转动为正。 */
- gamma: number
- }
- interface OnDeviceOrientationChangeCallbackResult {
- /** 表示切换后的屏幕是横屏还是竖屏
- *
- * 可选值:
- * - 'portrait': 竖屏;
- * - 'landscape': 横屏正方向,以 HOME 键在屏幕右侧为正方向;
- * - 'landscapeReverse': 横屏反方向,以 HOME 键在屏幕左侧为反方向; */
- value: 'portrait' | 'landscape' | 'landscapeReverse'
- }
- interface OnDisconnectCallbackResult {
- /** 可选值:
- * - 'room': 房间服务断开连接,只有在进入房间后有机会收到。房间服务断开连接后,将无法进行房间相关的操作,以及无法收到房间信息变化事件。;
- * - 'game': 游戏服务断开连接,只有在游戏开始后有机会收到。游戏服务断开连接后,将无法收发帧。; */
- type: 'room' | 'game'
- }
- interface OnFrameRecordedCallbackResult {
- /** 录音分片数据 */
- frameBuffer: ArrayBuffer
- /** 当前帧是否正常录音结束前的最后一帧 */
- isLastFrame: boolean
- }
- interface OnGameEndCallbackResult {
- /** 游戏唯一标识,用于后台接口拉取对局记录 */
- gameAccessInfo: string
- }
- interface OnGyroscopeChangeCallbackResult {
- /** x 轴的角速度 */
- x: number
- /** y 轴的角速度 */
- y: number
- /** z 轴的角速度 */
- z: number
- }
- interface OnHandoffCallbackResult {
- /** 需要传递给接力客户端的 query */
- query: string
- }
- interface OnHeadersReceivedCallbackResult {
- /** 开发者服务器返回的 HTTP Response Header */
- header: IAnyObject
- }
- interface OnInviteCallbackResult {
- /** 邀请者附带的额外信息 */
- data: string
- /** 邀请者的 openId */
- openId: string
- res: IAnyObject
- }
- interface OnKeyDownCallbackResult {
- /** 同 Web 规范 KeyEvent code 属性 */
- code: string
- /** 同 Web 规范 KeyEvent key 属性 */
- key: string
- /** 事件触发时的时间戳 */
- timeStamp: number
- }
- interface OnKeyboardHeightChangeCallbackResult {
- /** 键盘高度 */
- height: number
- }
- interface OnKeyboardInputCallbackResult {
- /** 键盘输入的当前值 */
- value: string
- }
- interface OnLockStepErrorCallbackResult {
- /** 错误码 */
- errCode: number
- /** 错误原因 */
- errMsg: string
- }
- interface OnMatchCallbackResult {
- /** 匹配到的队伍信息 */
- groupInfoList: MatchGroupInfo[]
- /** 与 startMatch 一致的 matchId */
- matchId: string
- /** 自己的 openId */
- openId: string
- /** 唯一的本次对局id */
- raceId: string
- /** 房间服务的accessinfo,如果matchid中指定需要匹配完成时创建房间服务,则会携带下来,后续调用房间服务相关接口加入房间即可 */
- roomServiceAccessInfo: string
- }
- interface OnMemoryWarningCallbackResult {
- /** 内存告警等级,只有 Android 才有,对应系统宏定义
- *
- * 可选值:
- * - 5: TRIM_MEMORY_RUNNING_MODERATE;
- * - 10: TRIM_MEMORY_RUNNING_LOW;
- * - 15: TRIM_MEMORY_RUNNING_CRITICAL; */
- level: 5 | 10 | 15
- }
- interface OnMouseDownCallbackResult {
- /** 按键类型,0左键,1中键,2右键 */
- button: number
- /** 事件触发时的时间戳 */
- timeStamp: number
- /** 事件触发时鼠标所在的位置横坐标 */
- x: number
- /** 事件触发时鼠标所在的位置纵坐标 */
- y: number
- }
- interface OnMouseMoveCallbackResult {
- /** 鼠标横坐标偏移量 */
- movementX: number
- /** 鼠标纵坐标偏移量 */
- movementY: number
- /** 事件触发时的时间戳 */
- timeStamp: number
- /** 事件触发时鼠标所在的位置横坐标 */
- x: number
- /** 事件触发时鼠标所在的位置纵坐标 */
- y: number
- }
- interface OnNetworkStatusChangeCallbackResult {
- /** 当前是否有网络连接 */
- isConnected: boolean
- /** 网络类型
- *
- * 可选值:
- * - 'wifi': wifi 网络;
- * - '2g': 2g 网络;
- * - '3g': 3g 网络;
- * - '4g': 4g 网络;
- * - 'unknown': Android 下不常见的网络类型;
- * - 'none': 无网络; */
- networkType: 'wifi' | '2g' | '3g' | '4g' | 'unknown' | 'none'
- }
- interface OnNetworkWeakChangeCallbackResult {
- /** 当前网络类型 */
- networkType: string
- /** 当前是否处于弱网状态 */
- weakNet: boolean
- }
- interface OnOpenCallbackResult {
- /** 需要基础库: `2.0.0`
- *
- * 连接成功的 HTTP 响应 Header */
- header: IAnyObject
- /** 需要基础库: `2.10.4`
- *
- * 网络请求过程中一些调试信息 */
- profile: SocketProfile
- }
- interface OnProgressCallbackResult {
- /** 当前的缓冲进度,缓冲进度区间为 (0~100],100表示缓冲完成 */
- buffered: number
- /** 视频的总时长,单位为秒 */
- duration: number
- }
- interface OnResizeCallbackResult {
- /** 缩放后的高度 */
- height: number
- /** 缩放后的宽度 */
- width: number
- }
- interface OnRoomInfoChangeCallbackResult {
- /** 小游戏 appId */
- appId: string
- /** 创建时间 */
- createTimestamp: number
- /** 游戏对局时长,单位 s */
- gameLastTime: number
- /** 游戏下发帧的时间间隔,单位 ms */
- gameTick: number
- /** 房间最多可容纳人数 */
- maxMemberNum: number
- /** 成员列表 */
- memberList: RoomMemberInfo[]
- /** 游戏自定义的关于房间的扩展信息 */
- roomExtInfo: string
- /** 房间 ID */
- roomIdStr: number
- /** 房间状态
- *
- * 可选值:
- * - 1: 组队中;
- * - 2: 该房间的对局游戏已开始;
- * - 3: 该房间的对局游戏已结束;
- * - 4: 房间已销毁;
- * - 5: 房间连接已建立,等待对战连接建立; */
- roomState: 1 | 2 | 3 | 4 | 5
- /** 游戏随机种子 */
- seed: string
- /** 需要满足百分比的玩家都发送了开始指令才能启动游戏。有效范围 0~100,0 表示只要有一个人调用开始就启动,100 表示要求所有人都开始才能启动。 */
- startPercent: number
- /** UDP可靠性策略, 0:全冗余 N:固定冗余N帧 */
- udpReliabilityStrategy: number
- /** 最近更新时间 */
- updateTimestamp: number
- }
- interface OnShareAppMessageCallbackResult {
- /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
- imageUrl: string
- /** 查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。 */
- query: string
- /** 转发标题,不传则默认使用当前小游戏的昵称。 */
- title: string
- /** 需要基础库: `2.4.3`
- *
- * 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
- imageUrlId?: string
- /** 需要基础库: `2.12.2`
- *
- * 独立分包路径。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
- path?: string
- /** 需要基础库: `2.12.0`
- *
- * 如果该参数存在,则其它的参数将会以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数 */
- promise?: Promise<any>
- /** 需要基础库: `2.12.2`
- *
- * 是否转发到当前群。该参数只对从群工具栏打开的场景下生效,默认转发到当前群,填入false时可转发到其他会话。 */
- toCurrentGroup?: boolean
- }
- interface OnShareMessageToFriendCallbackResult {
- /** 错误信息 */
- errMsg: string
- /** 是否成功 */
- success: boolean
- }
- interface OnShareTimelineCallbackResult {
- /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。(该图片用于分享到朋友圈的卡片以及从朋友圈转发到会话消息的卡片展示) */
- imageUrl: string
- /** 需要基础库: `2.14.3`
- *
- * 朋友圈预览图链接,不传则默认使用当前游戏画面截图 */
- imagePreviewUrl?: string
- /** 需要基础库: `2.14.3`
- *
- * 审核通过的朋友圈预览图图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
- imagePreviewUrlId?: string
- /** 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
- imageUrlId?: string
- /** 需要基础库: `2.12.2`
- *
- * 独立分包路径。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
- path?: string
- /** 查询字符串,必须是 key1=val1&key2=val2 的格式。从这条转发消息进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。不传则默认使用当前页面query。 */
- query?: string
- /** 转发标题,不传则默认使用当前小游戏的昵称。 */
- title?: string
- }
- interface OnShowCallbackResult {
- /** 查询参数 */
- query: IAnyObject
- /** 当场景为由从另一个小程序或公众号或App打开时,返回此字段 */
- referrerInfo: ResultReferrerInfo
- /** 场景值 */
- scene: number
- /** shareTicket */
- shareTicket?: string
- }
- interface OnSocketOpenCallbackResult {
- /** 需要基础库: `2.0.0`
- *
- * 连接成功的 HTTP 响应 Header */
- header: IAnyObject
- }
- interface OnStateUpdateCallbackResult {
- /** 好友 openId */
- openId: string
- /** 系统状态,0 掉线 1 在线 */
- sysState: number
- /** 该玩家的自定义状态信息 */
- userState: string
- }
- interface OnStopCallbackResult {
- /** 录音总时长,单位:ms */
- duration: number
- /** 录音文件大小,单位:Byte */
- fileSize: number
- /** 录音文件的临时路径 (本地路径) */
- tempFilePath: string
- }
- interface OnSyncFrameCallbackResult {
- /** 帧数据列表,如果为空则说明该帧是空帧,每一项的类型与配置项 `lockStepOption.dataType` 一致 */
- actionList: string[] | ArrayBuffer[]
- /** 帧号,从 1 开始递增 */
- frameId: number
- }
- interface OnTapCallbackResult {
- /** 包括敏感数据在内的完整用户信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- encryptedData: string
- /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- iv: string
- /** 不包括敏感信息的原始数据字符串,用于计算签名 */
- rawData: string
- /** 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息,参考文档[signature](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- signature: string
- /** [UserInfo](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfo.html)
- *
- * 用户信息对象,不包含 openid 等敏感信息 */
- userInfo: UserInfo
- }
- interface OnTimeUpdateCallbackResult {
- /** 视频的总时长,单位为秒 */
- duration: number
- /** 当前的播放位置,单位为秒 */
- position: number
- }
- interface OnTouchStartCallbackResult {
- /** 触发此次事件的触摸点列表 */
- changedTouches: Touch[]
- /** 事件触发时的时间戳 */
- timeStamp: number
- /** 当前所有触摸点的列表 */
- touches: Touch[]
- }
- interface OnUnhandledRejectionCallbackResult {
- /** 被拒绝的 promise 对象 */
- promise: string
- /** 拒绝原因,一般是一个 Error 对象 */
- reason: string
- }
- interface OnVoIPChatInterruptedCallbackResult {
- /** 错误码 */
- errCode: number
- /** 调用结果(错误原因) */
- errMsg: string
- }
- interface OnVoIPChatMembersChangedCallbackResult {
- /** 错误码 */
- errCode: number
- /** 调用结果 */
- errMsg: string
- /** 还在实时语音通话中的成员 openId 名单 */
- openIdList: string[]
- }
- interface OnVoIPChatSpeakersChangedCallbackResult {
- /** 错误码 */
- errCode: number
- /** 调用结果(错误原因) */
- errMsg: string
- /** 还在实时语音通话中的成员 openId 名单 */
- openIdList: string[]
- }
- interface OnVoIPChatStateChangedCallbackResult {
- /** 事件码 */
- code: number
- /** 附加信息 */
- data: IAnyObject
- /** 错误码 */
- errCode: number
- /** 调用结果 */
- errMsg: string
- }
- interface OnWheelCallbackResult {
- /** 滚轮 x 轴方向滚动量 */
- deltaX: number
- /** 滚轮 y 轴方向滚动量 */
- deltaY: number
- /** 滚轮 z 轴方向滚动量 */
- deltaZ: number
- /** 事件触发时的时间戳 */
- timeStamp: number
- /** 事件触发时鼠标所在的位置横坐标 */
- x: number
- /** 事件触发时鼠标所在的位置纵坐标 */
- y: number
- }
- interface OnWindowResizeCallbackResult {
- /** 变化后的窗口高度,单位 px */
- windowHeight: number
- /** 变化后的窗口宽度,单位 px */
- windowWidth: number
- }
- interface OpenBluetoothAdapterOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenBluetoothAdapterCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenBluetoothAdapterFailCallback
- /** 需要基础库: `2.10.0`
- *
- * 蓝牙模式,可作为主/从设备,仅 iOS 需要。
- *
- * 可选值:
- * - 'central': 主机模式;
- * - 'peripheral': 从机(外围设备)模式; */
- mode?: 'central' | 'peripheral'
- /** 接口调用成功的回调函数 */
- success?: OpenBluetoothAdapterSuccessCallback
- }
- interface OpenCardOption {
- /** 需要打开的卡券列表 */
- cardList: OpenCardRequestInfo[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenCardCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenCardFailCallback
- /** 接口调用成功的回调函数 */
- success?: OpenCardSuccessCallback
- }
- /** 需要打开的卡券列表 */
- interface OpenCardRequestInfo {
- /** 卡券 ID */
- cardId: string
- /** 由 [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) */
- code: string
- }
- interface OpenChannelsActivityOption {
- /** 视频 feedId */
- feedId: string
- /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
- finderUserName: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenChannelsActivityCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenChannelsActivityFailCallback
- /** 接口调用成功的回调函数 */
- success?: OpenChannelsActivitySuccessCallback
- }
- interface OpenChannelsEventOption {
- /** 活动 id */
- eventId: string
- /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
- finderUserName: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenChannelsEventCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenChannelsEventFailCallback
- /** 接口调用成功的回调函数 */
- success?: OpenChannelsEventSuccessCallback
- }
- interface OpenChannelsLiveOption {
- /** 视频号 id,以“sph”开头的id,可在视频号助手获取 */
- finderUserName: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenChannelsLiveCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenChannelsLiveFailCallback
- /** 直播 feedId,通过 getChannelsLiveInfo 接口获取(基础库 v2.19.2 之前的版本需要填写) */
- feedId?: string
- /** 直播 nonceId,通过 getChannelsLiveInfo 接口获取(基础库 v2.19.2 之前的版本需要填写) */
- nonceId?: string
- /** 接口调用成功的回调函数 */
- success?: OpenChannelsLiveSuccessCallback
- }
- interface OpenChannelsUserProfileOption {
- /** 视频号 id */
- finderUserName: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenChannelsUserProfileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenChannelsUserProfileFailCallback
- /** 接口调用成功的回调函数 */
- success?: OpenChannelsUserProfileSuccessCallback
- }
- interface OpenCustomerServiceConversationOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenCustomerServiceConversationCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenCustomerServiceConversationFailCallback
- /** 会话内消息卡片图片路径 */
- sendMessageImg?: string
- /** 会话内消息卡片路径 */
- sendMessagePath?: string
- /** 会话内消息卡片标题 */
- sendMessageTitle?: string
- /** 会话来源 */
- sessionFrom?: string
- /** 是否显示会话内消息卡片,设置此参数为 true,用户进入客服会话会在右下角显示"可能要发送的小程序"提示,用户点击后可以快速发送小程序消息 */
- showMessageCard?: boolean
- /** 接口调用成功的回调函数 */
- success?: OpenCustomerServiceConversationSuccessCallback
- }
- /** 开放数据域对象 */
- interface OpenDataContext {
- /** [Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html)
- *
- * 开放数据域和主域共享的 sharedCanvas */
- canvas: Canvas
- }
- interface OpenFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory "${filePath}"': 上级目录不存在; */
- errMsg: string
- }
- interface OpenOption {
- /** 文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenFailCallback
- /** 文件系统标志,默认值: 'r'
- *
- * 可选值:
- * - 'a': 打开文件用于追加。 如果文件不存在,则创建该文件;
- * - 'ax': 类似于 'a',但如果路径存在,则失败;
- * - 'a+': 打开文件用于读取和追加。 如果文件不存在,则创建该文件;
- * - 'ax+': 类似于 'a+',但如果路径存在,则失败;
- * - 'as': 打开文件用于追加(在同步模式中)。 如果文件不存在,则创建该文件;
- * - 'as+': 打开文件用于读取和追加(在同步模式中)。 如果文件不存在,则创建该文件;
- * - 'r': 打开文件用于读取。 如果文件不存在,则会发生异常;
- * - 'r+': 打开文件用于读取和写入。 如果文件不存在,则会发生异常;
- * - 'w': 打开文件用于写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
- * - 'wx': 类似于 'w',但如果路径存在,则失败;
- * - 'w+': 打开文件用于读取和写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
- * - 'wx+': 类似于 'w+',但如果路径存在,则失败; */
- flag?:
- | 'a'
- | 'ax'
- | 'a+'
- | 'ax+'
- | 'as'
- | 'as+'
- | 'r'
- | 'r+'
- | 'w'
- | 'wx'
- | 'w+'
- | 'wx+'
- /** 接口调用成功的回调函数 */
- success?: OpenSuccessCallback
- }
- /** 用户点击后打开设置页面的按钮 */
- interface OpenSettingButton {
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- interface OpenSettingOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OpenSettingCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OpenSettingFailCallback
- /** 接口调用成功的回调函数 */
- success?: OpenSettingSuccessCallback
- /** 需要基础库: `2.10.3`
- *
- * 是否同时获取用户订阅消息的订阅状态,默认不获取。注意:withSubscriptions 只返回用户勾选过订阅面板中的“总是保持以上选择,不再询问”的订阅消息。 */
- withSubscriptions?: boolean
- }
- interface OpenSettingSuccessCallbackResult {
- /** [AuthSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/AuthSetting.html)
- *
- * 用户授权结果 */
- authSetting: AuthSetting
- /** [SubscriptionsSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/SubscriptionsSetting.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 用户订阅消息设置,接口参数`withSubscriptions`值为`true`时才会返回。 */
- subscriptionsSetting: SubscriptionsSetting
- errMsg: string
- }
- interface OpenSuccessCallbackResult {
- /** 文件描述符 */
- fd: string
- errMsg: string
- }
- interface OpenSyncOption {
- /** 文件路径 (本地路径) */
- filePath: string
- /** 文件系统标志,默认值: 'r'
- *
- * 可选值:
- * - 'a': 打开文件用于追加。 如果文件不存在,则创建该文件;
- * - 'ax': 类似于 'a',但如果路径存在,则失败;
- * - 'a+': 打开文件用于读取和追加。 如果文件不存在,则创建该文件;
- * - 'ax+': 类似于 'a+',但如果路径存在,则失败;
- * - 'as': 打开文件用于追加(在同步模式中)。 如果文件不存在,则创建该文件;
- * - 'as+': 打开文件用于读取和追加(在同步模式中)。 如果文件不存在,则创建该文件;
- * - 'r': 打开文件用于读取。 如果文件不存在,则会发生异常;
- * - 'r+': 打开文件用于读取和写入。 如果文件不存在,则会发生异常;
- * - 'w': 打开文件用于写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
- * - 'wx': 类似于 'w',但如果路径存在,则失败;
- * - 'w+': 打开文件用于读取和写入。 如果文件不存在则创建文件,如果文件存在则截断文件;
- * - 'wx+': 类似于 'w+',但如果路径存在,则失败; */
- flag?:
- | 'a'
- | 'ax'
- | 'a+'
- | 'ax+'
- | 'as'
- | 'as+'
- | 'r'
- | 'r+'
- | 'w'
- | 'wx'
- | 'w+'
- | 'wx+'
- }
- /** 按钮的样式 */
- interface OptionStyle {
- /** 背景颜色 */
- backgroundColor: string
- /** 边框颜色 */
- borderColor: string
- /** 边框圆角 */
- borderRadius: number
- /** 边框宽度 */
- borderWidth: number
- /** 文本的颜色。格式为 6 位 16 进制数。 */
- color: string
- /** 字号 */
- fontSize: number
- /** 高度 */
- height: number
- /** 左上角横坐标 */
- left: number
- /** 文本的行高 */
- lineHeight: number
- /** 文本的水平居中方式
- *
- * 可选值:
- * - 'left': 居左;
- * - 'center': 居中;
- * - 'right': 居右; */
- textAlign: 'left' | 'center' | 'right'
- /** 左上角纵坐标 */
- top: number
- /** 宽度 */
- width: number
- }
- interface OwnerLeaveRoomOption {
- /** 游戏房间访问凭证 */
- accessInfo: string
- /** 指定座位号的玩家接任房主角色,优先级高于 assignToMinPosNum */
- assignOwnerToPosNum?: boolean
- /** 自动指定最小座位号玩家作为新房主 */
- assignToMinPosNum?: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: OwnerLeaveRoomCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: OwnerLeaveRoomFailCallback
- /** 接口调用成功的回调函数 */
- success?: OwnerLeaveRoomSuccessCallback
- }
- /** 插件帐号信息(仅在插件中调用时包含这一项) */
- interface Plugin {
- /** 插件 appId */
- appId: string
- /** 插件版本号 */
- version: string
- }
- interface PreviewImageOption {
- /** 需要预览的图片链接列表。[2.2.3](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起支持云文件ID。 */
- urls: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: PreviewImageCompleteCallback
- /** 当前显示图片的链接 */
- current?: string
- /** 接口调用失败的回调函数 */
- fail?: PreviewImageFailCallback
- /** 需要基础库: `2.13.0`
- *
- * `origin`: 发送完整的referrer; `no-referrer`: 不发送。格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本; */
- referrerPolicy?: string
- /** 需要基础库: `2.13.0`
- *
- * 是否显示长按菜单。
- *
- * 支持识别的码:小程序码
- *
- * 仅小程序支持识别的码:微信个人码、微信群码、企业微信个人码、 企业微信群码与企业微信互通群码; */
- showmenu?: boolean
- /** 接口调用成功的回调函数 */
- success?: PreviewImageSuccessCallback
- }
- interface PreviewMediaOption {
- /** 需要预览的资源列表 */
- sources: MediaSource[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: PreviewMediaCompleteCallback
- /** 当前显示的资源序号 */
- current?: number
- /** 接口调用失败的回调函数 */
- fail?: PreviewMediaFailCallback
- /** 需要基础库: `2.13.0`
- *
- * `origin`: 发送完整的referrer; `no-referrer`: 不发送。格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本; */
- referrerPolicy?: string
- /** 需要基础库: `2.13.0`
- *
- * 是否显示长按菜单。
- *
- * 支持识别的码:小程序码
- *
- * 仅小程序支持识别的码:微信个人码、微信群码、企业微信个人码、 企业微信群码与企业微信互通群码; */
- showmenu?: boolean
- /** 接口调用成功的回调函数 */
- success?: PreviewMediaSuccessCallback
- }
- interface ReadBLECharacteristicValueOption {
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙设备 id */
- deviceId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReadBLECharacteristicValueCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ReadBLECharacteristicValueFailCallback
- /** 接口调用成功的回调函数 */
- success?: ReadBLECharacteristicValueSuccessCallback
- }
- interface ReadCompressedFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail decompress fail': 指定的 compressionAlgorithm 与文件实际压缩格式不符;
- * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限; */
- errMsg: string
- }
- interface ReadCompressedFileOption {
- /** 文件压缩类型,目前仅支持 'br'。
- *
- * 可选值:
- * - 'br': brotli压缩文件; */
- compressionAlgorithm: 'br'
- /** 要读取的文件的路径 (本地用户文件或代码包文件) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReadCompressedFileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ReadCompressedFileFailCallback
- /** 接口调用成功的回调函数 */
- success?: ReadCompressedFileSuccessCallback
- }
- interface ReadCompressedFileSuccessCallbackResult {
- /** 文件内容 */
- data: ArrayBuffer
- errMsg: string
- }
- interface ReadCompressedFileSyncOption {
- /** 文件压缩类型,目前仅支持 'br'。
- *
- * 可选值:
- * - 'br': brotli压缩文件; */
- compressionAlgorithm: 'br'
- /** 要读取的文件的路径 (本地用户文件或代码包文件) */
- filePath: string
- }
- interface ReadFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'bad file descriptor': 无效的文件描述符;
- * - 'fail permission denied': 指定的 fd 路径没有读权限;
- * - 'fail the value of "offset" is out of range': 传入的 offset 不合法;
- * - 'fail the value of "length" is out of range': 传入的 length 不合法;
- * - 'fail sdcard not mounted': android sdcard 挂载失败;
- * - 'bad file descriptor': 无效的文件描述符; */
- errMsg: string
- }
- interface ReadFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface ReadFileOption {
- /** 要读取的文件的路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReadFileCompleteCallback
- /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 接口调用失败的回调函数 */
- fail?: ReadFileFailCallback
- /** 需要基础库: `2.10.0`
- *
- * 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
- length?: number
- /** 需要基础库: `2.10.0`
- *
- * 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
- position?: number
- /** 接口调用成功的回调函数 */
- success?: ReadFileSuccessCallback
- }
- interface ReadFileSuccessCallbackResult {
- /** 文件内容 */
- data: string | ArrayBuffer
- errMsg: string
- }
- interface ReadOption {
- /** 数据写入的缓冲区,必须是 ArrayBuffer 实例 */
- arrayBuffer: ArrayBuffer
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReadCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ReadFailCallback
- /** 要从文件中读取的字节数,默认0 */
- length?: number
- /** 缓冲区中的写入偏移量,默认0 */
- offset?: number
- /** 文件读取的起始位置,如不传或传 null,则会从当前文件指针的位置读取。如果 position 是正整数,则文件指针位置会保持不变并从 position 读取文件。 */
- position?: number
- /** 接口调用成功的回调函数 */
- success?: ReadSuccessCallback
- }
- /** 文件读取结果。 通过 [FileSystemManager.readSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readSync.html) 接口返回 */
- interface ReadResult {
- /** 被写入的缓存区的对象,即接口入参的 arrayBuffer */
- arrayBuffer: ArrayBuffer
- /** 实际读取的字节数 */
- bytesRead: number
- }
- interface ReadSuccessCallbackResult {
- /** 被写入的缓存区的对象,即接口入参的 arrayBuffer */
- arrayBuffer: ArrayBuffer
- /** 实际读取的字节数 */
- bytesRead: number
- errMsg: string
- }
- interface ReadSyncOption {
- /** 数据写入的缓冲区,必须是 ArrayBuffer 实例 */
- arrayBuffer: ArrayBuffer
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 要从文件中读取的字节数,默认0 */
- length?: number
- /** 缓冲区中的写入偏移量,默认0 */
- offset?: number
- /** 文件读取的起始位置,如不传或传 null,则会从当前文件指针的位置读取。如果 position 是正整数,则文件指针位置会保持不变并从 position 读取文件。 */
- position?: number
- }
- interface ReadZipEntryOption {
- /** 要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件) */
- entries: EntryItem[] | 'all'
- /** 要读取的压缩包的路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReadZipEntryCompleteCallback
- /** 统一指定读取文件的字符编码,只在 entries 值为"all"时有效。如果 entries 值为"all"且不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 接口调用失败的回调函数 */
- fail?: ReadZipEntryFailCallback
- /** 接口调用成功的回调函数 */
- success?: ReadZipEntrySuccessCallback
- }
- interface ReadZipEntrySuccessCallbackResult {
- /** 文件读取结果。res.entries 是一个对象,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。 */
- entries: EntriesResult
- errMsg: string
- }
- interface ReaddirFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory ${dirPath}': 目录不存在;
- * - 'fail not a directory ${dirPath}': dirPath 不是目录;
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有读权限;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface ReaddirOption {
- /** 要读取的目录路径 (本地路径) */
- dirPath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReaddirCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ReaddirFailCallback
- /** 接口调用成功的回调函数 */
- success?: ReaddirSuccessCallback
- }
- interface ReaddirSuccessCallbackResult {
- /** 指定目录下的文件名数组。 */
- files: string[]
- errMsg: string
- }
- interface ReconnectOption {
- /** 需要重连的对局房间唯一标识 */
- accessInfo: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ReconnectCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ReconnectFailCallback
- /** 接口调用成功的回调函数 */
- success?: ReconnectSuccessCallback
- }
- interface ReconnectSuccessCallbackDataResult {
- /** 此时服务器的最大帧号。 */
- maxFrameId: any[]
- }
- interface ReconnectSuccessCallbackResult {
- data: ReconnectSuccessCallbackDataResult
- errMsg: string
- }
- interface RecorderManagerStartOption {
- /** 需要基础库: `2.1.0`
- *
- * 指定录音的音频输入源,可通过 [wx.getAvailableAudioSources()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.getAvailableAudioSources.html) 获取当前可用的音频源
- *
- * 可选值:
- * - 'auto': 自动设置,默认使用手机麦克风,插上耳麦后自动切换使用耳机麦克风,所有平台适用;
- * - 'buildInMic': 手机麦克风,仅限 iOS;
- * - 'headsetMic': 有线耳机麦克风,仅限 iOS;
- * - 'mic': 麦克风(没插耳麦时是手机麦克风,插耳麦时是耳机麦克风),仅限 Android;
- * - 'camcorder': 同 mic,适用于录制音视频内容,仅限 Android;
- * - 'voice_communication': 同 mic,适用于实时沟通,仅限 Android;
- * - 'voice_recognition': 同 mic,适用于语音识别,仅限 Android; */
- audioSource?:
- | 'auto'
- | 'buildInMic'
- | 'headsetMic'
- | 'mic'
- | 'camcorder'
- | 'voice_communication'
- | 'voice_recognition'
- /** 录音的时长,单位 ms,最大值 600000(10 分钟) */
- duration?: number
- /** 编码码率,有效值见下表格 */
- encodeBitRate?: number
- /** 音频格式
- *
- * 可选值:
- * - 'mp3': mp3 格式;
- * - 'aac': aac 格式;
- * - 'wav': wav 格式;
- * - 'PCM': pcm 格式; */
- format?: 'mp3' | 'aac' | 'wav' | 'PCM'
- /** 指定帧大小,单位 KB。传入 frameSize 后,每录制指定帧大小的内容后,会回调录制的文件内容,不指定则不会回调。暂仅支持 mp3、pcm 格式。 */
- frameSize?: number
- /** 录音通道数
- *
- * 可选值:
- * - 1: 1 个通道;
- * - 2: 2 个通道; */
- numberOfChannels?: 1 | 2
- /** 采样率(pc不支持)
- *
- * 可选值:
- * - 8000: 8000 采样率;
- * - 11025: 11025 采样率;
- * - 12000: 12000 采样率;
- * - 16000: 16000 采样率;
- * - 22050: 22050 采样率;
- * - 24000: 24000 采样率;
- * - 32000: 32000 采样率;
- * - 44100: 44100 采样率;
- * - 48000: 48000 采样率; */
- sampleRate?:
- | 8000
- | 11025
- | 12000
- | 16000
- | 22050
- | 24000
- | 32000
- | 44100
- | 48000
- }
- /** 发送端地址信息 */
- interface RemoteInfo {
- /** 发送消息的 socket 的地址 */
- address: string
- /** 使用的协议族,为 IPv4 或者 IPv6 */
- family: string
- /** 端口号 */
- port: number
- /** message 的大小,单位:字节 */
- size: number
- }
- interface RemoveSavedFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail file not exist': 指定的 tempFilePath 找不到文件; */
- errMsg: string
- }
- interface RemoveSavedFileOption {
- /** 需要删除的文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RemoveSavedFileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RemoveSavedFileFailCallback
- /** 接口调用成功的回调函数 */
- success?: RemoveSavedFileSuccessCallback
- }
- interface RemoveServiceOption {
- /** service 的 UUID */
- serviceId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RemoveServiceCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RemoveServiceFailCallback
- /** 接口调用成功的回调函数 */
- success?: RemoveServiceSuccessCallback
- }
- interface RemoveStorageOption {
- /** 本地缓存中指定的 key */
- key: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RemoveStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RemoveStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: RemoveStorageSuccessCallback
- }
- interface RemoveUserCloudStorageOption {
- /** 要删除掉 key 列表 */
- keyList: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RemoveUserCloudStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RemoveUserCloudStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: RemoveUserCloudStorageSuccessCallback
- }
- interface RenameFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail permission denied, rename ${oldPath} -> ${newPath}': 指定源文件或目标文件没有写权限;
- * - 'fail no such file or directory, rename ${oldPath} -> ${newPath}': 源文件不存在,或目标文件路径的上层目录不存在; */
- errMsg: string
- }
- interface RenameOption {
- /** 新文件路径,支持本地路径 */
- newPath: string
- /** 源文件路径,支持本地路径 */
- oldPath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RenameCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RenameFailCallback
- /** 接口调用成功的回调函数 */
- success?: RenameSuccessCallback
- }
- /** 画布对象的绘图上下文。
- *
- * - 通过 Canvas.getContext('2d') 接口可以获取 CanvasRenderingContext2D 对象,实现了 [HTML Canvas 2D Context](https://www.w3.org/TR/2dcontext/) 定义的大部分属性、方法。
- * - 通过 Canvas.getContext('webgl') 接口可以获取 WebGLRenderingContext 对象,实现了 [WebGL 1.0](https://www.khronos.org/registry/webgl/specs/latest/1.0/) 定义的所有属性、方法、常量。
- *
- * **2d 接口支持情况**
- *
- * iOS/Android 不支持的 2d 属性和接口
- *
- * - globalCompositeOperation 不支持以下值: source-in source-out destination-atop lighter copy。如果使用,不会报错,但是将得到与预期不符的结果。
- * - isPointInPath
- *
- * **WebGL 接口支持情况**
- *
- * 压缩纹理的支持
- * - iOS 支持 pvr 格式
- * - Android 支持 etc1 格式 */
- interface RenderingContext {}
- interface ReportUserBehaviorBranchAnalyticsOption {
- /** 分支ID,在「小程序管理后台」获取 */
- branchId: string
- /** 事件类型,1:曝光; 2:点击 */
- eventType: number
- /** 自定义维度,基础库 v2.14.0 开始支持可选 */
- branchDim?: string
- }
- interface RequestMidasFriendPaymentOption {
- /** 购买数量。mode=game 时必填。购买数量。详见 [buyQuantity 限制说明](#buyQuantity限制说明)。 */
- buyQuantity: number
- /** 币种
- *
- * 可选值:
- * - 'CNY': 人民币; */
- currencyType: 'CNY'
- /** 环境配置
- *
- * 可选值:
- * - 0: 米大师正式环境;
- * - 1: 米大师沙箱环境; */
- env: 0 | 1
- /** 支付的类型,不同的支付类型有各自额外要传的附加参数
- *
- * 可选值:
- * - 'game': 购买游戏币; */
- mode: 'game'
- /** 随机字符串,长度应小于 128 */
- nonceStr: string
- /** 在米大师侧申请的应用 id */
- offerId: string
- /** 开发者业务订单号,每个订单号只能使用一次,重复使用会失败。要求32个字符内,只能是数字、大小写字母、符号 `_-|*@` */
- outTradeNo: string
- /** 申请接入时的平台,platform 与应用id有关。
- *
- * 可选值:
- * - 'android': Android平台; */
- platform: 'android'
- /** 签名 */
- signature: string
- /** 生成这个随机字符串的 UNIX 时间戳(精确到秒) */
- timeStamp: number
- /** 分区 ID */
- zoneId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RequestMidasFriendPaymentCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RequestMidasFriendPaymentFailCallback
- /** 接口调用成功的回调函数 */
- success?: RequestMidasFriendPaymentSuccessCallback
- }
- interface RequestMidasFriendPaymentSuccessCallbackResult {
- /** 敏感数据对应的云 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) */
- cloudID: string
- /** 包括敏感数据在内的完整转发信息的加密数据,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- encryptedData: string
- /** 错误信息 */
- errMsg: string
- /** 加密算法的初始向量,详细见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html) */
- iv: string
- }
- interface RequestMidasPaymentOption {
- /** 币种
- *
- * 可选值:
- * - 'CNY': 人民币; */
- currencyType: 'CNY'
- /** 支付的类型,不同的支付类型有各自额外要传的附加参数。
- *
- * 可选值:
- * - 'game': 购买游戏币; */
- mode: 'game'
- /** 在米大师侧申请的应用 id */
- offerId: string
- /** 购买数量。mode=game 时必填。购买数量。详见 [buyQuantity 限制说明](#buyquantity-限制说明)。 */
- buyQuantity?: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RequestMidasPaymentCompleteCallback
- /** 环境配置
- *
- * 可选值:
- * - 0: 米大师正式环境;
- * - 1: 米大师沙箱环境; */
- env?: 0 | 1
- /** 接口调用失败的回调函数 */
- fail?: RequestMidasPaymentFailCallback
- /** 申请接入时的平台,platform 与应用id有关。
- *
- * 可选值:
- * - 'android': android; */
- platform?: 'android'
- /** 接口调用成功的回调函数 */
- success?: RequestMidasPaymentSuccessCallback
- /** 分区 ID */
- zoneId?: string
- }
- interface RequestOption<
- T extends string | IAnyObject | ArrayBuffer =
- | string
- | IAnyObject
- | ArrayBuffer
- > {
- /** 开发者服务器接口地址 */
- url: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RequestCompleteCallback
- /** 请求的参数 */
- data?: string | IAnyObject | ArrayBuffer
- /** 返回的数据格式
- *
- * 可选值:
- * - 'json': 返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse;
- * - '其他': 不对返回的内容进行 JSON.parse; */
- dataType?: 'json' | '其他'
- /** 需要基础库: `2.10.4`
- *
- * 开启 cache */
- enableCache?: boolean
- /** 需要基础库: `2.20.2`
- *
- * 开启 transfer-encoding chunked。 */
- enableChunked?: boolean
- /** 需要基础库: `2.10.4`
- *
- * 开启 http2 */
- enableHttp2?: boolean
- /** 需要基础库: `2.19.1`
- *
- * 是否开启 HttpDNS 服务。如开启,需要同时填入 httpDNSServiceId 。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html) */
- enableHttpDNS?: boolean
- /** 需要基础库: `2.10.4`
- *
- * 开启 quic */
- enableQuic?: boolean
- /** 接口调用失败的回调函数 */
- fail?: RequestFailCallback
- /** 设置请求的 header,header 中不能设置 Referer。
- *
- * `content-type` 默认为 `application/json` */
- header?: IAnyObject
- /** 需要基础库: `2.19.1`
- *
- * HttpDNS 服务商 Id。 HttpDNS 用法详见 [移动解析HttpDNS](https://developers.weixin.qq.com/miniprogram/dev/framework/ability/HTTPDNS.html) */
- httpDNSServiceId?: boolean
- /** HTTP 请求方法
- *
- * 可选值:
- * - 'OPTIONS': HTTP 请求 OPTIONS;
- * - 'GET': HTTP 请求 GET;
- * - 'HEAD': HTTP 请求 HEAD;
- * - 'POST': HTTP 请求 POST;
- * - 'PUT': HTTP 请求 PUT;
- * - 'DELETE': HTTP 请求 DELETE;
- * - 'TRACE': HTTP 请求 TRACE;
- * - 'CONNECT': HTTP 请求 CONNECT; */
- method?:
- | 'OPTIONS'
- | 'GET'
- | 'HEAD'
- | 'POST'
- | 'PUT'
- | 'DELETE'
- | 'TRACE'
- | 'CONNECT'
- /** 需要基础库: `1.7.0`
- *
- * 响应的数据类型
- *
- * 可选值:
- * - 'text': 响应的数据为文本;
- * - 'arraybuffer': 响应的数据为 ArrayBuffer; */
- responseType?: 'text' | 'arraybuffer'
- /** 接口调用成功的回调函数 */
- success?: RequestSuccessCallback<T>
- /** 需要基础库: `2.10.0`
- *
- * 超时时间,单位为毫秒 */
- timeout?: number
- }
- /** 需要基础库: `2.10.4`
- *
- * 网络请求过程中一些调试信息,[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html) */
- interface RequestProfile {
- /** SSL建立完成的时间,如果不是安全连接,则值为 0 */
- SSLconnectionEnd: number
- /** SSL建立连接的时间,如果不是安全连接,则值为 0 */
- SSLconnectionStart: number
- /** HTTP(TCP) 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过 */
- connectEnd: number
- /** HTTP(TCP) 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间 */
- connectStart: number
- /** DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
- domainLookupEnd: number
- /** DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
- domainLookupStart: number
- /** 评估当前网络下载的kbps */
- downstreamThroughputKbpsEstimate: number
- /** 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6 */
- estimate_nettype: number
- /** 组件准备好使用 HTTP 请求抓取资源的时间,这发生在检查本地缓存之前 */
- fetchStart: number
- /** 协议层根据多个请求评估当前网络的 rtt(仅供参考) */
- httpRttEstimate: number
- /** 当前请求的IP */
- peerIP: string
- /** 当前请求的端口 */
- port: number
- /** 使用协议类型,有效值:http1.1, h2, quic, unknown */
- protocol: string
- /** 收到字节数 */
- receivedBytedCount: number
- /** 最后一个 HTTP 重定向完成时的时间。有跳转且是同域名内部的重定向才算,否则值为 0 */
- redirectEnd: number
- /** 第一个 HTTP 重定向发生时的时间。有跳转且是同域名内的重定向才算,否则值为 0 */
- redirectStart: number
- /** HTTP请求读取真实文档结束的时间 */
- requestEnd: number
- /** HTTP请求读取真实文档开始的时间(完成建立连接),包括从本地读取缓存。连接错误重连时,这里显示的也是新建立连接的时间 */
- requestStart: number
- /** HTTP 响应全部接收完成的时间(获取到最后一个字节),包括从本地读取缓存 */
- responseEnd: number
- /** HTTP 开始接收响应的时间(获取到第一个字节),包括从本地读取缓存 */
- responseStart: number
- /** 当次请求连接过程中实时 rtt */
- rtt: number
- /** 发送的字节数 */
- sendBytesCount: number
- /** 是否复用连接 */
- socketReused: boolean
- /** 当前网络的实际下载kbps */
- throughputKbps: number
- /** 传输层根据多个请求评估的当前网络的 rtt(仅供参考) */
- transportRttEstimate: number
- }
- interface RequestSubscribeMessageFailCallbackResult {
- /** 接口调用失败错误码 */
- errCode: number
- /** 接口调用失败错误信息 */
- errMsg: string
- }
- interface RequestSubscribeMessageOption {
- /** 需要订阅的消息模板的id的集合,一次调用最多可订阅3条消息(注意:iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息,iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息)消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置。每个tmplId对应的模板标题需要不相同,否则会被过滤。 */
- tmplIds: any[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RequestSubscribeMessageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RequestSubscribeMessageFailCallback
- /** 接口调用成功的回调函数 */
- success?: RequestSubscribeMessageSuccessCallback
- }
- interface RequestSubscribeMessageSuccessCallbackResult {
- /** [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这条消息 */
- [TEMPLATE_ID: string]: string
- /** 接口调用成功时errMsg值为'requestSubscribeMessage:ok' */
- errMsg: string
- }
- interface RequestSubscribeSystemMessageOption {
- /** 系统订阅消息类型列表,一次调用最多可订阅3种类型的消息,目前支持两种类型,"SYS_MSG_TYPE_INTERACTIVE"(好友互动提醒)、"SYS_MSG_TYPE_RANK"(排行榜超越提醒) */
- msgTypeList: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RequestSubscribeSystemMessageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RequestSubscribeSystemMessageFailCallback
- /** 接口调用成功的回调函数 */
- success?: RequestSubscribeSystemMessageSuccessCallback
- }
- interface RequestSubscribeSystemMessageSuccessCallbackResult {
- /** [MSG_TYPE]是动态的键,即系统订阅消息类型,值为'accept'、'reject'、'ban','accept'表示用户同意订阅该类型对应的模板消息,'reject'表示用户拒绝订阅该类型对应的模板消息,'ban'表示已被后台封禁。例如 { errMsg: "requestSubscribeSystemMessage:ok", SYS_MSG_TYPE_INTERACTIVE: "accept" } 表示用户同意订阅'SYS_MSG_TYPE_INTERACTIVE'这条消息 */
- MSG_TYPE: string
- /** 接口调用成功时errMsg值为'requestSubscribeSystemMessage:ok' */
- errMsg: string
- }
- interface RequestSuccessCallbackResult<
- T extends string | IAnyObject | ArrayBuffer =
- | string
- | IAnyObject
- | ArrayBuffer
- > {
- /** 需要基础库: `2.10.0`
- *
- * 开发者服务器返回的 cookies,格式为字符串数组 */
- cookies: string[]
- /** 开发者服务器返回的数据 */
- data: T
- /** 需要基础库: `1.2.0`
- *
- * 开发者服务器返回的 HTTP Response Header */
- header: IAnyObject
- /** 需要基础库: `2.10.4`
- *
- * 网络请求过程中一些调试信息,[查看详细说明](https://developers.weixin.qq.com/miniprogram/dev/framework/performance/network.html) */
- profile: RequestProfile
- /** 开发者服务器返回的 HTTP 状态码 */
- statusCode: number
- errMsg: string
- }
- interface RequestTaskOnChunkReceivedCallbackResult {
- /** 开发者服务器每次返回新chunk时的Response */
- res: OnChunkReceivedCallbackResult
- }
- interface Res {
- /** 好友状态信息列表 */
- list: StateData[]
- }
- interface ReserveChannelsLiveOption {
- /** 预告 id,通过 getChannelsLiveNoticeInfo 接口获取 */
- noticeId: string
- }
- interface RestartOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RestartCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RestartFailCallback
- /** 接口调用成功的回调函数 */
- success?: RestartSuccessCallback
- }
- /** 当场景为由从另一个小程序或公众号或App打开时,返回此字段 */
- interface ResultReferrerInfo {
- /** 来源小程序或公众号或App的 appId */
- appId: string
- /** 来源小程序传过来的数据,scene=1037或1038时支持 */
- extraData: IAnyObject
- }
- interface RewardedVideoAdOnCloseCallbackResult {
- /** 需要基础库: `2.1.0`
- *
- * 视频是否是在用户完整观看的情况下被关闭的 */
- isEnded: boolean
- }
- interface RmdirFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory ${dirPath}': 目录不存在;
- * - 'fail directory not empty': 目录不为空;
- * - 'fail permission denied, open ${dirPath}': 指定的 dirPath 路径没有写权限;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface RmdirOption {
- /** 要删除的目录路径 (本地路径) */
- dirPath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: RmdirCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: RmdirFailCallback
- /** 需要基础库: `2.3.0`
- *
- * 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 */
- recursive?: boolean
- /** 接口调用成功的回调函数 */
- success?: RmdirSuccessCallback
- }
- interface RoomInfo {
- /** 小游戏 appId */
- appId: string
- /** 创建时间 */
- createTimestamp: number
- /** 游戏对局时长,单位 s */
- gameLastTime: number
- /** 游戏下发帧的时间间隔,单位 ms */
- gameTick: number
- /** 房间最多可容纳人数 */
- maxMemberNum: number
- /** 成员列表 */
- memberList: RoomMemberInfo[]
- /** 游戏自定义的关于房间的扩展信息 */
- roomExtInfo: string
- /** 房间 ID */
- roomIdStr: number
- /** 房间状态
- *
- * 可选值:
- * - 1: 组队中;
- * - 2: 该房间的对局游戏已开始;
- * - 3: 该房间的对局游戏已结束;
- * - 4: 房间已销毁;
- * - 5: 房间连接已建立,等待对战连接建立; */
- roomState: 1 | 2 | 3 | 4 | 5
- /** 游戏随机种子 */
- seed: string
- /** 需要满足百分比的玩家都发送了开始指令才能启动游戏。有效范围 0~100,0 表示只要有一个人调用开始就启动,100 表示要求所有人都开始才能启动。 */
- startPercent: number
- /** UDP可靠性策略, 0:全冗余 N:固定冗余N帧 */
- udpReliabilityStrategy: number
- /** 最近更新时间 */
- updateTimestamp: number
- }
- /** 成员列表 */
- interface RoomMemberInfo {
- /** 用户在房间内的唯一标识 */
- clientId: number
- /** 是否已做好游戏开始准备(调用过 startGame) */
- enableToStart: boolean
- /** 头像 URL(房间 needUserInfo 为 true 时才会有) */
- headimg: string
- /** 玩家准备状态 */
- isReady: boolean
- /** 游戏自定义的关于成员的扩展信息 */
- memberExtInfo: string
- /** 用户昵称(房间 needUserInfo 为 true 时才会有) */
- nickname: string
- /** 座位号,从 0 开始 */
- posNum: number
- /** 角色
- *
- * 可选值:
- * - 0: 普通成员;
- * - 1: 房主; */
- role: 0 | 1
- }
- /** 需要基础库: `2.7.0`
- *
- * 在竖屏正方向下的安全区域 */
- interface SafeArea {
- /** 安全区域右下角纵坐标 */
- bottom: number
- /** 安全区域的高度,单位逻辑像素 */
- height: number
- /** 安全区域左上角横坐标 */
- left: number
- /** 安全区域右下角横坐标 */
- right: number
- /** 安全区域左上角纵坐标 */
- top: number
- /** 安全区域的宽度,单位逻辑像素 */
- width: number
- }
- interface SaveFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail tempFilePath file not exist': 指定的 tempFilePath 找不到文件;
- * - 'fail permission denied, open "${filePath}"': 指定的 filePath 路径没有写权限;
- * - 'fail no such file or directory "${dirPath}"': 上级目录不存在;
- * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface SaveFileOption {
- /** 临时存储文件路径 (本地路径) */
- tempFilePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SaveFileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SaveFileFailCallback
- /** 要存储的文件路径 (本地路径) */
- filePath?: string
- /** 接口调用成功的回调函数 */
- success?: SaveFileSuccessCallback
- }
- interface SaveFileSuccessCallbackResult {
- /** 存储后的文件路径 (本地路径) */
- savedFilePath: string
- errMsg: string
- }
- interface SaveFileToDiskOption {
- /** 待保存文件路径 */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SaveFileToDiskCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SaveFileToDiskFailCallback
- /** 接口调用成功的回调函数 */
- success?: SaveFileToDiskSuccessCallback
- }
- interface SaveImageToPhotosAlbumOption {
- /** 图片文件路径,可以是临时文件路径或永久文件路径 (本地路径) ,不支持网络路径 */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SaveImageToPhotosAlbumCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SaveImageToPhotosAlbumFailCallback
- /** 接口调用成功的回调函数 */
- success?: SaveImageToPhotosAlbumSuccessCallback
- }
- interface ScanCodeOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ScanCodeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ScanCodeFailCallback
- /** 需要基础库: `1.2.0`
- *
- * 是否只能从相机扫码,不允许从相册选择图片 */
- onlyFromCamera?: boolean
- /** 需要基础库: `1.7.0`
- *
- * 扫码类型
- *
- * 可选值:
- * - 'barCode': 一维码;
- * - 'qrCode': 二维码;
- * - 'datamatrix': Data Matrix 码;
- * - 'pdf417': PDF417 条码; */
- scanType?: Array<'barCode' | 'qrCode' | 'datamatrix' | 'pdf417'>
- /** 接口调用成功的回调函数 */
- success?: ScanCodeSuccessCallback
- }
- interface ScanCodeSuccessCallbackResult {
- /** 所扫码的字符集 */
- charSet: string
- /** 当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path */
- path: string
- /** 原始数据,base64编码 */
- rawData: string
- /** 所扫码的内容 */
- result: string
- /** 所扫码的类型
- *
- * 可选值:
- * - 'QR_CODE': 二维码;
- * - 'AZTEC': 一维码;
- * - 'CODABAR': 一维码;
- * - 'CODE_39': 一维码;
- * - 'CODE_93': 一维码;
- * - 'CODE_128': 一维码;
- * - 'DATA_MATRIX': 二维码;
- * - 'EAN_8': 一维码;
- * - 'EAN_13': 一维码;
- * - 'ITF': 一维码;
- * - 'MAXICODE': 一维码;
- * - 'PDF_417': 二维码;
- * - 'RSS_14': 一维码;
- * - 'RSS_EXPANDED': 一维码;
- * - 'UPC_A': 一维码;
- * - 'UPC_E': 一维码;
- * - 'UPC_EAN_EXTENSION': 一维码;
- * - 'WX_CODE': 二维码;
- * - 'CODE_25': 一维码; */
- scanType:
- | 'QR_CODE'
- | 'AZTEC'
- | 'CODABAR'
- | 'CODE_39'
- | 'CODE_93'
- | 'CODE_128'
- | 'DATA_MATRIX'
- | 'EAN_8'
- | 'EAN_13'
- | 'ITF'
- | 'MAXICODE'
- | 'PDF_417'
- | 'RSS_14'
- | 'RSS_EXPANDED'
- | 'UPC_A'
- | 'UPC_E'
- | 'UPC_EAN_EXTENSION'
- | 'WX_CODE'
- | 'CODE_25'
- errMsg: string
- }
- interface SendSocketMessageOption {
- /** 需要发送的内容 */
- data: string | ArrayBuffer
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SendSocketMessageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SendSocketMessageFailCallback
- /** 接口调用成功的回调函数 */
- success?: SendSocketMessageSuccessCallback
- }
- interface SetBLEMTUFailCallbackResult {
- /** 最终协商的 MTU 值。如果协商失败则无此参数。安卓客户端 8.0.9 开始支持。 */
- mtu: number
- }
- interface SetBLEMTUOption {
- /** 蓝牙设备 id */
- deviceId: string
- /** 最大传输单元。设置范围为 (22,512) 区间内,单位 bytes */
- mtu: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetBLEMTUCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetBLEMTUFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetBLEMTUSuccessCallback
- }
- interface SetBLEMTUSuccessCallbackResult {
- /** 最终协商的 MTU 值,与传入参数一致。安卓客户端 8.0.9 开始支持。 */
- mtu: number
- errMsg: string
- }
- interface SetClipboardDataOption {
- /** 剪贴板的内容 */
- data: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetClipboardDataCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetClipboardDataFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetClipboardDataSuccessCallback
- }
- interface SetEnableDebugOption {
- /** 是否打开调试 */
- enableDebug: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetEnableDebugCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetEnableDebugFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetEnableDebugSuccessCallback
- }
- interface SetInnerAudioOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetInnerAudioOptionCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetInnerAudioOptionFailCallback
- /** 是否与其他音频混播,设置为 true 之后,不会终止其他应用或微信内的音乐 */
- mixWithOther?: boolean
- /** (仅在 iOS 生效)是否遵循静音开关,设置为 false 之后,即使是在静音模式下,也能播放声音 */
- obeyMuteSwitch?: boolean
- /** true 代表用扬声器播放,false 代表听筒播放,默认值为 true。 */
- speakerOn?: boolean
- /** 接口调用成功的回调函数 */
- success?: SetInnerAudioOptionSuccessCallback
- }
- interface SetKeepScreenOnOption {
- /** 是否保持屏幕常亮 */
- keepScreenOn: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetKeepScreenOnCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetKeepScreenOnFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetKeepScreenOnSuccessCallback
- }
- interface SetMenuStyleOption {
- /** 样式风格
- *
- * 可选值:
- * - 'light': 浅色;
- * - 'dark': 深色; */
- style: 'light' | 'dark'
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetMenuStyleCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetMenuStyleFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetMenuStyleSuccessCallback
- }
- interface SetMessageToFriendQueryOption {
- /** 需要传递的代表场景的数字,需要在 0 - 50 之间 */
- shareMessageToFriendScene: number
- }
- interface SetScreenBrightnessOption {
- /** 屏幕亮度值,范围 0 ~ 1。0 最暗,1 最亮 */
- value: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetScreenBrightnessCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetScreenBrightnessFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetScreenBrightnessSuccessCallback
- }
- interface SetStateOption {
- /** 该玩家的自定义状态信息,长度限制为 256 个字符 */
- userState: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetStateCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetStateFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetStateSuccessCallback
- }
- interface SetStatusBarStyleOption {
- /** 样式风格
- *
- * 可选值:
- * - 'white': 白色;
- * - 'black': 浅色; */
- style: 'white' | 'black'
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetStatusBarStyleCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetStatusBarStyleFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetStatusBarStyleSuccessCallback
- }
- interface SetStorageOption<T = any> {
- /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
- data: T
- /** 本地缓存中指定的 key */
- key: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetStorageCompleteCallback
- /** 需要基础库: `2.21.3`
- *
- * 是否开启加密存储。只有异步的 setStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 加密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true。此外,由于加密后的数据会比原始数据膨胀1.4倍,因此开启 encrypt 的情况下,单个 key 允许存储的最大数据长度为 0.7MB,所有数据存储上限为 7.1MB */
- encrypt?: boolean
- /** 接口调用失败的回调函数 */
- fail?: SetStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetStorageSuccessCallback
- }
- interface SetUserCloudStorageOption {
- /** 要修改的 KV 数据列表 */
- KVDataList: KVData[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetUserCloudStorageCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetUserCloudStorageFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetUserCloudStorageSuccessCallback
- }
- interface SetWindowSizeOption {
- /** 窗口高度,以像素为单位 */
- height: number
- /** 窗口宽度,以像素为单位 */
- width: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SetWindowSizeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SetWindowSizeFailCallback
- /** 接口调用成功的回调函数 */
- success?: SetWindowSizeSuccessCallback
- }
- /** 对局回放的分享参数。 */
- interface Share {
- /** 对局回放的剪辑区间,是一个二维数组,单位 ms(毫秒)。[[1000, 3000], [4000, 5000]] 表示剪辑已录制对局回放的 1-3 秒和 4-5 秒最终合成为一个 3 秒的对局回放。对局回放剪辑后的总时长最多 60 秒,即 1 分钟。 */
- timeRange: number[]
- /** 需要基础库: `2.9.2`
- *
- * 对局回放的播放速率,只能设置以下几个值:0.3,0.5,1,1.5,2,2.5,3。其中1表示原速播放,小于1表示减速播放,大于1表示加速播放。 */
- atempo?: number
- /** 需要基础库: `2.10.0`
- *
- * 如果原始视频文件中有音频,是否与新传入的bgm混音,默认为false,表示不混音,只保留一个音轨,值为true时表示原始音频与传入的bgm混音。 */
- audioMix?: boolean
- /** 对局回放背景音乐的地址。必须是一个代码包文件路径或者 wxfile:// 文件路径,不支持 http/https 开头的 url。 */
- bgm?: string
- /** 对局回放的按钮的配置。对局回放按钮的文案不能随意设置,只能选择预设的文案模版。 */
- button?: ButtonShare
- /** 需要基础库: `2.13.2`
- *
- * 分享的对局回放打开后跳转小游戏的 path (独立分包路径)。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
- path?: string
- /** 分享的对局回放打开后跳转小游戏的 query。 */
- query?: string
- /** 对局回放的标题的配置。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
- title?: TitleShare
- /** 需要基础库: `2.9.2`
- *
- * 对局回放的音量大小,最小 0,最大 1。 */
- volume?: number
- }
- interface ShareAppMessageOption {
- /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
- imageUrl?: string
- /** 需要基础库: `2.4.3`
- *
- * 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
- imageUrlId?: string
- /** 需要基础库: `2.12.2`
- *
- * 独立分包路径。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
- path?: string
- /** 查询字符串,从这条转发消息进入后,可通过 wx.getLaunchOptionsSync() 或 wx.onShow() 获取启动参数中的 query。必须是 key1=val1&key2=val2 的格式。 */
- query?: string
- /** 转发标题,不传则默认使用当前小游戏的昵称。 */
- title?: string
- /** 需要基础库: `2.12.2`
- *
- * 是否转发到当前群。该参数只对从群工具栏打开的场景下生效,默认转发到当前群,填入false时可转发到其他会话。 */
- toCurrentGroup?: boolean
- }
- interface ShareMessageToFriendOption {
- /** 发送对象的 openId */
- openId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShareMessageToFriendCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ShareMessageToFriendFailCallback
- /** 转发显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4 */
- imageUrl?: string
- /** 审核通过的图片 ID,详见 [使用审核通过的转发图片](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/share.html#使用审核通过的转发图片) */
- imageUrlId?: string
- /** 接口调用成功的回调函数 */
- success?: ShareMessageToFriendSuccessCallback
- /** 转发标题,不传则默认使用当前小游戏的昵称。 */
- title?: string
- }
- /** 对局回放的分享参数。 */
- interface ShareOption {
- /** 对局回放背景音乐的地址。必须是一个代码包文件路径或者 wxfile:// 文件路径,不支持 http/https 开头的 url。 */
- bgm: string
- /** 对局回放的剪辑区间,是一个二维数组,单位 ms(毫秒)。[[1000, 3000], [4000, 5000]] 表示剪辑已录制对局回放的 1-3 秒和 4-5 秒最终合成为一个 3 秒的对局回放。对局回放剪辑后的总时长最多 60 秒,即 1 分钟。 */
- timeRange: number[]
- /** 需要基础库: `2.9.2`
- *
- * 对局回放的播放速率,只能设置以下几个值:0.3,0.5,1,1.5,2,2.5,3。其中1表示原速播放,小于1表示减速播放,大于1表示加速播放。 */
- atempo?: number
- /** 需要基础库: `2.10.0`
- *
- * 如果原始视频文件中有音频,是否与新传入的bgm混音,默认为false,表示不混音,只保留一个音轨,值为true时表示原始音频与传入的bgm混音。 */
- audioMix?: boolean
- /** 对局回放的按钮。只能选择预设的文案模版。 */
- button?: ButtonShareOption
- /** 需要基础库: `2.13.2`
- *
- * 分享的对局回放打开后跳转小游戏的 path (独立分包路径)。详见 [小游戏独立分包指南](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/independent-sub-packages.html) */
- path?: string
- /** 分享的对局回放打开后跳转小游戏的 query。 */
- query?: string
- /** 对局回放的标题。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
- title?: TitleShareOption
- /** 需要基础库: `2.9.2`
- *
- * 对局回放的音量大小,最小 0,最大 1。 */
- volume?: number
- }
- interface ShowActionSheetOption {
- /** 按钮的文字数组,数组长度最大为 6 */
- itemList: string[]
- /** 需要基础库: `2.14.0`
- *
- * 警示文案 */
- alertText?: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowActionSheetCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ShowActionSheetFailCallback
- /** 按钮的文字颜色 */
- itemColor?: string
- /** 接口调用成功的回调函数 */
- success?: ShowActionSheetSuccessCallback
- }
- interface ShowActionSheetSuccessCallbackResult {
- /** 用户点击的按钮序号,从上到下的顺序,从0开始 */
- tapIndex: number
- errMsg: string
- }
- interface ShowKeyboardOption {
- /** 当点击完成时键盘是否收起 */
- confirmHold: boolean
- /** 键盘右下角 confirm 按钮的类型,只影响按钮的文本内容
- *
- * 可选值:
- * - 'done': 完成;
- * - 'next': 下一个;
- * - 'search': 搜索;
- * - 'go': 前往;
- * - 'send': 发送; */
- confirmType: 'done' | 'next' | 'search' | 'go' | 'send'
- /** 键盘输入框显示的默认值 */
- defaultValue: string
- /** 键盘中文本的最大长度 */
- maxLength: number
- /** 是否为多行输入 */
- multiple: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowKeyboardCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ShowKeyboardFailCallback
- /** 接口调用成功的回调函数 */
- success?: ShowKeyboardSuccessCallback
- }
- interface ShowLoadingOption {
- /** 提示的内容 */
- title: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowLoadingCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ShowLoadingFailCallback
- /** 是否显示透明蒙层,防止触摸穿透 */
- mask?: boolean
- /** 接口调用成功的回调函数 */
- success?: ShowLoadingSuccessCallback
- }
- interface ShowModalOption {
- /** 取消按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
- cancelColor?: string
- /** 取消按钮的文字,最多 4 个字符 */
- cancelText?: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowModalCompleteCallback
- /** 确认按钮的文字颜色,必须是 16 进制格式的颜色字符串 */
- confirmColor?: string
- /** 确认按钮的文字,最多 4 个字符 */
- confirmText?: string
- /** 提示的内容 */
- content?: string
- /** 需要基础库: `2.17.1`
- *
- * 是否显示输入框 */
- editable?: boolean
- /** 接口调用失败的回调函数 */
- fail?: ShowModalFailCallback
- /** 需要基础库: `2.17.1`
- *
- * 显示输入框时的提示文本 */
- placeholderText?: string
- /** 是否显示取消按钮 */
- showCancel?: boolean
- /** 接口调用成功的回调函数 */
- success?: ShowModalSuccessCallback
- /** 提示的标题 */
- title?: string
- }
- interface ShowModalSuccessCallbackResult {
- /** 需要基础库: `1.1.0`
- *
- * 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) */
- cancel: boolean
- /** 为 true 时,表示用户点击了确定按钮 */
- confirm: boolean
- /** editable 为 true 时,用户输入的文本 */
- content: string
- errMsg: string
- }
- interface ShowShareImageMenuOption {
- /** 要分享的图片地址,必须为本地路径或临时路径 */
- path: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowShareImageMenuCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ShowShareImageMenuFailCallback
- /** 接口调用成功的回调函数 */
- success?: ShowShareImageMenuSuccessCallback
- }
- interface ShowShareMenuOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowShareMenuCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: ShowShareMenuFailCallback
- /** 需要基础库: `2.11.3`
- *
- * 本接口为 Beta 版本,暂只在 Android 平台支持。需要显示的转发按钮名称列表,默认['shareAppMessage']。按钮名称合法值包含 "shareAppMessage"、"shareTimeline" 两种 */
- menus?: string[]
- /** 接口调用成功的回调函数 */
- success?: ShowShareMenuSuccessCallback
- /** 是否使用带 shareTicket 的转发[详情](#) */
- withShareTicket?: boolean
- }
- interface ShowToastOption {
- /** 提示的内容 */
- title: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ShowToastCompleteCallback
- /** 提示的延迟时间 */
- duration?: number
- /** 接口调用失败的回调函数 */
- fail?: ShowToastFailCallback
- /** 图标
- *
- * 可选值:
- * - 'success': 显示成功图标,此时 title 文本最多显示 7 个汉字长度;
- * - 'error': 显示失败图标,此时 title 文本最多显示 7 个汉字长度;
- * - 'loading': 显示加载图标,此时 title 文本最多显示 7 个汉字长度;
- * - 'none': 不显示图标,此时 title 文本最多可显示两行,[1.9.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html)及以上版本支持; */
- icon?: 'success' | 'error' | 'loading' | 'none'
- /** 需要基础库: `1.1.0`
- *
- * 自定义图标的本地路径,image 的优先级高于 icon */
- image?: string
- /** 是否显示透明蒙层,防止触摸穿透 */
- mask?: boolean
- /** 接口调用成功的回调函数 */
- success?: ShowToastSuccessCallback
- }
- /** 需要基础库: `2.10.4`
- *
- * 网络请求过程中一些调试信息 */
- interface SocketProfile {
- /** 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过 */
- connectEnd: number
- /** 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间 */
- connectStart: number
- /** 上层请求到返回的耗时 */
- cost: number
- /** DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
- domainLookupEnd: number
- /** DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 */
- domainLookupStart: number
- /** 组件准备好使用 SOCKET 建立请求的时间,这发生在检查本地缓存之前 */
- fetchStart: number
- /** 握手耗时 */
- handshakeCost: number
- /** 单次连接的耗时,包括 connect ,tls */
- rtt: number
- }
- interface SocketTaskCloseOption {
- /** 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 */
- code?: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: CloseCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SocketTaskCloseFailCallback
- /** 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。 */
- reason?: string
- /** 接口调用成功的回调函数 */
- success?: CloseSuccessCallback
- }
- interface SocketTaskOnCloseCallbackResult {
- /** 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 */
- code: number
- /** 一个可读的字符串,表示连接被关闭的原因。 */
- reason: string
- }
- interface SocketTaskOnMessageCallbackResult {
- /** 服务器返回的消息 */
- data: string | ArrayBuffer
- }
- interface SocketTaskSendOption {
- /** 需要发送的内容 */
- data: string | ArrayBuffer
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: SendCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: SendFailCallback
- /** 接口调用成功的回调函数 */
- success?: SendSuccessCallback
- }
- interface StartAccelerometerOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartAccelerometerCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartAccelerometerFailCallback
- /** 需要基础库: `2.1.0`
- *
- * 监听加速度数据回调函数的执行频率
- *
- * 可选值:
- * - 'game': 适用于更新游戏的回调频率,在 20ms/次 左右;
- * - 'ui': 适用于更新 UI 的回调频率,在 60ms/次 左右;
- * - 'normal': 普通的回调频率,在 200ms/次 左右; */
- interval?: 'game' | 'ui' | 'normal'
- /** 接口调用成功的回调函数 */
- success?: StartAccelerometerSuccessCallback
- }
- interface StartAdvertisingObject {
- /** 广播自定义参数 */
- advertiseRequest: AdvertiseReqObj
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartAdvertisingCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartAdvertisingFailCallback
- /** 广播功率
- *
- * 可选值:
- * - 'low': 功率低;
- * - 'medium': 功率适中;
- * - 'high': 功率高; */
- powerLevel?: 'low' | 'medium' | 'high'
- /** 接口调用成功的回调函数 */
- success?: StartAdvertisingSuccessCallback
- }
- interface StartBeaconDiscoveryOption {
- /** Beacon 设备广播的 UUID 列表 */
- uuids: string[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartBeaconDiscoveryCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartBeaconDiscoveryFailCallback
- /** 是否校验蓝牙开关,仅在 iOS 下有效。iOS 11 起,控制面板里关掉蓝牙,还是能继续使用 Beacon 服务。 */
- ignoreBluetoothAvailable?: boolean
- /** 接口调用成功的回调函数 */
- success?: StartBeaconDiscoverySuccessCallback
- }
- interface StartBluetoothDevicesDiscoveryOption {
- /** 是否允许重复上报同一设备。如果允许重复上报,则 [wx.onBlueToothDeviceFound](#) 方法会多次上报同一设备,但是 RSSI 值会有不同。 */
- allowDuplicatesKey?: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartBluetoothDevicesDiscoveryCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartBluetoothDevicesDiscoveryFailCallback
- /** 上报设备的间隔,单位 ms。0 表示找到新设备立即上报,其他数值根据传入的间隔上报。 */
- interval?: number
- /** 扫描模式,越高扫描越快,也越耗电。仅安卓微信客户端 7.0.12 及以上支持。
- *
- * 可选值:
- * - 'low': 低;
- * - 'medium': 中;
- * - 'high': 高; */
- powerLevel?: 'low' | 'medium' | 'high'
- /** 要搜索的蓝牙设备主服务的 UUID 列表(支持 16/32/128 位 UUID)。某些蓝牙设备会广播自己的主 service 的 UUID。如果设置此参数,则只搜索广播包有对应 UUID 的主服务的蓝牙设备。建议通过该参数过滤掉周边不需要处理的其他蓝牙设备。 */
- services?: string[]
- /** 接口调用成功的回调函数 */
- success?: StartBluetoothDevicesDiscoverySuccessCallback
- }
- interface StartCompassOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartCompassCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartCompassFailCallback
- /** 接口调用成功的回调函数 */
- success?: StartCompassSuccessCallback
- }
- interface StartDeviceMotionListeningOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartDeviceMotionListeningCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartDeviceMotionListeningFailCallback
- /** 监听设备方向的变化回调函数的执行频率
- *
- * 可选值:
- * - 'game': 适用于更新游戏的回调频率,在 20ms/次 左右;
- * - 'ui': 适用于更新 UI 的回调频率,在 60ms/次 左右;
- * - 'normal': 普通的回调频率,在 200ms/次 左右; */
- interval?: 'game' | 'ui' | 'normal'
- /** 接口调用成功的回调函数 */
- success?: StartDeviceMotionListeningSuccessCallback
- }
- interface StartGameOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartGameCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartGameFailCallback
- /** 接口调用成功的回调函数 */
- success?: StartGameSuccessCallback
- }
- interface StartGyroscopeOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartGyroscopeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartGyroscopeFailCallback
- /** 监听陀螺仪数据回调函数的执行频率
- *
- * 可选值:
- * - 'game': 适用于更新游戏的回调频率,在 20ms/次 左右;
- * - 'ui': 适用于更新 UI 的回调频率,在 60ms/次 左右;
- * - 'normal': 普通的回调频率,在 200ms/次 左右; */
- interval?: 'game' | 'ui' | 'normal'
- /** 接口调用成功的回调函数 */
- success?: StartGyroscopeSuccessCallback
- }
- interface StartHandoffOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartHandoffCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartHandoffFailCallback
- /** 接口调用成功的回调函数 */
- success?: StartHandoffSuccessCallback
- }
- interface StartMatchOption {
- /** 通过后台接口申请的matchId */
- matchId: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartMatchCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartMatchFailCallback
- /** 补充类型,0:自动补充队友 1:不补充队友 */
- fillType?: number
- /** 接口调用成功的回调函数 */
- success?: StartMatchSuccessCallback
- }
- interface StartStateServiceOption {
- /** 该玩家的自定义状态信息,长度限制为 256 个字符 */
- userState: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StartStateServiceCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StartStateServiceFailCallback
- /** 接口调用成功的回调函数 */
- success?: StartStateServiceSuccessCallback
- }
- interface StatFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;
- * - 'fail no such file or directory ${path}': 文件不存在;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface StatOption {
- /** 文件/目录路径 (本地路径) */
- path: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StatCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StatFailCallback
- /** 需要基础库: `2.3.0`
- *
- * 是否递归获取目录下的每个文件的 Stats 信息 */
- recursive?: boolean
- /** 接口调用成功的回调函数 */
- success?: StatSuccessCallback
- }
- interface StatSuccessCallbackResult {
- /** [Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)|Array.<[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)>
- *
- * 当 recursive 为 false 时,res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时,res.stats 是一个 Array,数组的每一项是一个对象,每个对象包含 path 和 stats。 */
- stats: Stats | Stats[]
- errMsg: string
- }
- /** 好友状态信息列表 */
- interface StateData {
- /** 好友头像 */
- avatarUrl: string
- /** 好友性别 0未设置 1男 2女 */
- gender: number
- /** 好友昵称 */
- nickName: string
- /** 好友 openId */
- openid: string
- /** 系统状态,0 掉线 1 在线 */
- sysState: number
- /** 该玩家的自定义状态信息,通过 `GameServerManager.setState` 接口设置 */
- userState: string
- }
- /** 描述文件状态的对象 */
- interface Stats {
- /** 文件最近一次被存取或被执行的时间,UNIX 时间戳,对应 POSIX stat.st_atime */
- lastAccessedTime: number
- /** 文件最后一次被修改的时间,UNIX 时间戳,对应 POSIX stat.st_mtime */
- lastModifiedTime: number
- /** 文件的类型和存取的权限,对应 POSIX stat.st_mode */
- mode: string
- /** 文件大小,单位:B,对应 POSIX stat.st_size */
- size: number
- }
- interface StopAccelerometerOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopAccelerometerCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopAccelerometerFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopAccelerometerSuccessCallback
- }
- interface StopAdvertisingOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopAdvertisingCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopAdvertisingFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopAdvertisingSuccessCallback
- }
- interface StopBeaconDiscoveryOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopBeaconDiscoveryCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopBeaconDiscoveryFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopBeaconDiscoverySuccessCallback
- }
- interface StopBluetoothDevicesDiscoveryOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopBluetoothDevicesDiscoveryCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopBluetoothDevicesDiscoveryFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopBluetoothDevicesDiscoverySuccessCallback
- }
- interface StopCompassOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopCompassCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopCompassFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopCompassSuccessCallback
- }
- interface StopDeviceMotionListeningOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopDeviceMotionListeningCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopDeviceMotionListeningFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopDeviceMotionListeningSuccessCallback
- }
- interface StopFaceDetectOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopFaceDetectCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopFaceDetectFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopFaceDetectSuccessCallback
- }
- interface StopGyroscopeOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: StopGyroscopeCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: StopGyroscopeFailCallback
- /** 接口调用成功的回调函数 */
- success?: StopGyroscopeSuccessCallback
- }
- /** 单个游戏icon的位置和样式信息 */
- interface StyleItem {
- /** 游戏名称是否隐藏 */
- appNameHidden: boolean
- /** 游戏icon的border颜色色值 */
- borderColor: string
- /** 游戏icon的border尺寸 */
- borderWidth: number
- /** 游戏名称的颜色色值 */
- color: string
- /** 游戏icon的X轴坐标 */
- left: number
- /** 游戏icon的宽高值 */
- size: number
- /** 游戏icon的Y轴坐标 */
- top: number
- }
- /** 订阅消息设置
- *
- * **示例代码**
- *
- * ```javascript
- wx.getSetting({
- withSubscriptions: true,
- success (res) {
- console.log(res.authSetting)
- // res.authSetting = {
- // "scope.userInfo": true,
- // "scope.userLocation": true
- // }
- console.log(res.subscriptionsSetting)
- // res.subscriptionsSetting = {
- // mainSwitch: true, // 订阅消息总开关
- // itemSettings: { // 每一项开关
- // SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息
- // SYS_MSG_TYPE_RANK: 'accept'
- // zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息
- // ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban',
- // }
- // }
- }
- })
- ``` */
- interface SubscriptionsSetting {
- /** 订阅消息总开关,true为开启,false为关闭 */
- mainSwitch: boolean
- /** 每一项订阅消息的订阅状态。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)
- * ## 注意事项
- * - itemSettings 只返回用户勾选过订阅面板中的“总是保持以上选择,不再询问”的订阅消息。 */
- itemSettings?: IAnyObject
- }
- interface SystemInfo {
- /** 需要基础库: `1.1.0`
- *
- * 客户端基础库版本 */
- SDKVersion: string
- /** 需要基础库: `2.6.0`
- *
- * 允许微信使用相册的开关(仅 iOS 有效) */
- albumAuthorized: boolean
- /** 需要基础库: `1.8.0`
- *
- * 设备性能等级(仅 Android)。取值为:-2 或 0(该设备无法运行小游戏),-1(性能未知),>=1(设备性能值,该值越高,设备性能越好,目前最高不到50) */
- benchmarkLevel: number
- /** 需要基础库: `2.6.0`
- *
- * 蓝牙的系统开关 */
- bluetoothEnabled: boolean
- /** 需要基础库: `1.5.0`
- *
- * 设备品牌 */
- brand: string
- /** 需要基础库: `2.6.0`
- *
- * 允许微信使用摄像头的开关 */
- cameraAuthorized: boolean
- /** 设备方向
- *
- * 可选值:
- * - 'portrait': 竖屏;
- * - 'landscape': 横屏; */
- deviceOrientation: 'portrait' | 'landscape'
- /** 需要基础库: `2.15.0`
- *
- * 是否已打开调试。可通过右上角菜单或 [wx.setEnableDebug](https://developers.weixin.qq.com/minigame/dev/api/base/debug/wx.setEnableDebug.html) 打开调试。 */
- enableDebug: boolean
- /** 需要基础库: `1.5.0`
- *
- * 用户字体大小(单位px)。以微信客户端「我-设置-通用-字体大小」中的设置为准 */
- fontSizeSetting: number
- /** 需要基础库: `2.12.3`
- *
- * 当前小程序运行的宿主环境 */
- host: Host
- /** 微信设置的语言 */
- language: string
- /** 需要基础库: `2.6.0`
- *
- * 允许微信使用定位的开关 */
- locationAuthorized: boolean
- /** 需要基础库: `2.6.0`
- *
- * 地理位置的系统开关 */
- locationEnabled: boolean
- /** `true` 表示模糊定位,`false` 表示精确定位,仅 iOS 支持 */
- locationReducedAccuracy: boolean
- /** 需要基础库: `2.6.0`
- *
- * 允许微信使用麦克风的开关 */
- microphoneAuthorized: boolean
- /** 设备型号。新机型刚推出一段时间会显示unknown,微信会尽快进行适配。 */
- model: string
- /** 需要基础库: `2.6.0`
- *
- * 允许微信通知带有提醒的开关(仅 iOS 有效) */
- notificationAlertAuthorized: boolean
- /** 需要基础库: `2.6.0`
- *
- * 允许微信通知的开关 */
- notificationAuthorized: boolean
- /** 需要基础库: `2.6.0`
- *
- * 允许微信通知带有标记的开关(仅 iOS 有效) */
- notificationBadgeAuthorized: boolean
- /** 需要基础库: `2.6.0`
- *
- * 允许微信通知带有声音的开关(仅 iOS 有效) */
- notificationSoundAuthorized: boolean
- /** 需要基础库: `2.19.3`
- *
- * 允许微信使用日历的开关 */
- phoneCalendarAuthorized: boolean
- /** 设备像素比 */
- pixelRatio: number
- /** 客户端平台 */
- platform: string
- /** 需要基础库: `2.7.0`
- *
- * 在竖屏正方向下的安全区域 */
- safeArea: SafeArea
- /** 需要基础库: `1.1.0`
- *
- * 屏幕高度,单位px */
- screenHeight: number
- /** 需要基础库: `1.1.0`
- *
- * 屏幕宽度,单位px */
- screenWidth: number
- /** 需要基础库: `1.9.0`
- *
- * 状态栏的高度,单位px */
- statusBarHeight: number
- /** 操作系统及版本 */
- system: string
- /** 微信版本号 */
- version: string
- /** 需要基础库: `2.6.0`
- *
- * Wi-Fi 的系统开关 */
- wifiEnabled: boolean
- /** 可使用窗口高度,单位px */
- windowHeight: number
- /** 可使用窗口宽度,单位px */
- windowWidth: number
- /** 需要基础库: `2.11.0`
- *
- * 系统当前主题,取值为`light`或`dark`,全局配置`"darkmode":true`时才能获取,否则为 undefined (不支持小游戏)
- *
- * 可选值:
- * - 'dark': 深色主题;
- * - 'light': 浅色主题; */
- theme?: 'dark' | 'light'
- }
- /** 对局回放的标题的配置。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
- interface TitleShare {
- /** 对局回放的标题的模版参数。 */
- data?: IAnyObject
- /** 对局回放的标题的模版。不传则为:${用户昵称} 在 ${游戏名称} 的游戏时刻
- *
- * 可选值:
- * - 'default.score': 模版格式为,《小游戏名称》,本局得分:${score},对应的 data 应该如 { score: 4500 };
- * - 'default.level': 模版格式为,《小游戏名称》,当前关卡:第42关,对应的 data 应该如 { level: 23 };
- * - 'default.opponent': 模版格式为,《小游戏名称》,本局对手:${opponent},对应的 data 应该如 { opponent_openid: 'oC6J75Sh1_4K8Mf5b1mlgDkMPhoI' };
- * - 'default.cost': 模版格式为,《小游戏名称》,本局耗时:${cost}秒,对应的 data 应该如 { cost_seconds: 123 }; */
- template?:
- | 'default.score'
- | 'default.level'
- | 'default.opponent'
- | 'default.cost'
- }
- /** 对局回放的标题。对局回放标题不能随意设置,只能选择预设的文案模版和对应的参数。 */
- interface TitleShareOption {
- /** 对局回放的标题的模版参数。 */
- data?: IAnyObject
- /** 对局回放的标题的模版。不传则为:${用户昵称} 在 ${游戏名称} 的游戏时刻
- *
- * 可选值:
- * - 'default.score': 模版格式为,${游戏名称},本局得分:${score},对应的 data 应该如 { score: 4500 };
- * - 'default.level': 模版格式为,${游戏名称},当前关卡:第42关,对应的 data 应该如 { level: 23 };
- * - 'default.opponent': 模版格式为,${游戏名称},本局对手:${opponent},对应的 data 应该如 { opponent_openid: 'oC6J75Sh1_4K8Mf5b1mlgDkMPhoI' };
- * - 'default.cost': 模版格式为,${游戏名称},本局耗时:${cost}秒,对应的 data 应该如 { cost_seconds: 123 }; */
- template?:
- | 'default.score'
- | 'default.level'
- | 'default.opponent'
- | 'default.cost'
- }
- interface ToTempFilePathOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: ToTempFilePathCompleteCallback
- /** 目标文件的高度,会将截取的部分拉伸或压缩至该数值 */
- destHeight?: number
- /** 目标文件的宽度,会将截取的部分拉伸或压缩至该数值 */
- destWidth?: number
- /** 接口调用失败的回调函数 */
- fail?: ToTempFilePathFailCallback
- /** 目标文件的类型
- *
- * 可选值:
- * - 'jpg': jpg 文件;
- * - 'png': png 文件; */
- fileType?: 'jpg' | 'png'
- /** 截取 canvas 的高度 */
- height?: number
- /** jpg图片的质量,仅当 fileType 为 jpg 时有效。取值范围为 0.0(最低)- 1.0(最高),不含 0。不在范围内时当作 1.0 */
- quality?: number
- /** 接口调用成功的回调函数 */
- success?: ToTempFilePathSuccessCallback
- /** 截取 canvas 的宽度 */
- width?: number
- /** 截取 canvas 的左上角横坐标 */
- x?: number
- /** 截取 canvas 的左上角纵坐标 */
- y?: number
- }
- interface ToTempFilePathSuccessCallbackResult {
- /** canvas 生成的临时文件路径 (本地路径) */
- tempFilePath: string
- errMsg: string
- }
- interface ToTempFilePathSyncOption {
- /** 目标文件的高度,会将截取的部分拉伸或压缩至该数值 */
- destHeight?: number
- /** 目标文件的宽度,会将截取的部分拉伸或压缩至该数值 */
- destWidth?: number
- /** 目标文件的类型
- *
- * 可选值:
- * - 'jpg': jpg 文件;
- * - 'png': png 文件; */
- fileType?: 'jpg' | 'png'
- /** 截取 canvas 的高度 */
- height?: number
- /** jpg图片的质量,仅当 fileType 为 jpg 时有效。取值范围为 0.0(最低)- 1.0(最高),不含 0。不在范围内时当作 1.0 */
- quality?: number
- /** 截取 canvas 的宽度 */
- width?: number
- /** 截取 canvas 的左上角横坐标 */
- x?: number
- /** 截取 canvas 的左上角纵坐标 */
- y?: number
- }
- /** 在触控设备上的触摸点。通常是指手指或者触控笔在触屏设备或者触摸板上的操作。 */
- interface Touch {
- /** 触点相对于可见视区左边沿的 X 坐标。 */
- clientX: number
- /** 触点相对于可见视区上边沿的 Y 坐标。 */
- clientY: number
- /** 手指挤压触摸平面的压力大小, 从0.0(没有压力)到1.0(最大压力)的浮点数(仅在支持 force touch 的设备返回) */
- force: number
- /** Touch 对象的唯一标识符,只读属性。一次触摸动作(我们值的是手指的触摸)在平面上移动的整个过程中, 该标识符不变。可以根据它来判断跟踪的是否是同一次触摸过程。 */
- identifier: number
- /** 触点相对于页面左边沿的 X 坐标。 */
- pageX: number
- /** 触点相对于页面上边沿的 Y 坐标。 */
- pageY: number
- }
- interface TruncateFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
- * - 'fail illegal operation on a directory, open "${filePath}"': 指定的 filePath 是一个已经存在的目录;
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
- * - 'fail sdcard not mounted': android sdcard 挂载失败; */
- errMsg: string
- }
- interface TruncateOption {
- /** 要截断的文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: TruncateCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: TruncateFailCallback
- /** 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
- length?: number
- /** 接口调用成功的回调函数 */
- success?: TruncateSuccessCallback
- }
- interface TruncateSyncOption {
- /** 要截断的文件路径 (本地路径) */
- filePath: string
- /** 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0') */
- length?: number
- }
- interface UDPSocketOnMessageCallbackResult {
- /** 接收端地址信息,2.18.0 起支持 */
- localInfo: LocalInfo
- /** 收到的消息 */
- message: ArrayBuffer
- /** 发送端地址信息 */
- remoteInfo: RemoteInfo
- }
- interface UDPSocketSendOption {
- /** 要发消息的地址。在基础库 <= 2.9.3 版本必须是和本机同网段的 IP 地址,或安全域名列表内的域名地址;之后版本可以是任意 IP 和域名 */
- address: string
- /** 要发送的数据 */
- message: string | ArrayBuffer
- /** 要发送消息的端口号 */
- port: number
- /** 发送数据的长度,仅当 message 为 ArrayBuffer 类型时有效 */
- length?: number
- /** 发送数据的偏移量,仅当 message 为 ArrayBuffer 类型时有效 */
- offset?: number
- }
- interface UnlinkFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail permission denied, open ${path}': 指定的 path 路径没有读权限;
- * - 'fail no such file or directory ${path}': 文件不存在;
- * - 'fail operation not permitted, unlink ${filePath}': 传入的 filePath 是一个目录;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface UnlinkOption {
- /** 要删除的文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UnlinkCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UnlinkFailCallback
- /** 接口调用成功的回调函数 */
- success?: UnlinkSuccessCallback
- }
- interface UnzipFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail permission denied, unzip ${zipFilePath} -> ${destPath}': 指定目标文件路径没有写权限;
- * - 'fail no such file or directory, unzip ${zipFilePath} -> "${destPath}': 源文件不存在,或目标文件路径的上层目录不存在; */
- errMsg: string
- }
- interface UnzipOption {
- /** 目标目录路径, 支持本地路径 */
- targetPath: string
- /** 源文件路径,支持本地路径, 只可以是 zip 压缩文件 */
- zipFilePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UnzipCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UnzipFailCallback
- /** 接口调用成功的回调函数 */
- success?: UnzipSuccessCallback
- }
- /** 参数列表 */
- interface UpdatableMessageFrontEndParameter {
- /** 参数名 */
- name: string
- /** 参数值 */
- value: string
- }
- /** 需要基础库: `2.4.0`
- *
- * 动态消息的模板信息 */
- interface UpdatableMessageFrontEndTemplateInfo {
- /** 参数列表 */
- parameterList: UpdatableMessageFrontEndParameter[]
- }
- interface UpdateKeyboardOption {
- /** 键盘输入框的当前值 */
- value: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UpdateKeyboardCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UpdateKeyboardFailCallback
- /** 接口调用成功的回调函数 */
- success?: UpdateKeyboardSuccessCallback
- }
- interface UpdateReadyStatusOption {
- /** 游戏房间访问凭证 */
- accessInfo: string
- /** 是否准备完成 */
- isReady: boolean
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UpdateReadyStatusCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UpdateReadyStatusFailCallback
- /** 接口调用成功的回调函数 */
- success?: UpdateReadyStatusSuccessCallback
- }
- interface UpdateShareMenuOption {
- /** 需要基础库: `2.4.0`
- *
- * 动态消息的 activityId。通过 [updatableMessage.createActivityId](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/updatable-message/updatableMessage.createActivityId.html) 接口获取 */
- activityId?: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UpdateShareMenuCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UpdateShareMenuFailCallback
- /** 需要基础库: `2.13.0`
- *
- * 是否是私密消息。详见 [小程序私密消息](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/private-message.html) */
- isPrivateMessage?: boolean
- /** 需要基础库: `2.4.0`
- *
- * 是否是动态消息,详见[动态消息](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/updatable-message.html) */
- isUpdatableMessage?: boolean
- /** 接口调用成功的回调函数 */
- success?: UpdateShareMenuSuccessCallback
- /** 需要基础库: `2.4.0`
- *
- * 动态消息的模板信息 */
- templateInfo?: UpdatableMessageFrontEndTemplateInfo
- /** 需要基础库: `2.11.0`
- *
- * 群待办消息的id,通过toDoActivityId可以把多个群待办消息聚合为同一个。通过 [updatableMessage.createActivityId](https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/updatable-message/updatableMessage.createActivityId.html) 接口获取。详见[群待办消息](#) */
- toDoActivityId?: string
- /** 是否使用带 shareTicket 的转发[详情](#) */
- withShareTicket?: boolean
- }
- interface UpdateVoIPChatMuteConfigOption {
- /** 静音设置 */
- muteConfig: MuteConfig
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UpdateVoIPChatMuteConfigCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UpdateVoIPChatMuteConfigFailCallback
- /** 接口调用成功的回调函数 */
- success?: UpdateVoIPChatMuteConfigSuccessCallback
- }
- interface UpdateWeChatAppOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UpdateWeChatAppCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UpdateWeChatAppFailCallback
- /** 接口调用成功的回调函数 */
- success?: UpdateWeChatAppSuccessCallback
- }
- interface UploadFileOption {
- /** 要上传文件资源的路径 (本地路径) */
- filePath: string
- /** 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 */
- name: string
- /** 开发者服务器地址 */
- url: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UploadFileCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UploadFileFailCallback
- /** HTTP 请求中其他额外的 form data */
- formData?: IAnyObject
- /** HTTP 请求 Header,Header 中不能设置 Referer */
- header?: IAnyObject
- /** 接口调用成功的回调函数 */
- success?: UploadFileSuccessCallback
- /** 需要基础库: `2.10.0`
- *
- * 超时时间,单位为毫秒 */
- timeout?: number
- }
- interface UploadFileSuccessCallbackResult {
- /** 开发者服务器返回的数据 */
- data: string
- /** 开发者服务器返回的 HTTP 状态码 */
- statusCode: number
- errMsg: string
- }
- interface UploadFrameOption {
- /** 指令数组,每一项的类型必须与配置项 `lockStepOption.dataType` 一致 */
- actionList: string[] | ArrayBuffer[]
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: UploadFrameCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: UploadFrameFailCallback
- /** 接口调用成功的回调函数 */
- success?: UploadFrameSuccessCallback
- }
- interface UploadTaskOnProgressUpdateCallbackResult {
- /** 上传进度百分比 */
- progress: number
- /** 预期需要上传的数据总长度,单位 Bytes */
- totalBytesExpectedToSend: number
- /** 已经上传的数据长度,单位 Bytes */
- totalBytesSent: number
- }
- /** 托管数据 */
- interface UserGameData {
- /** 用户的托管 KV 数据列表 */
- KVDataList: KVData[]
- /** 用户的微信头像 url */
- avatarUrl: string
- /** 用户的微信昵称 */
- nickname: string
- /** 用户的 openid */
- openid: string
- }
- /** 用户信息 */
- interface UserInfo {
- /** 用户头像图片的 URL。URL 最后一个数值代表正方形头像大小(有 0、46、64、96、132 数值可选,0 代表 640x640 的正方形头像,46 表示 46x46 的正方形头像,剩余数值以此类推。默认132),用户没有头像时该项为空。若用户更换头像,原有头像 URL 将失效。 */
- avatarUrl: string
- /** 用户所在城市。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
- city: string
- /** 用户所在国家。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
- country: string
- /** 用户性别。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801)
- *
- * 可选值:
- * - 0: 未知;
- * - 1: 男性;
- * - 2: 女性; */
- gender: 0 | 1 | 2
- /** 显示 country,province,city 所用的语言。强制返回 “zh_CN”,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801)
- *
- * 可选值:
- * - 'en': 英文;
- * - 'zh_CN': 简体中文;
- * - 'zh_TW': 繁体中文; */
- language: 'en' | 'zh_CN' | 'zh_TW'
- /** 用户昵称 */
- nickName: string
- /** 用户所在省份。不再返回,参考 [相关公告](https://developers.weixin.qq.com/community/develop/doc/00028edbe3c58081e7cc834705b801) */
- province: string
- }
- /** 用户信息按钮 */
- interface UserInfoButton {
- /** 按钮的样式 */
- style: OptionStyle
- /** 按钮的类型。
- *
- * 可选值:
- * - 'text': 可以设置背景色和文本的按钮;
- * - 'image': 只能设置背景贴图的按钮,背景贴图会直接拉伸到按钮的宽高; */
- type: 'text' | 'image'
- /** 按钮的背景图片,仅当 type 为 `image` 时有效 */
- image?: string
- /** 按钮上的文本,仅当 type 为 `text` 时有效 */
- text?: string
- }
- interface VibrateLongOption {
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: VibrateLongCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: VibrateLongFailCallback
- /** 接口调用成功的回调函数 */
- success?: VibrateLongSuccessCallback
- }
- interface VibrateShortOption {
- /** 需要基础库: `2.13.0`
- *
- * 震动强度类型,有效值为:heavy、medium、light */
- type: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: VibrateShortCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: VibrateShortFailCallback
- /** 接口调用成功的回调函数 */
- success?: VibrateShortSuccessCallback
- }
- /** 视频对象 */
- interface Video {
- /** 视频是否自动播放 */
- autoplay: boolean
- /** 需要基础库: `2.12.0`
- *
- * 视频背景颜色 */
- backgroundColor: string
- /** 视频是否显示控件 */
- controls: boolean
- /** 是否启用手势控制播放进度 */
- enablePlayGesture: boolean
- /** 是否启用手势控制播放进度 */
- enableProgressGesture: boolean
- /** 视频的高度 */
- height: number
- /** 视频的初始播放位置,单位为 s 秒 */
- initialTime: number
- /** 视频是否为直播 */
- live: boolean
- /** 视频是否是否循环播放 */
- loop: boolean
- /** 视频是否禁音播放 */
- muted: boolean
- /** 需要基础库: `2.4.0`
- *
- * 视频是否遵从系统静音开关设置(仅iOS) */
- obeyMuteSwitch: boolean
- /** 视频的缩放模式 */
- objectFit: string
- /** 视频播放到末尾时触发的回调函数 */
- onended: (...args: any[]) => any
- /** 视频发生错误时触发的回调函数 */
- onerror: (...args: any[]) => any
- /** 视频暂停时触发的回调函数 */
- onpause: (...args: any[]) => any
- /** 视频开始播放时触发的回调函数 */
- onplay: (...args: any[]) => any
- /** 视频下载(缓冲)时周期性触发的回调函数 */
- onprogress: (...args: any[]) => any
- /** 每当视频播放进度更新时触发的回调函数 */
- ontimeupdate: (...args: any[]) => any
- /** 视频由于需要缓冲下一帧而停止时触发的回调函数 */
- onwaiting: (...args: any[]) => any
- /** 视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5 */
- playbackRate: number
- /** 视频的封面 */
- poster: string
- /** 是否显示视频中央的播放按钮 */
- showCenterPlayBtn: boolean
- /** 需要基础库: `2.12.0`
- *
- * 是否显示视频底部进度条 */
- showProgress: boolean
- /** 需要基础库: `2.12.0`
- *
- * 是否显示视频控制栏进度条 */
- showProgressInControlMode: boolean
- /** 视频的资源地址 */
- src: string
- /** 视频的宽度 */
- width: number
- /** 视频的左上角横坐标 */
- x: number
- /** 视频的左上角纵坐标 */
- y: number
- }
- interface VideoDecoderStartOption {
- /** 需要解码的视频源文件。基础库 2.13.0 以下的版本只支持本地路径。 2.13.0 开始支持 http:// 和 https:// 协议的远程路径。 */
- source: string
- /** 需要基础库: `2.15.0`
- *
- * 是否不需要音频轨道 */
- abortAudio?: boolean
- /** 需要基础库: `2.15.0`
- *
- * 是否不需要视频轨道 */
- abortVideo?: boolean
- /** 解码模式。0:按 pts 解码;1:以最快速度解码 */
- mode?: number
- }
- interface VideoOnErrorCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'MEDIA_ERR_NETWORK': 当下载时发生错误;
- * - 'MEDIA_ERR_DECODE': 当解码时发生错误;
- * - 'MEDIA_ERR_SRC_NOT_SUPPORTED': video 的 src 属性是不支持的资源类型; */
- errMsg: string
- }
- /** 需要基础库: `2.19.0`
- *
- * WebAudioContext 实例,通过[wx.createWebAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.createWebAudioContext.html) 接口获取该实例。
- *
- * **示例代码**
- *
- * ```js
- // 监听状态
- const audioCtx = wx.createWebAudioContext()
- audioCtx.onstatechange = () => {
- console.log(ctx.state)
- }
- setTimeout(audioCtx.suspend, 1000)
- setTimeout(audioCtx.resume, 2000)
- ``` */
- interface WebAudioContext {
- /** 获取当前上下文的时间戳。 */
- currentTime: number
- /** [WebAudioContextNode](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContextNode.html)
- *
- * 当前上下文的最终目标节点,一般是音频渲染设备。 */
- destination: WebAudioContextNode
- /** 空间音频监听器。 */
- listener: AudioListener
- /** 可写属性,开发者可以对该属性设置一个监听函数,当WebAudio状态改变的时候,会触发开发者设置的监听函数。 */
- onstatechange: (...args: any[]) => any
- /** 采样率,通常在8000-96000之间,通常44100hz的采样率最为常见。 */
- sampleRate: number
- /** 当前WebAudio上下文的状态。可能的值如下:suspended(暂停)、running(正在运行)、closed(已关闭)。需要注意的是,不要在 audioContext close后再访问state属性 */
- state: string
- }
- /** 需要基础库: `2.19.0`
- *
- * 一类音频处理模块,不同的Node具备不同的功能,如GainNode(音量调整)等。一个WebAudioContextNode可以通过上下文来创建。
- * 目前已经支持以下Node:
- * IIRFilterNode
- * WaveShaperNode
- * ConstantSourceNode
- * ChannelMergerNode
- * OscillatorNode
- * GainNode
- * BiquadFilterNode
- * PeriodicWaveNode
- * BufferSourceNode
- * ChannelSplitterNode
- * ChannelMergerNode
- * DelayNode
- * DynamicsCompressorNode
- * ScriptProcessorNode
- * PannerNode */
- interface WebAudioContextNode {
- /** 表示监听器的前向系统在同一笛卡尔坐标系中的水平位置,作为位置(位置x,位置和位置和位置)值。 */
- forwardX: number
- /** 表示听众的前向方向在同一笛卡尔坐标系中作为位置(位置x,位置和位置和位置)值的垂直位置。 */
- forwardY: number
- /** 表示与position (positionX、positionY和positionZ)值在同一笛卡尔坐标系下的听者前进方向的纵向(前后)位置。 */
- forwardZ: number
- /** 右手笛卡尔坐标系中X轴的位置。 */
- positionX: number
- /** 右手笛卡尔坐标系中Y轴的位置。 */
- positionY: number
- /** 右手笛卡尔坐标系中Z轴的位置。 */
- positionZ: number
- /** 设置监听器的方向 */
- setOrientation: (...args: any[]) => any
- /** 设置监听器的位置
- *
- * /** */
- setPosition: (...args: any[]) => any
- /** 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向前方向的水平位置。 */
- upX: number
- /** 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向上方向的水平位置。 */
- upY: number
- /** 表示在与position (positionX、positionY和positionZ)值相同的笛卡尔坐标系中侦听器向后方向的水平位置。 */
- upZ: number
- }
- /** Worker 实例,主线程中可通过 [wx.createWorker](https://developers.weixin.qq.com/minigame/dev/api/worker/wx.createWorker.html) 接口获取,worker 线程中可通过全局变量 `worker` 获取。
- *
- * **示例代码**
- *
- * 运行以下代码需先进行基础配置,详细请查阅 [小程序多线程](https://developers.weixin.qq.com/miniprogram/dev/framework/workers.html) | [小游戏多线程](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/worker.html) 文档了解基础知识和配置方法。
- *
- * ```js
- const worker = wx.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径,绝对路径
- worker.onMessage(function (res) {
- console.log(res)
- })
- // 监听worker被系统回收事件
- worker.onProcessKilled(function () {
- console.log('worker has been killed')
- // 重新创建一个worker
- // wx.createWorker()
- })
- worker.postMessage({
- msg: 'hello worker'
- })
- worker.terminate()
- ``` */
- interface Worker {
- /** worker内的环境变量 */
- env: WorkerEnv
- }
- /** worker内的环境变量 */
- interface WorkerEnv {
- /** 文件系统中的用户目录路径 (本地路径) */
- USER_DATA_PATH: string
- }
- interface WorkerOnMessageCallbackResult {
- /** 主线程/Worker 线程向当前线程发送的消息 */
- message: IAnyObject
- }
- interface WriteBLECharacteristicValueOption {
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 蓝牙设备 id */
- deviceId: string
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- /** 蓝牙设备特征对应的二进制值 */
- value: ArrayBuffer
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: WriteBLECharacteristicValueCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: WriteBLECharacteristicValueFailCallback
- /** 接口调用成功的回调函数 */
- success?: WriteBLECharacteristicValueSuccessCallback
- }
- interface WriteCharacteristicValueObject {
- /** 蓝牙特征的 UUID */
- characteristicId: string
- /** 是否需要通知主机 value 已更新 */
- needNotify: boolean
- /** 蓝牙特征对应服务的 UUID */
- serviceId: string
- /** characteristic 对应的二进制值 */
- value: ArrayBuffer
- /** 可选,处理回包时使用 */
- callbackId?: number
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: WriteCharacteristicValueCompleteCallback
- /** 接口调用失败的回调函数 */
- fail?: WriteCharacteristicValueFailCallback
- /** 接口调用成功的回调函数 */
- success?: WriteCharacteristicValueSuccessCallback
- }
- interface WriteFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'bad file descriptor': 无效的文件描述符;
- * - 'fail permission denied': 指定的 fd 路径没有写权限;
- * - 'fail sdcard not mounted': android sdcard 挂载失败; */
- errMsg: string
- }
- interface WriteFileFailCallbackResult {
- /** 错误信息
- *
- * 可选值:
- * - 'fail no such file or directory, open ${filePath}': 指定的 filePath 所在目录不存在;
- * - 'fail permission denied, open ${dirPath}': 指定的 filePath 路径没有写权限;
- * - 'fail the maximum size of the file storage limit is exceeded': 存储空间不足;
- * - 'fail sdcard not mounted': Android sdcard 挂载失败; */
- errMsg: string
- }
- interface WriteFileOption {
- /** 要写入的文本或二进制数据 */
- data: string | ArrayBuffer
- /** 要写入的文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: WriteFileCompleteCallback
- /** 指定写入文件的字符编码
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 接口调用失败的回调函数 */
- fail?: WriteFileFailCallback
- /** 接口调用成功的回调函数 */
- success?: WriteFileSuccessCallback
- }
- interface WriteOption {
- /** 写入的内容,类型为 String 或 ArrayBuffer */
- data: string | ArrayBuffer
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: WriteCompleteCallback
- /** 只在 data 类型是 String 时有效,指定写入文件的字符编码,默认为 utf8
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 接口调用失败的回调函数 */
- fail?: WriteFailCallback
- /** 只在 data 类型是 ArrayBuffer 时有效,指定要写入的字节数,默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 */
- length?: number
- /** 只在 data 类型是 ArrayBuffer 时有效,决定 arrayBuffe 中要被写入的部位,即 arrayBuffer 中的索引,默认0 */
- offset?: number
- /** 指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。 */
- position?: number
- /** 接口调用成功的回调函数 */
- success?: WriteSuccessCallback
- }
- /** 文件写入结果。 通过 [FileSystemManager.writeSync](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeSync.html) 接口返回 */
- interface WriteResult {
- /** 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同) */
- bytesWritten: number
- }
- interface WriteSuccessCallbackResult {
- /** 实际被写入到文件中的字节数(注意,被写入的字节数不一定与被写入的字符串字符数相同) */
- bytesWritten: number
- errMsg: string
- }
- interface WriteSyncOption {
- /** 写入的内容,类型为 String 或 ArrayBuffer */
- data: string | ArrayBuffer
- /** 文件描述符。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) 接口获得 */
- fd: string
- /** 只在 data 类型是 String 时有效,指定写入文件的字符编码,默认为 utf8
- *
- * 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- /** 只在 data 类型是 ArrayBuffer 时有效,指定要写入的字节数,默认为 arrayBuffer 从0开始偏移 offset 个字节后剩余的字节数 */
- length?: number
- /** 只在 data 类型是 ArrayBuffer 时有效,决定 arrayBuffe 中要被写入的部位,即 arrayBuffer 中的索引,默认0 */
- offset?: number
- /** 指定文件开头的偏移量,即数据要被写入的位置。当 position 不传或者传入非 Number 类型的值时,数据会被写入当前指针所在位置。 */
- position?: number
- }
- interface WxGetFileInfoOption {
- /** 本地文件路径 (本地路径) */
- filePath: string
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- complete?: GetFileInfoCompleteCallback
- /** 计算文件摘要的算法
- *
- * 可选值:
- * - 'md5': md5 算法;
- * - 'sha1': sha1 算法; */
- digestAlgorithm?: 'md5' | 'sha1'
- /** 接口调用失败的回调函数 */
- fail?: WxGetFileInfoFailCallback
- /** 接口调用成功的回调函数 */
- success?: WxGetFileInfoSuccessCallback
- }
- interface WxGetFileInfoSuccessCallbackResult {
- /** 按照传入的 digestAlgorithm 计算得出的的文件摘要 */
- digest: string
- /** 文件大小,以字节为单位 */
- size: number
- errMsg: string
- }
- interface WxOnErrorCallbackResult {
- /** 错误 */
- message: string
- /** 错误调用堆栈 */
- stack: string
- }
- /** 文件路径 */
- interface ZipFileItem {
- /** 文件内容 */
- data: string | ArrayBuffer
- /** 错误信息 */
- errMsg: string
- }
- interface AudioBuffer {
- /** [AudioBuffer.copyFromChannel()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.copyFromChannel.html)
- *
- * 从AudioBuffer的指定频道复制到数组终端。 */
- copyFromChannel(): void
- /** [AudioBuffer.copyToChannel(Float32Array source, number channelNumber, number startInChannel)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.copyToChannel.html)
- *
- * 从指定数组复制样本到audioBuffer的特定通道
- *
- * **示例代码**
- *
- * 示例代码参考AudioBuffer.copyFromChannel */
- copyToChannel(
- /** 需要复制的源数组 */
- source: Float32Array,
- /** 需要复制到的目的通道号 */
- channelNumber: number,
- /** 复制偏移数据量 */
- startInChannel: number
- ): void
- /** [Float32Array AudioBuffer.getChannelData(number channel)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/AudioBuffer.getChannelData.html)
- *
- * 返回一个 Float32Array,包含了带有频道的PCM数据,由频道参数定义(有0代表第一个频道) */
- getChannelData(
- /** 要获取特定通道数据的索引 */
- channel: number
- ): Float32Array
- }
- interface BLEPeripheralServer {
- /** [BLEPeripheralServer.addService(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.addService.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 添加服务。 */
- addService(option: AddServiceOption): void
- /** [BLEPeripheralServer.offCharacteristicReadRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicReadRequest.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 取消监听已连接的设备请求读当前外围设备的特征值事件 */
- offCharacteristicReadRequest(
- /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
- callback?: OffCharacteristicReadRequestCallback
- ): void
- /** [BLEPeripheralServer.offCharacteristicSubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicSubscribed.html)
- *
- * 需要基础库: `2.13.0`
- *
- * 取消监听特征订阅事件 */
- offCharacteristicSubscribed(
- /** 特征订阅事件的回调函数 */
- callback?: OffCharacteristicSubscribedCallback
- ): void
- /** [BLEPeripheralServer.offCharacteristicUnsubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicUnsubscribed.html)
- *
- * 需要基础库: `2.13.0`
- *
- * 取消监听取消特征订阅事件 */
- offCharacteristicUnsubscribed(
- /** 取消特征订阅事件的回调函数 */
- callback?: OffCharacteristicUnsubscribedCallback
- ): void
- /** [BLEPeripheralServer.offCharacteristicWriteRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.offCharacteristicWriteRequest.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 取消监听已连接的设备请求写当前外围设备的特征值事件 */
- offCharacteristicWriteRequest(
- /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
- callback?: OffCharacteristicWriteRequestCallback
- ): void
- /** [BLEPeripheralServer.onCharacteristicReadRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicReadRequest.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 监听已连接的设备请求读当前外围设备的特征值事件。收到该消息后需要立刻调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 写回数据,否则主机不会收到响应。 */
- onCharacteristicReadRequest(
- /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
- callback: OnCharacteristicReadRequestCallback
- ): void
- /** [BLEPeripheralServer.onCharacteristicSubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicSubscribed.html)
- *
- * 需要基础库: `2.13.0`
- *
- * 监听特征订阅事件,仅 iOS 支持。 */
- onCharacteristicSubscribed(
- /** 特征订阅事件的回调函数 */
- callback: OnCharacteristicSubscribedCallback
- ): void
- /** [BLEPeripheralServer.onCharacteristicUnsubscribed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicUnsubscribed.html)
- *
- * 需要基础库: `2.13.0`
- *
- * 监听取消特征订阅事件,仅 iOS 支持。 */
- onCharacteristicUnsubscribed(
- /** 取消特征订阅事件的回调函数 */
- callback: OnCharacteristicUnsubscribedCallback
- ): void
- /** [BLEPeripheralServer.onCharacteristicWriteRequest(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.onCharacteristicWriteRequest.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 监听已连接的设备请求写当前外围设备的特征值事件。收到该消息后需要立刻调用 [writeCharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html) 写回数据,否则主机不会收到响应。 */
- onCharacteristicWriteRequest(
- /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
- callback: OnCharacteristicWriteRequestCallback
- ): void
- /** [BLEPeripheralServer.removeService(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.removeService.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 移除服务。 */
- removeService(option: RemoveServiceOption): void
- /** [BLEPeripheralServer.startAdvertising(Object Object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.startAdvertising.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 开始广播本地创建的外围设备。
- *
- * **注意**
- *
- * - Android 8.0.9 开始,支持直接使用 16/32/128 位 UUID;
- * - Android 8.0.9 以下版本只支持 128 位 UUID,使用 16/32 位的 UUID 时需要进行补位(系统会自动识别是否属于预分配区间),可以参考[蓝牙指南](#);
- * - iOS 必须直接使用 16 位的 UUID,不能补位到 128 位,否则系统组包时仍会按照 128 位传输。iOS 暂不支持 32 位 UUID。
- * - iOS 同时只能发起一个广播,安卓支持同时发起多个广播。
- * - 传 beacon 参数时,不能同时传入 deviceName,serviceUuids,manufacturerData 参数。 */
- startAdvertising(Object: StartAdvertisingObject): void
- /** [BLEPeripheralServer.stopAdvertising(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.stopAdvertising.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 停止广播。 */
- stopAdvertising(option?: StopAdvertisingOption): void
- /** [BLEPeripheralServer.writeCharacteristicValue(Object Object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/BLEPeripheralServer.writeCharacteristicValue.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 往指定特征写入二进制数据值,并通知已连接的主机,从机的特征值已发生变化,该接口会处理是走回包还是走订阅。 */
- writeCharacteristicValue(Object: WriteCharacteristicValueObject): void
- }
- interface BannerAd {
- /** [BannerAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.destroy.html)
- *
- * 销毁 banner 广告。 */
- destroy(): void
- /** [BannerAd.hide()](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.hide.html)
- *
- * 隐藏 banner 广告。 */
- hide(): void
- /** [BannerAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.offError.html)
- *
- * 取消监听 banner 广告错误事件 */
- offError(
- /** banner 广告错误事件的回调函数 */
- callback?: BannerAdOffErrorCallback
- ): void
- /** [BannerAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.offLoad.html)
- *
- * 取消监听 banner 广告加载事件 */
- offLoad(
- /** banner 广告加载事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [BannerAd.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.offResize.html)
- *
- * 取消监听 banner 广告尺寸变化事件 */
- offResize(
- /** banner 广告尺寸变化事件的回调函数 */
- callback?: BannerAdOffResizeCallback
- ): void
- /** [BannerAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.onError.html)
- *
- * 监听 banner 广告错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
- * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
- * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
- * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
- * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
- * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
- onError(
- /** banner 广告错误事件的回调函数 */
- callback: BannerAdOnErrorCallback
- ): void
- /** [BannerAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.onLoad.html)
- *
- * 监听 banner 广告加载事件。 */
- onLoad(
- /** banner 广告加载事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [BannerAd.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.onResize.html)
- *
- * 监听 banner 广告尺寸变化事件。 */
- onResize(
- /** banner 广告尺寸变化事件的回调函数 */
- callback: BannerAdOnResizeCallback
- ): void
- /** [Promise BannerAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/BannerAd.show.html)
- *
- * 显示 banner 广告。 */
- show(): Promise<any>
- }
- interface BeaconError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 0 | ok | 正常 |
- * | 11000 | unsupport | 系统或设备不支持 |
- * | 11001 | bluetooth service unavailable | 蓝牙服务不可用 |
- * | 11002 | location service unavailable | 位置服务不可用 |
- * | 11003 | already start | 已经开始搜索 |
- * | 11004 | not startBeaconDiscovery | 还未开始搜索 |
- * | 11005 | system error | 系统错误 |
- * | 11006 | invalid data | 参数不正确 | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 0 | ok | 正常 |
- * | 11000 | unsupport | 系统或设备不支持 |
- * | 11001 | bluetooth service unavailable | 蓝牙服务不可用 |
- * | 11002 | location service unavailable | 位置服务不可用 |
- * | 11003 | already start | 已经开始搜索 |
- * | 11004 | not startBeaconDiscovery | 还未开始搜索 |
- * | 11005 | system error | 系统错误 |
- * | 11006 | invalid data | 参数不正确 | */ errCode: number
- }
- interface BluetoothError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 0 | ok | 正常 |
- * | -1 | already connect | 已连接 |
- * | 10000 | not init | 未初始化蓝牙适配器 |
- * | 10001 | not available | 当前蓝牙适配器不可用 |
- * | 10002 | no device | 没有找到指定设备 |
- * | 10003 | connection fail | 连接失败 |
- * | 10004 | no service | 没有找到指定服务 |
- * | 10005 | no characteristic | 没有找到指定特征 |
- * | 10006 | no connection | 当前连接已断开 |
- * | 10007 | property not support | 当前特征不支持此操作 |
- * | 10008 | system error | 其余所有系统上报的异常 |
- * | 10009 | system not support | Android 系统特有,系统版本低于 4.3 不支持 BLE |
- * | 10012 | operate time out | 连接超时 |
- * | 10013 | invalid_data | 连接 deviceId 为空或者是格式不正确 | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 0 | ok | 正常 |
- * | -1 | already connect | 已连接 |
- * | 10000 | not init | 未初始化蓝牙适配器 |
- * | 10001 | not available | 当前蓝牙适配器不可用 |
- * | 10002 | no device | 没有找到指定设备 |
- * | 10003 | connection fail | 连接失败 |
- * | 10004 | no service | 没有找到指定服务 |
- * | 10005 | no characteristic | 没有找到指定特征 |
- * | 10006 | no connection | 当前连接已断开 |
- * | 10007 | property not support | 当前特征不支持此操作 |
- * | 10008 | system error | 其余所有系统上报的异常 |
- * | 10009 | system not support | Android 系统特有,系统版本低于 4.3 不支持 BLE |
- * | 10012 | operate time out | 连接超时 |
- * | 10013 | invalid_data | 连接 deviceId 为空或者是格式不正确 | */ errCode: number
- }
- interface Camera {
- /** [Camera.closeFrameChange()](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.closeFrameChange.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 关闭监听帧数据 */
- closeFrameChange(): void
- /** [Camera.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.destroy.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 销毁相机 */
- destroy(): void
- /** [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)
- *
- * 需要基础库: `2.9.0`
- *
- * 开启监听帧数据 */
- listenFrameChange(
- /** [Worker](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.html)
- *
- * 在 iOS ExperimentalWorker 内监听摄像头帧数据。详情 [Worker.getCameraFrameData](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.getCameraFrameData.html) */
- worker?: Worker
- ): void
- /** [Camera.onAuthCancel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.onAuthCancel.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 监听用户不允许授权使用摄像头的情况 */
- onAuthCancel(
- /** 事件发生时的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [Camera.onCameraFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.onCameraFrame.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 监听摄像头实时帧数据 */
- onCameraFrame(
- /** 摄像头返回实时帧数据的回调函数 */
- callback: OnCameraFrameCallback
- ): void
- /** [Camera.onStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.onStop.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 监听摄像头非正常终止事件,如退出后台等情况 */
- onStop(
- /** 事件发生时的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [Promise Camera.startRecord()](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.startRecord.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 开始录像 */
- startRecord(): Promise<any>
- /** [Promise Camera.stopRecord(boolean compressed)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.stopRecord.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 结束录像,成功则返回封面与视频 */
- stopRecord(
- /** 是否压缩录制视频 */
- compressed?: boolean
- ): Promise<any>
- /** [Promise Camera.takePhoto(string quality)](https://developers.weixin.qq.com/minigame/dev/api/media/camera/Camera.takePhoto.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 拍照,可指定质量,成功则返回图片 */
- takePhoto(
- /** 拍照质量,值为 high, normal, low */
- quality?: string
- ): Promise<any>
- }
- interface Canvas {
- /** [Canvas.toTempFilePath(Object object)](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toTempFilePath.html)
- *
- * 将当前 Canvas 保存为一个临时文件。**如果使用了开放数据域,则生成后的文件仅能被用于以下接口:`wx.saveImageToPhotosAlbum`、`wx.shareAppMessage`、`wx.onShareAppMessage`** */
- toTempFilePath(option: ToTempFilePathOption): void
- /** [[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)
- *
- * 获取画布对象的绘图上下文 */
- getContext(
- /** 上下文类型
- *
- * 参数 contextType 可选值:
- * - '2d': 2d 绘图上下文;
- * - 'webgl': webgl 绘图上下文; */
- contextType: '2d' | 'webgl',
- /** webgl 上下文属性,仅当 contextType 为 webgl 时有效 */
- contextAttributes?: ContextAttributes
- ): any
- /** [string Canvas.toDataURL()](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toDataURL.html)
- *
- * 把画布上的绘制内容以一个 data URI 的格式返回 */
- toDataURL(): string
- /** [string Canvas.toTempFilePathSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toTempFilePathSync.html)
- *
- * [Canvas.toTempFilePath](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.toTempFilePath.html) 的同步版本 */
- toTempFilePathSync(option: ToTempFilePathSyncOption): string
- }
- interface CloseSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 | */ errCode: number
- }
- interface Console {
- /** [console.debug()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.debug.html)
- *
- * 向调试面板中打印 debug 日志 */
- debug(
- /** 日志内容,可以有任意多个。 */
- ...args: any[]
- ): void
- /** [console.error()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.error.html)
- *
- * 向调试面板中打印 error 日志 */
- error(
- /** 日志内容,可以有任意多个。 */
- ...args: any[]
- ): void
- /** [console.group(string label)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.group.html)
- *
- * 在调试面板中创建一个新的分组。随后输出的内容都会被添加一个缩进,表示该内容属于当前分组。调用 [console.groupEnd](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.groupEnd.html)之后分组结束。
- *
- * **注意**
- *
- * 仅在工具中有效,在 vConsole 中为空函数实现。 */
- group(
- /** 分组标记,可选。 */
- label?: string
- ): void
- /** [console.groupEnd()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.groupEnd.html)
- *
- * 结束由 [console.group](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.group.html) 创建的分组
- *
- * **注意**
- *
- * 仅在工具中有效,在 vConsole 中为空函数实现。 */
- groupEnd(): void
- /** [console.info()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.info.html)
- *
- * 向调试面板中打印 info 日志 */
- info(
- /** 日志内容,可以有任意多个。 */
- ...args: any[]
- ): void
- /** [console.log()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.log.html)
- *
- * 向调试面板中打印 log 日志 */
- log(
- /** 日志内容,可以有任意多个。 */
- ...args: any[]
- ): void
- /** [console.warn()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/console.warn.html)
- *
- * 向调试面板中打印 warn 日志 */
- warn(
- /** 日志内容,可以有任意多个。 */
- ...args: any[]
- ): void
- }
- interface CustomAd {
- /** [CustomAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.destroy.html)
- *
- * 销毁原生模板广告。 */
- destroy(): void
- /** [CustomAd.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offClose.html)
- *
- * 取消监听原生模板广告关闭事件 */
- offClose(
- /** 原生模板广告关闭事件的回调函数 */
- callback?: UDPSocketOffCloseCallback
- ): void
- /** [CustomAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offError.html)
- *
- * 取消监听原生模板广告错误事件 */
- offError(
- /** 原生模板广告错误事件的回调函数 */
- callback?: CustomAdOffErrorCallback
- ): void
- /** [CustomAd.offHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offHide.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 取消监听原生模板广告隐藏事件 */
- offHide(
- /** 原生模板广告隐藏事件的回调函数 */
- callback?: OffHideCallback
- ): void
- /** [CustomAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.offLoad.html)
- *
- * 取消监听原生模板广告加载事件 */
- offLoad(
- /** 原生模板广告加载事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [CustomAd.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onClose.html)
- *
- * 监听原生模板广告关闭事件。 */
- onClose(
- /** 原生模板广告关闭事件的回调函数 */
- callback: UDPSocketOnCloseCallback
- ): void
- /** [CustomAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onError.html)
- *
- * 监听原生模板广告错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
- * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
- * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
- * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
- * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
- * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。|
- * | 2001 | 模板渲染错误 | 渲染过程出现错误 | |
- * | 2002 | 模板为空 | 该广告位的广告能力已经被关闭 | |
- * | 2003 | 模板解析失败 | 该广告位的广告能力已经被关闭 | |
- * | 2004 | 触发频率限制 | 小程序启动一定时间内不允许展示原生模板广告 | |
- * | 2005 | 触发频率限制 | 距离小程序插屏广告或者激励视频广告上次播放时间间隔不足,不允许展示原生模板广告 | | */
- onError(
- /** 原生模板广告错误事件的回调函数 */
- callback: CustomAdOnErrorCallback
- ): void
- /** [CustomAd.onHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onHide.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 监听原生模板广告隐藏事件, 某些模板如矩阵格子模板用户点击关闭时也会触发该事件。 */
- onHide(
- /** 原生模板广告隐藏事件的回调函数 */
- callback: OnHideCallback
- ): void
- /** [CustomAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.onLoad.html)
- *
- * 监听原生模板广告加载事件。 */
- onLoad(
- /** 原生模板广告加载事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [Promise CustomAd.hide()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.hide.html)
- *
- * 隐藏原生模板广告。(某些模板广告无法隐藏) */
- hide(): Promise<any>
- /** [Promise CustomAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.show.html)
- *
- * 显示原生模板广告。 */
- show(): Promise<any>
- /** [boolean CustomAd.isShow()](https://developers.weixin.qq.com/minigame/dev/api/ad/CustomAd.isShow.html)
- *
- * 查询原生模板广告展示状态。 */
- isShow(): boolean
- }
- interface DownloadTask {
- /** [DownloadTask.abort()](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.abort.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 中断下载任务 */
- abort(): void
- /** [DownloadTask.offHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.offHeadersReceived.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 取消监听 HTTP Response Header 事件 */
- offHeadersReceived(
- /** HTTP Response Header 事件的回调函数 */
- callback?: OffHeadersReceivedCallback
- ): void
- /** [DownloadTask.offProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.offProgressUpdate.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 取消监听下载进度变化事件 */
- offProgressUpdate(
- /** 下载进度变化事件的回调函数 */
- callback?: DownloadTaskOffProgressUpdateCallback
- ): void
- /** [DownloadTask.onHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.onHeadersReceived.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 监听 HTTP Response Header 事件。会比请求完成事件更早 */
- onHeadersReceived(
- /** HTTP Response Header 事件的回调函数 */
- callback: OnHeadersReceivedCallback
- ): void
- /** [DownloadTask.onProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/download/DownloadTask.onProgressUpdate.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 监听下载进度变化事件 */
- onProgressUpdate(
- /** 下载进度变化事件的回调函数 */
- callback: DownloadTaskOnProgressUpdateCallback
- ): void
- }
- interface FeedbackButton {
- /** [FeedbackButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.destroy.html)
- *
- * 销毁意见反馈按钮 */
- destroy(): void
- /** [FeedbackButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.hide.html)
- *
- * 隐藏意见反馈按钮。 */
- hide(): void
- /** [FeedbackButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.offTap.html)
- *
- * 取消监听意见反馈按钮的点击事件 */
- offTap(
- /** 意见反馈按钮的点击事件的回调函数 */
- callback?: GameClubButtonOffTapCallback
- ): void
- /** [FeedbackButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.onTap.html)
- *
- * 监听意见反馈按钮的点击事件 */
- onTap(
- /** 意见反馈按钮的点击事件的回调函数 */
- callback: GameClubButtonOnTapCallback
- ): void
- /** [FeedbackButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/FeedbackButton.show.html)
- *
- * 显示意见反馈按钮 */
- show(): void
- }
- interface FileSystemManager {
- /** [Array.<string> FileSystemManager.readdirSync(string dirPath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readdirSync.html)
- *
- * [FileSystemManager.readdir](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readdir.html) 的同步版本
- *
- * **注意事项</title>
- * - readdir接口无法访问文件系统根路径(wxfile://)。
- * <title>示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.readdir({
- dirPath: `${wx.env.USER_DATA_PATH}/example`,
- success(res) {
- console.log(res.files)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.readdirSync(`${wx.env.USER_DATA_PATH}/example`)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- readdirSync(
- /** 要读取的目录路径 (本地路径) */
- dirPath: string
- ): string[]
- /** [ArrayBuffer FileSystemManager.readCompressedFileSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readCompressedFileSync.html)
- *
- * 需要基础库: `2.21.1`
- *
- * 同步读取指定压缩类型的本地文件内容
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 异步接口
- fs.readCompressedFile({
- filePath: '${wx.env.USER_DATA_PATH}/hello.br',
- compressionAlgorithm: 'br',
- success(res) {
- console.log(res.data)
- },
- fail(res) {
- console.log('readCompressedFile fail', res)
- }
- })
- // 同步接口
- try {
- const data = fs.readCompressedFileSync({
- filePath: '${wx.env.USER_DATA_PATH}/hello.br',
- compressionAlgorithm: 'br',
- })
- console.log(data)
- } catch (err) {
- console.log(err)
- }
- ``` */
- readCompressedFileSync(
- option: ReadCompressedFileSyncOption
- ): ArrayBuffer
- /** [FileSystemManager.access(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.access.html)
- *
- * 判断文件/目录是否存在
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 判断文件/目录是否存在
- fs.access({
- path: `${wx.env.USER_DATA_PATH}/hello.txt`,
- success(res) {
- // 文件存在
- console.log(res)
- },
- fail(res) {
- // 文件不存在或其他错误
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.accessSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
- } catch(e) {
- console.error(e)
- }
- ``` */
- access(option: AccessOption): void
- /** [FileSystemManager.accessSync(string path)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.accessSync.html)
- *
- * [FileSystemManager.access](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.access.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 判断文件/目录是否存在
- fs.access({
- path: `${wx.env.USER_DATA_PATH}/hello.txt`,
- success(res) {
- // 文件存在
- console.log(res)
- },
- fail(res) {
- // 文件不存在或其他错误
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.accessSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
- } catch(e) {
- console.error(e)
- }
- ``` */
- accessSync(
- /** 要判断是否存在的文件/目录路径 (本地路径) */
- path: string
- ): void
- /** [FileSystemManager.appendFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.appendFile.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 在文件结尾追加内容
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.appendFile({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- data: 'some text',
- encoding: 'utf8',
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.appendFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'some text', 'utf8')
- } catch(e) {
- console.error(e)
- }
- ``` */
- appendFile(option: AppendFileOption): void
- /** [FileSystemManager.appendFileSync(string filePath, string|ArrayBuffer data, string encoding)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.appendFileSync.html)
- *
- * 需要基础库: `2.1.0`
- *
- * [FileSystemManager.appendFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.appendFile.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.appendFile({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- data: 'some text',
- encoding: 'utf8',
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.appendFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'some text', 'utf8')
- } catch(e) {
- console.error(e)
- }
- ``` */
- appendFileSync(
- /** 要追加内容的文件路径 (本地路径) */
- filePath: string,
- /** 要追加的文本或二进制数据 */
- data: string | ArrayBuffer,
- /** 指定写入文件的字符编码
- *
- * 参数 encoding 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- ): void
- /** [FileSystemManager.close(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.close.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 关闭文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 打开文件
- fs.open({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+',
- success(res) {
- // 关闭文件
- fs.close({
- fd: res.fd
- })
- }
- })
- ``` */
- close(option: FileSystemManagerCloseOption): void
- /** [FileSystemManager.copyFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.copyFile.html)
- *
- * 复制文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.copyFile({
- srcPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- destPath: `${wx.env.USER_DATA_PATH}/hello_copy.txt`
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.copyFileSync(
- `${wx.env.USER_DATA_PATH}/hello.txt`,
- `${wx.env.USER_DATA_PATH}/hello_copy.txt`
- )
- } catch(e) {
- console.error(e)
- }
- ``` */
- copyFile(option: CopyFileOption): void
- /** [FileSystemManager.copyFileSync(string srcPath, string destPath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.copyFileSync.html)
- *
- * [FileSystemManager.copyFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.copyFile.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.copyFile({
- srcPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- destPath: `${wx.env.USER_DATA_PATH}/hello_copy.txt`
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.copyFileSync(
- `${wx.env.USER_DATA_PATH}/hello.txt`,
- `${wx.env.USER_DATA_PATH}/hello_copy.txt`
- )
- } catch(e) {
- console.error(e)
- }
- ``` */
- copyFileSync(
- /** 源文件路径,支持本地路径 */
- srcPath: string,
- /** 目标文件路径,支持本地路径 */
- destPath: string
- ): void
- /** [FileSystemManager.fstat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.fstat.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 获取文件的状态信息
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 打开文件
- fs.open({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+',
- success(res) {
- // 获取文件的状态信息
- fs.fstat({
- fd: res.fd,
- success(res) {
- console.log(res.stats)
- }
- })
- }
- })
- ``` */
- fstat(option: FstatOption): void
- /** [FileSystemManager.ftruncate(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.ftruncate.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 对文件内容进行截断操作
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 打开文件
- fs.open({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+',
- success(res) {
- // 对文件内容进行截断操作
- fs.ftruncate({
- fd: res.fd,
- length: 10, // 从第10个字节开始截断文件
- success(res) {
- console.log(res)
- }
- })
- }
- })
- ``` */
- ftruncate(option: FtruncateOption): void
- /** [FileSystemManager.getFileInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.getFileInfo.html)
- *
- * 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 */
- getFileInfo(option: FileSystemManagerGetFileInfoOption): void
- /** [FileSystemManager.getSavedFileList(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.getSavedFileList.html)
- *
- * 获取该小程序下已保存的本地缓存文件列表 */
- getSavedFileList(option?: GetSavedFileListOption): void
- /** [FileSystemManager.mkdir(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.mkdir.html)
- *
- * 创建目录
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.mkdir({
- dirPath: `${wx.env.USER_DATA_PATH}/example`,
- recursive: false
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.mkdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
- } catch(e) {
- console.error(e)
- }
- ``` */
- mkdir(option: MkdirOption): void
- /** [FileSystemManager.mkdirSync(string dirPath, boolean recursive)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.mkdirSync.html)
- *
- * [FileSystemManager.mkdir](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.mkdir.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.mkdir({
- dirPath: `${wx.env.USER_DATA_PATH}/example`,
- recursive: false
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- fs.mkdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
- } catch(e) {
- console.error(e)
- }
- ``` */
- mkdirSync(
- /** 创建的目录路径 (本地路径) */
- dirPath: string,
- /** 需要基础库: `2.3.0`
- *
- * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 */
- recursive?: boolean
- ): void
- /** [FileSystemManager.open(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.open.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 打开文件,返回文件描述符
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.open({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+',
- success(res) {
- console.log(res.fd)
- }
- })
- ``` */
- open(option: OpenOption): void
- /** [FileSystemManager.read(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.read.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 读文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const ab = new ArrayBuffer(1024)
- // 打开文件
- fs.open({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+',
- success(res) {
- // 读取文件到 ArrayBuffer 中
- fs.read({
- fd: res.fd,
- arrayBuffer: ab,
- length: 10,
- success(res) {
- console.log(res)
- }
- })
- }
- })
- ``` */
- read(option: ReadOption): void
- /** [FileSystemManager.readCompressedFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readCompressedFile.html)
- *
- * 需要基础库: `2.21.1`
- *
- * 读取指定压缩类型的本地文件内容
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 异步接口
- fs.readCompressedFile({
- filePath: '${wx.env.USER_DATA_PATH}/hello.br',
- compressionAlgorithm: 'br',
- success(res) {
- console.log(res.data)
- },
- fail(res) {
- console.log('readCompressedFile fail', res)
- }
- })
- // 同步接口
- const data = fs.readCompressedFileSync({
- filePath: '${wx.env.USER_DATA_PATH}/hello.br',
- compressionAlgorithm: 'br',
- })
- console.log(data)
- ``` */
- readCompressedFile(option: ReadCompressedFileOption): void
- /** [FileSystemManager.readFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readFile.html)
- *
- * 读取本地文件内容
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.readFile({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- encoding: 'utf8',
- position: 0,
- success(res) {
- console.log(res.data)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.readFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'utf8', 0)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- readFile(option: ReadFileOption): void
- /** [FileSystemManager.readZipEntry(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readZipEntry.html)
- *
- * 需要基础库: `2.17.3`
- *
- * 读取压缩包内的文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 读取zip内某个或多个文件
- fs.readZipEntry({
- filePath: 'wxfile://from/to.zip',
- entries: [{
- path: 'some_folder/my_file.txt', // zip内文件路径
- encoding: 'utf-8', // 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
- position: 0, // 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte
- length: 10000, // 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte
- }, {
- path: 'other_folder/orther_file.txt', // zip内文件路径
- }],
- success(res) {
- console.log(res.entries)
- // res.entries === {
- // 'some_folder/my_file.txt': {
- // errMsg: 'readZipEntry:ok',
- // data: 'xxxxxx'
- // },
- // 'other_folder/orther_file.txt': {
- // data: (ArrayBuffer)
- // }
- // }
- },
- fail(res) {
- console.log(res.errMsg)
- },
- })
- // 读取zip内所有文件。允许指定统一的encoding。position、length则不再允许指定,分别默认为0和文件长度
- fs.readZipEntry({
- filePath: 'wxfile://from/to.zip',
- entries: 'all'
- encoding: 'utf-8', // 统一指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
- success(res) {
- console.log(res.entries)
- // res.entries === {
- // 'some_folder/my_file.txt': {
- // errMsg: 'readZipEntry:ok',
- // data: 'xxxxxx'
- // },
- // 'other_folder/orther_file.txt': {
- // errMsg: 'readZipEntry:ok',
- // data: 'xxxxxx'
- // }
- // }
- },
- fail(res) {
- console.log(res.errMsg)
- },
- })
- ``` */
- readZipEntry(option: ReadZipEntryOption): void
- /** [FileSystemManager.readdir(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readdir.html)
- *
- * 读取目录内文件列表
- *
- * **注意事项</title>
- * - readdir接口无法访问文件系统根路径(wxfile://)。
- * <title>示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.readdir({
- dirPath: `${wx.env.USER_DATA_PATH}/example`,
- success(res) {
- console.log(res.files)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.readdirSync(`${wx.env.USER_DATA_PATH}/example`)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- readdir(option: ReaddirOption): void
- /** [FileSystemManager.removeSavedFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.removeSavedFile.html)
- *
- * 删除该小程序下已保存的本地缓存文件 */
- removeSavedFile(option: RemoveSavedFileOption): void
- /** [FileSystemManager.rename(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rename.html)
- *
- * 重命名文件。可以把文件从 oldPath 移动到 newPath
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.rename({
- oldPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- newPath: `${wx.env.USER_DATA_PATH}/hello_new.txt`,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.renameSync(
- `${wx.env.USER_DATA_PATH}/hello.txt`,
- `${wx.env.USER_DATA_PATH}/hello_new.txt`
- )
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- rename(option: RenameOption): void
- /** [FileSystemManager.renameSync(string oldPath, string newPath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.renameSync.html)
- *
- * [FileSystemManager.rename](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rename.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.rename({
- oldPath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- newPath: `${wx.env.USER_DATA_PATH}/hello_new.txt`,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.renameSync(
- `${wx.env.USER_DATA_PATH}/hello.txt`,
- `${wx.env.USER_DATA_PATH}/hello_new.txt`
- )
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- renameSync(
- /** 源文件路径,支持本地路径 */
- oldPath: string,
- /** 新文件路径,支持本地路径 */
- newPath: string
- ): void
- /** [FileSystemManager.rmdir(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rmdir.html)
- *
- * 删除目录
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.rmdir({
- dirPath: `${wx.env.USER_DATA_PATH}/example`,
- recursive: false,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.rmdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- rmdir(option: RmdirOption): void
- /** [FileSystemManager.rmdirSync(string dirPath, boolean recursive)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rmdirSync.html)
- *
- * [FileSystemManager.rmdir](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.rmdir.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.rmdir({
- dirPath: `${wx.env.USER_DATA_PATH}/example`,
- recursive: false,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.rmdirSync(`${wx.env.USER_DATA_PATH}/example`, false)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- rmdirSync(
- /** 要删除的目录路径 (本地路径) */
- dirPath: string,
- /** 需要基础库: `2.3.0`
- *
- * 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 */
- recursive?: boolean
- ): void
- /** [FileSystemManager.saveFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.saveFile.html)
- *
- * 保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。 */
- saveFile(option: SaveFileOption): void
- /** [FileSystemManager.stat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.stat.html)
- *
- * 获取文件 Stats 对象 */
- stat(option: StatOption): void
- /** [FileSystemManager.truncate(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.truncate.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 对文件内容进行截断操作
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.truncate({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- length: 10, // 从第10个字节开始截断
- success(res) {
- console.log(res)
- }
- })
- ``` */
- truncate(option: TruncateOption): void
- /** [FileSystemManager.unlink(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unlink.html)
- *
- * 删除文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.unlink({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.unlinkSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- unlink(option: UnlinkOption): void
- /** [FileSystemManager.unlinkSync(string filePath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unlinkSync.html)
- *
- * [FileSystemManager.unlink](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unlink.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.unlink({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.unlinkSync(`${wx.env.USER_DATA_PATH}/hello.txt`)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- unlinkSync(
- /** 要删除的文件路径 (本地路径) */
- filePath: string
- ): void
- /** [FileSystemManager.unzip(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.unzip.html)
- *
- * 解压文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.unzip({
- zipFilePath: `${wx.env.USER_DATA_PATH}/example.zip`,
- targetPath: '${wx.env.USER_DATA_PATH}/example',
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- ``` */
- unzip(option: UnzipOption): void
- /** [FileSystemManager.write(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.write.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 写入文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- // 打开文件
- fs.open({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+',
- success(res) {
- // 写入文件
- fs.write({
- fd: res.fd,
- data: 'some text',
- success(res) {
- console.log(res.bytesWritten)
- }
- })
- }
- })
- ``` */
- write(option: WriteOption): void
- /** [FileSystemManager.writeFile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeFile.html)
- *
- * 写文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.writeFile({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- data: 'some text or arrayBuffer',
- encoding: 'utf8',
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.writeFileSync(
- `${wx.env.USER_DATA_PATH}/hello.txt`,
- 'some text or arrayBuffer',
- 'utf8'
- )
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- writeFile(option: WriteFileOption): void
- /** [FileSystemManager.writeFileSync(string filePath, string|ArrayBuffer data, string encoding)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeFileSync.html)
- *
- * [FileSystemManager.writeFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.writeFile.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.writeFile({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- data: 'some text or arrayBuffer',
- encoding: 'utf8',
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.writeFileSync(
- `${wx.env.USER_DATA_PATH}/hello.txt`,
- 'some text or arrayBuffer',
- 'utf8'
- )
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- writeFileSync(
- /** 要写入的文件路径 (本地路径) */
- filePath: string,
- /** 要写入的文本或二进制数据 */
- data: string | ArrayBuffer,
- /** 指定写入文件的字符编码
- *
- * 参数 encoding 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1'
- ): void
- /** [[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)
- *
- * 需要基础库: `2.16.1`
- *
- * 读文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const ab = new ArrayBuffer(1024)
- const fd = fs.openSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+'
- })
- const res = fs.readSync({
- fd: fd,
- arrayBuffer: ab,
- length: 10
- })
- console.log(res)
- ``` */
- readSync(option: ReadSyncOption): ReadResult
- /** [[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)
- *
- * 需要基础库: `2.16.1`
- *
- * 同步获取文件的状态信息
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const fd = fs.openSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+'
- })
- const stats = fs.fstatSync({fd: fd})
- console.log(stats)
- ``` */
- fstatSync(option: FstatSyncOption): Stats
- /** [[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)|Array.<[Stats](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.html)> FileSystemManager.statSync(string path, boolean recursive)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.statSync.html)
- *
- * [FileSystemManager.stat](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.stat.html) 的同步版本 */
- statSync(
- /** 文件/目录路径 (本地路径) */
- path: string,
- /** 需要基础库: `2.3.0`
- *
- * 是否递归获取目录下的每个文件的 Stats 信息 */
- recursive?: boolean
- ): Stats | Stats[]
- /** [[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)
- *
- * 需要基础库: `2.16.1`
- *
- * 同步写入文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const fd = fs.openSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+'
- })
- const res = fs.writeSync({
- fd: fd,
- data: 'some text'
- })
- console.log(res.bytesWritten)
- ``` */
- writeSync(option: WriteSyncOption): WriteResult
- /** [string FileSystemManager.openSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.openSync.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 同步打开文件,返回文件描述符
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const fd = fs.openSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+'
- })
- console.log(fd)
- ``` */
- openSync(option: OpenSyncOption): string
- /** [string FileSystemManager.saveFileSync(string tempFilePath, string filePath)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.saveFileSync.html)
- *
- * [FileSystemManager.saveFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.saveFile.html) 的同步版本 */
- saveFileSync(
- /** 临时存储文件路径 (本地路径) */
- tempFilePath: string,
- /** 要存储的文件路径 (本地路径) */
- filePath?: string
- ): string
- /** [string|ArrayBuffer FileSystemManager.readFileSync(string filePath, string encoding, number position, number length)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readFileSync.html)
- *
- * [FileSystemManager.readFile](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.readFile.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.readFile({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- encoding: 'utf8',
- position: 0,
- success(res) {
- console.log(res.data)
- },
- fail(res) {
- console.error(res)
- }
- })
- // 同步接口
- try {
- const res = fs.readFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'utf8', 0)
- console.log(res)
- } catch(e) {
- console.error(e)
- }
- ``` */
- readFileSync(
- /** 要读取的文件的路径 (本地路径) */
- filePath: string,
- /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
- *
- * 参数 encoding 可选值:
- * - 'ascii': ;
- * - 'base64': ;
- * - 'binary': ;
- * - 'hex': ;
- * - 'ucs2': 以小端序读取;
- * - 'ucs-2': 以小端序读取;
- * - 'utf16le': 以小端序读取;
- * - 'utf-16le': 以小端序读取;
- * - 'utf-8': ;
- * - 'utf8': ;
- * - 'latin1': ; */
- encoding?:
- | 'ascii'
- | 'base64'
- | 'binary'
- | 'hex'
- | 'ucs2'
- | 'ucs-2'
- | 'utf16le'
- | 'utf-16le'
- | 'utf-8'
- | 'utf8'
- | 'latin1',
- /** 需要基础库: `2.10.0`
- *
- * 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
- position?: number,
- /** 需要基础库: `2.10.0`
- *
- * 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
- length?: number
- ): string | ArrayBuffer
- /** [undefined FileSystemManager.closeSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.closeSync.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 同步关闭文件
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const fd = fs.openSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+'
- })
- // 关闭文件
- fs.closeSync({fd: fd})
- ``` */
- closeSync(option: CloseSyncOption): undefined
- /** [undefined FileSystemManager.ftruncateSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.ftruncateSync.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 对文件内容进行截断操作
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- const fd = fs.openSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- flag: 'a+'
- })
- fs.ftruncateSync({
- fd: fd,
- length: 10 // 从第10个字节开始截断文件
- })
- ``` */
- ftruncateSync(option: FtruncateSyncOption): undefined
- /** [undefined FileSystemManager.truncateSync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/FileSystemManager.truncateSync.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 对文件内容进行截断操作 (truncate 的同步版本)
- *
- * **示例代码**
- *
- * ```js
- const fs = wx.getFileSystemManager()
- fs.truncateSync({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- length: 10, // 从第10个字节开始截断
- })
- ``` */
- truncateSync(option: TruncateSyncOption): undefined
- }
- interface FstatSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 路径没有读权限 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 路径没有读权限 | */ errCode: number
- }
- interface FtruncateSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 没有写权限 |
- * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 没有写权限 |
- * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
- }
- interface GameBanner {
- /** [GameBanner.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.offError.html)
- *
- * 取消监听小游戏推荐banner组件加载错误事件 */
- offError(
- /** 小游戏推荐banner组件加载错误事件的回调函数 */
- callback?: GameBannerOffErrorCallback
- ): void
- /** [GameBanner.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.offLoad.html)
- *
- * 取消监听小游戏推荐banner组件加载成功事件 */
- offLoad(
- /** 小游戏推荐banner组件加载成功事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [GameBanner.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.offResize.html)
- *
- * 取消监听小游戏推荐banner组件位置或者尺寸改变事件 */
- offResize(
- /** 小游戏推荐banner组件位置或者尺寸改变事件的回调函数 */
- callback?: GameBannerOffResizeCallback
- ): void
- /** [GameBanner.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.onError.html)
- *
- * 监听小游戏推荐banner组件加载错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1002 | 推荐位id无效 | 可能是拼写错误、或者误用了其他小游戏的推荐位id | 请重新前往mp.weixin.qq.com确认推荐位id。 |
- * | 1004 | 无适合的推荐 | 推荐不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览推荐 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1008 | 推荐位已关闭 | 该推荐位的推荐能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应推荐位的展现。| */
- onError(
- /** 小游戏推荐banner组件加载错误事件的回调函数 */
- callback: GameBannerOnErrorCallback
- ): void
- /** [GameBanner.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.onLoad.html)
- *
- * 监听小游戏推荐banner组件加载成功事件。 */
- onLoad(
- /** 小游戏推荐banner组件加载成功事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [GameBanner.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.onResize.html)
- *
- * 监听小游戏推荐banner组件位置或者尺寸改变事件。 */
- onResize(
- /** 小游戏推荐banner组件位置或者尺寸改变事件的回调函数 */
- callback: GameBannerOnResizeCallback
- ): void
- /** [Promise GameBanner.destroy()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.destroy.html)
- *
- * 销毁小游戏推荐banner组件,组件销毁后所有方法和事件都将失效。 */
- destroy(): Promise<any>
- /** [Promise GameBanner.hide()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.hide.html)
- *
- * 隐藏小游戏推荐banner组件。 */
- hide(): Promise<any>
- /** [Promise GameBanner.show()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameBanner.show.html)
- *
- * 显示小游戏推荐banner组件。 */
- show(): Promise<any>
- }
- interface GameClubButton {
- /** [GameClubButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.destroy.html)
- *
- * 销毁游戏圈按钮 */
- destroy(): void
- /** [GameClubButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.hide.html)
- *
- * 隐藏游戏圈按钮 */
- hide(): void
- /** [GameClubButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.offTap.html)
- *
- * 取消监听游戏圈按钮的点击事件 */
- offTap(
- /** 游戏圈按钮的点击事件的回调函数 */
- callback?: GameClubButtonOffTapCallback
- ): void
- /** [GameClubButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.onTap.html)
- *
- * 监听游戏圈按钮的点击事件 */
- onTap(
- /** 游戏圈按钮的点击事件的回调函数 */
- callback: GameClubButtonOnTapCallback
- ): void
- /** [GameClubButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/game-club/GameClubButton.show.html)
- *
- * 显示游戏圈按钮 */
- show(): void
- }
- interface GameIcon {
- /** [GameIcon.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.offError.html)
- *
- * 取消监听小游戏推荐icon组件加载错误事件 */
- offError(
- /** 小游戏推荐icon组件加载错误事件的回调函数 */
- callback?: GameBannerOffErrorCallback
- ): void
- /** [GameIcon.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.offLoad.html)
- *
- * 取消监听小游戏推荐icon组件加载成功事件 */
- offLoad(
- /** 小游戏推荐icon组件加载成功事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [GameIcon.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.offResize.html)
- *
- * 取消监听小游戏推荐icon组件位置或者尺寸改变事件 */
- offResize(
- /** 小游戏推荐icon组件位置或者尺寸改变事件的回调函数 */
- callback?: GameBannerOffResizeCallback
- ): void
- /** [GameIcon.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.onError.html)
- *
- * 监听小游戏推荐icon组件加载错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1002 | 推荐位id无效 | 可能是拼写错误、或者误用了其他小游戏的推荐位id | 请重新前往mp.weixin.qq.com确认推荐位id。 |
- * | 1004 | 无适合的推荐 | 推荐不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览推荐 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1008 | 推荐位已关闭 | 该推荐位的推荐能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应推荐位的展现。|
- * | 1009 | 推荐位id类型错误| 可能复制了其他类型的推荐位id | 请前往mp.weixin.qq.com 确认推荐位id | */
- onError(
- /** 小游戏推荐icon组件加载错误事件的回调函数 */
- callback: GameBannerOnErrorCallback
- ): void
- /** [GameIcon.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.onLoad.html)
- *
- * 监听小游戏推荐icon组件加载成功事件。 */
- onLoad(
- /** 小游戏推荐icon组件加载成功事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [GameIcon.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.onResize.html)
- *
- * 监听小游戏推荐icon组件位置或者尺寸改变事件。回调函数回抛出一个数组,包含被渲染出来的游戏的信息,该数组为组件实例属性icons的子集。 */
- onResize(
- /** 小游戏推荐icon组件位置或者尺寸改变事件的回调函数 */
- callback: GameBannerOnResizeCallback
- ): void
- /** [Promise GameIcon.destroy()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.destroy.html)
- *
- * 销毁小游戏推荐icon组件,组件销毁后所有方法和事件都将失效。 */
- destroy(): Promise<any>
- /** [Promise GameIcon.hide()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.hide.html)
- *
- * 隐藏小游戏推荐icon组件。 */
- hide(): Promise<any>
- /** [Promise GameIcon.load()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.load.html)
- *
- * 小游戏推荐icon组件加载数据接口。 */
- load(): Promise<any>
- /** [Promise GameIcon.show()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GameIcon.show.html)
- *
- * 显示小游戏推荐icon组件。 */
- show(): Promise<any>
- }
- interface GamePortal {
- /** [GamePortal.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.offClose.html)
- *
- * 取消监听小游戏推荐弹窗组件的关闭事件 */
- offClose(
- /** 小游戏推荐弹窗组件的关闭事件的回调函数 */
- callback?: UDPSocketOffCloseCallback
- ): void
- /** [GamePortal.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.offError.html)
- *
- * 取消监听小游戏推荐弹窗组件加载错误事件 */
- offError(
- /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
- callback?: GamePortalOffErrorCallback
- ): void
- /** [GamePortal.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.offLoad.html)
- *
- * 取消监听小游戏推荐弹窗组件的数据加载成功事件 */
- offLoad(
- /** 小游戏推荐弹窗组件的数据加载成功事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [GamePortal.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.onClose.html)
- *
- * 监听小游戏推荐弹窗组件的关闭事件。 */
- onClose(
- /** 小游戏推荐弹窗组件的关闭事件的回调函数 */
- callback: UDPSocketOnCloseCallback
- ): void
- /** [GamePortal.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.onError.html)
- *
- * 监听小游戏推荐弹窗组件加载错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1002 | 推荐位id无效 | 可能是拼写错误、或者误用了其他小游戏的推荐位id | 请重新前往mp.weixin.qq.com确认推荐位id。 |
- * | 1004 | 无适合的推荐 | 推荐不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览推荐 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1008 | 推荐位已关闭 | 该推荐位的推荐能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应推荐位的展现。| */
- onError(
- /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
- callback: GamePortalOnErrorCallback
- ): void
- /** [GamePortal.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.onLoad.html)
- *
- * 监听小游戏推荐弹窗组件的数据加载成功事件。 */
- onLoad(
- /** 小游戏推荐弹窗组件的数据加载成功事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [Promise GamePortal.destroy()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.destroy.html)
- *
- * 销毁小游戏推荐弹窗组件,组件销毁后,组件的方法和事件都将失效。 */
- destroy(): Promise<any>
- /** [Promise GamePortal.load()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.load.html)
- *
- * 小游戏推荐弹窗组件加载数据接口。 */
- load(): Promise<any>
- /** [Promise GamePortal.show()](https://developers.weixin.qq.com/minigame/dev/api/game-portal/GamePortal.show.html)
- *
- * 显示小游戏推荐弹窗组件。 */
- show(): Promise<any>
- }
- interface GameRecorder {
- /** [GameRecorder.off(string event, function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.off.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 取消监听录制事件。当对应事件触发时,该回调函数不再执行。 */
- off(
- /** 事件名
- *
- * 参数 event 可选值:
- * - 'start': 录制开始事件。当调用 [GameRecorder.start()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.start.html) 且客户端真正开始了对游戏画面录制时触发该事件。;
- * - 'stop': 录制结束事件。当调用 [GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html) 且客户端真正停止了对游戏画面录制时触发该事件。;
- * - 'pause': 录制暂停事件。当调用 [GameRecorder.pause()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.pause.html) 且客户端真正暂停了对游戏画面录制时触发该事件。;
- * - 'resume': 录制恢复事件。当调用 [GameRecorder.resume()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.resume.html) 且客户端真正恢复了对游戏画面录制时触发该事件。;
- * - 'abort': 录制取消事件。当调用 [GameRecorder.abort()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.abort.html) 且客户端真正取消了对游戏画面录制时触发该事件。;
- * - 'timeUpdate': 录制时间更新事件。在录制过程中触发该事件。;
- * - '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) 发起编辑界面并进行分享的过程。; */
- event:
- | 'start'
- | 'stop'
- | 'pause'
- | 'resume'
- | 'abort'
- | 'timeUpdate'
- | 'error',
- /** 事件触发时不再执行的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [GameRecorder.on(string event, function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.on.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 注册监听录制事件的回调函数。当对应事件触发时,回调函数会被执行。
- *
- * **事件参数**
- *
- * 除了 timeUpdate error stop 事件外,其他事件都是无参的
- *
- * __timeUpdate__
- *
- * | 属性 | 类型 | 说明 |
- * | -- | --- | --- |
- * | currentTime | number | 当前视频录制到第几秒 |
- *
- * ```javascript
- const recorder = wx.getGameRecorder()
- recorder.on('timeUpdate', res => {
- console.log(res.currentTime)
- })
- ```
- *
- * __error__
- *
- * | 属性 | 类型 | 说明 |
- * | -- | --- | --- |
- * | code | number | 错误码 |
- * | message | string | 错误信息 |
- *
- * ```javascript
- const recorder = wx.getGameRecorder()
- recorder.on('error', res => {
- console.log('错误码', res.error.code)
- console.log('错误信息', res.error.message)
- // 对错误码进行判断
- if (res.error.code === wx.error.GameRecorder_StartWhileAlreadyStartRecording) {
- }
- })
- ```
- *
- * __stop__
- *
- * | 属性 | 类型 | 说明 |
- * | -- | --- | --- |
- * | duration | number | 视频的时长,单位 ms 毫秒 |
- *
- * ```javascript
- const recorder = wx.getGameRecorder()
- recorder.on('stop', res => {
- console.log('视频时长'), res.duration)
- })
- ``` */
- on(
- /** 事件名
- *
- * 参数 event 可选值:
- * - 'start': 录制开始事件。当调用 [GameRecorder.start()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.start.html) 且客户端真正开始了对游戏画面录制时触发该事件。;
- * - 'stop': 录制结束事件。当调用 [GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html) 且客户端真正停止了对游戏画面录制时触发该事件。;
- * - 'pause': 录制暂停事件。当调用 [GameRecorder.pause()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.pause.html) 且客户端真正暂停了对游戏画面录制时触发该事件。;
- * - 'resume': 录制恢复事件。当调用 [GameRecorder.resume()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.resume.html) 且客户端真正恢复了对游戏画面录制时触发该事件。;
- * - 'abort': 录制取消事件。当调用 [GameRecorder.abort()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.abort.html) 且客户端真正取消了对游戏画面录制时触发该事件。;
- * - 'timeUpdate': 录制时间更新事件。在录制过程中触发该事件。;
- * - '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) 发起编辑界面并进行分享的过程。; */
- event:
- | 'start'
- | 'stop'
- | 'pause'
- | 'resume'
- | 'abort'
- | 'timeUpdate'
- | 'error',
- /** 事件触发时执行的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [GameRecorder.start(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.start.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 开始录制游戏画面 */
- start(option: GameRecorderStartOption): void
- /** [Promise GameRecorder.abort()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.abort.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 放弃录制游戏画面。此时已经录制的内容会被丢弃。 */
- abort(): Promise<any>
- /** [Promise GameRecorder.pause()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.pause.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 暂停录制游戏画面。 */
- pause(): Promise<any>
- /** [Promise GameRecorder.resume()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.resume.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 恢复录制游戏画面。 */
- resume(): Promise<any>
- /** [Promise GameRecorder.stop()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.stop.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 结束录制游戏画面。结束录制后可以发起分享。 */
- stop(): Promise<any>
- /** [boolean GameRecorder.isAtempoSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isAtempoSupported.html)
- *
- * 需要基础库: `2.10.0`
- *
- * 获取是否支持调节录制视频的播放速率 */
- isAtempoSupported(): boolean
- /** [boolean GameRecorder.isFrameSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isFrameSupported.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 获取是否支持录制游戏画面 */
- isFrameSupported(): boolean
- /** [boolean GameRecorder.isSoundSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isSoundSupported.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 获取是否在录制游戏画面的同时支持录制游戏音频的信息 */
- isSoundSupported(): boolean
- /** [boolean GameRecorder.isVolumeSupported()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorder.isVolumeSupported.html)
- *
- * 需要基础库: `2.10.0`
- *
- * 获取是否支持调节录制视频的音量 */
- isVolumeSupported(): boolean
- }
- interface GameRecorderError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | wx.error.GameRecorder_UnknownError | unknown error | 未知错误,没有被归纳到的错误 |
- * | wx.error.GameRecorder_InternalFailed | internal failed | 游戏画面录制 SDK 内部错误 |
- * | wx.error.GameRecorder_NotSupported | frame not supported | 当前设备不支持录制游戏画面 |
- * | wx.error.GameRecorder_StartDurationInvalid | duration invalid | duration 参数不合法 |
- * | wx.error.GameRecorder_StartBitRateInvalid | bitrate invalid | bitrate 参数不合法 |
- * | wx.error.GameRecorder_StartFPSInvalid | fps invalid | fps 参数不合法 |
- * | wx.error.GameRecorder_StartGOPInvalid | gop invalid | gop 参数不合法 |
- * | wx.error.GameRecorder_StartWhileAlreadyStartRecording | start while already start recording | 在已经开始录制的情况下调用 start |
- * | wx.error.GameRecorder_StartWhilePaused | start while already paused | 在已经暂停录制的情况下调用 start,此时只能调用 resume 恢复录制 |
- * | wx.error.GameRecorder_PauseWhileNotStartRecording | pause while not start recording | 在还没有开始录制的情况下调用 pause |
- * | wx.error.GameRecorder_PauseWhileAlreadyPaused | pause while already paused | 在已经暂停录制的情况下调用 pause |
- * | wx.error.GameRecorder_ResumeWhileNotStartRecording | resume while not start recording | 在还没有开始录制的情况下调用 resume |
- * | wx.error.GameRecorder_ResumeWhileRecording | resume while recording | 在录制中调用 resume,调用 resume 只能在暂停状态下 |
- * | wx.error.GameRecorder_AbortWhileNotStartRecording | abort while not start recording | 在还没有开始录制的情况下调用 abort |
- * | wx.error.GameRecorder_StopWhileNotStartRecording | stop while not start recording | 在还没有开始录制的情况下调用 stop |
- * | wx.error.GameRecorder_NoVideo | no recorded video | 在还没有一个录制好的对局回放的情况下发起分享 |
- * | wx.error.GameRecorder_BGMNotFound | bgm not found | share.bgm 指定的额背景音乐不存在 |
- * | wx.error.GameRecorder_TimeRangeInvalid | time range invalid | share.timeRange 不合法 |
- * | wx.error.GameRecorder_EditDurationOutOfLimit | duration out of limit | share.timeRange 的所有片段的总和超出上限 |
- * | wx.error.GameRecorder_TimeRangeTooShort | time range too short.It should be longer than 2s | share.timeRange 太短 | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | wx.error.GameRecorder_UnknownError | unknown error | 未知错误,没有被归纳到的错误 |
- * | wx.error.GameRecorder_InternalFailed | internal failed | 游戏画面录制 SDK 内部错误 |
- * | wx.error.GameRecorder_NotSupported | frame not supported | 当前设备不支持录制游戏画面 |
- * | wx.error.GameRecorder_StartDurationInvalid | duration invalid | duration 参数不合法 |
- * | wx.error.GameRecorder_StartBitRateInvalid | bitrate invalid | bitrate 参数不合法 |
- * | wx.error.GameRecorder_StartFPSInvalid | fps invalid | fps 参数不合法 |
- * | wx.error.GameRecorder_StartGOPInvalid | gop invalid | gop 参数不合法 |
- * | wx.error.GameRecorder_StartWhileAlreadyStartRecording | start while already start recording | 在已经开始录制的情况下调用 start |
- * | wx.error.GameRecorder_StartWhilePaused | start while already paused | 在已经暂停录制的情况下调用 start,此时只能调用 resume 恢复录制 |
- * | wx.error.GameRecorder_PauseWhileNotStartRecording | pause while not start recording | 在还没有开始录制的情况下调用 pause |
- * | wx.error.GameRecorder_PauseWhileAlreadyPaused | pause while already paused | 在已经暂停录制的情况下调用 pause |
- * | wx.error.GameRecorder_ResumeWhileNotStartRecording | resume while not start recording | 在还没有开始录制的情况下调用 resume |
- * | wx.error.GameRecorder_ResumeWhileRecording | resume while recording | 在录制中调用 resume,调用 resume 只能在暂停状态下 |
- * | wx.error.GameRecorder_AbortWhileNotStartRecording | abort while not start recording | 在还没有开始录制的情况下调用 abort |
- * | wx.error.GameRecorder_StopWhileNotStartRecording | stop while not start recording | 在还没有开始录制的情况下调用 stop |
- * | wx.error.GameRecorder_NoVideo | no recorded video | 在还没有一个录制好的对局回放的情况下发起分享 |
- * | wx.error.GameRecorder_BGMNotFound | bgm not found | share.bgm 指定的额背景音乐不存在 |
- * | wx.error.GameRecorder_TimeRangeInvalid | time range invalid | share.timeRange 不合法 |
- * | wx.error.GameRecorder_EditDurationOutOfLimit | duration out of limit | share.timeRange 的所有片段的总和超出上限 |
- * | wx.error.GameRecorder_TimeRangeTooShort | time range too short.It should be longer than 2s | share.timeRange 太短 | */ errCode: number
- }
- interface GameRecorderShareButton {
- /** [GameRecorderShareButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.hide.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 隐藏游戏对局回放分享按钮 */
- hide(): void
- /** [GameRecorderShareButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.offTap.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 取消监听游戏对局回放分享按钮的点击事件 */
- offTap(
- /** 游戏对局回放分享按钮的点击事件的回调函数 */
- callback?: GameClubButtonOffTapCallback
- ): void
- /** [GameRecorderShareButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.onTap.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 监听游戏对局回放分享按钮的点击事件。只有当分享由于非用户取消的原因失败时,该事件的回调函数才会执行。 */
- onTap(
- /** 游戏对局回放分享按钮的点击事件的回调函数 */
- callback: GameClubButtonOnTapCallback
- ): void
- /** [GameRecorderShareButton.show()](https://developers.weixin.qq.com/minigame/dev/api/game-recorder/GameRecorderShareButton.show.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 显示游戏对局回放分享按钮 */
- show(): void
- }
- interface GameServerManager {
- /** [GameServerManager.getFriendsStateData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getFriendsStateData.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 获取所有好友的在线状态及信息。该接口需要用户授权,且只在开放数据域下可用。 */
- getFriendsStateData(option?: GetFriendsStateDataOption): void
- /** [GameServerManager.offBeKickedOut(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offBeKickedOut.html)
- *
- * 取消监听自己被踢出当前房间 */
- offBeKickedOut(
- /** 的回调函数 */
- callback?: OffBeKickedOutCallback
- ): void
- /** [GameServerManager.offBroadcast(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offBroadcast.html)
- *
- * 取消监听收到同个房间内的广播消息 */
- offBroadcast(
- /** 的回调函数 */
- callback?: OffBroadcastCallback
- ): void
- /** [GameServerManager.offDisconnect(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offDisconnect.html)
- *
- * 取消监听断开连接,收到此事件 */
- offDisconnect(
- /** 断开连接,收到此事件的回调函数 */
- callback?: OffDisconnectCallback
- ): void
- /** [GameServerManager.offGameEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offGameEnd.html)
- *
- * 取消监听帧同步游戏结束 */
- offGameEnd(
- /** 的回调函数 */
- callback?: OffGameEndCallback
- ): void
- /** [GameServerManager.offGameStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offGameStart.html)
- *
- * 取消监听帧同步游戏开始 */
- offGameStart(
- /** 的回调函数 */
- callback?: OffGameStartCallback
- ): void
- /** [GameServerManager.offInvite(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offInvite.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 取消监听接收邀请,当用户确认邀请之后会收到此事件 */
- offInvite(
- /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
- callback?: OffInviteCallback
- ): void
- /** [GameServerManager.offLockStepError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offLockStepError.html)
- *
- * 需要基础库: `2.11.2`
- *
- * 取消监听帧同步出错 */
- offLockStepError(
- /** 的回调函数 */
- callback?: OffLockStepErrorCallback
- ): void
- /** [GameServerManager.offLogout(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offLogout.html)
- *
- * 取消监听用户登出游戏服务事件 */
- offLogout(
- /** 用户登出游戏服务事件的回调函数 */
- callback?: OffLogoutCallback
- ): void
- /** [GameServerManager.offMatch(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offMatch.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 取消监听游戏匹配成功的事件 */
- offMatch(
- /** 游戏匹配成功的事件的回调函数 */
- callback?: OffMatchCallback
- ): void
- /** [GameServerManager.offRoomInfoChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offRoomInfoChange.html)
- *
- * 取消监听房间信息更新 */
- offRoomInfoChange(
- /** 的回调函数 */
- callback?: OffRoomInfoChangeCallback
- ): void
- /** [GameServerManager.offStateUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offStateUpdate.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 取消监听好友在线状态变更(该接口需要在开放数据域使用) */
- offStateUpdate(
- /** 的回调函数 */
- callback?: OffStateUpdateCallback
- ): void
- /** [GameServerManager.offSyncFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.offSyncFrame.html)
- *
- * 取消监听收到同个房间的帧同步消息 */
- offSyncFrame(
- /** 的回调函数 */
- callback?: OffSyncFrameCallback
- ): void
- /** [GameServerManager.onBeKickedOut(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onBeKickedOut.html)
- *
- * 监听自己被踢出当前房间 */
- onBeKickedOut(
- /** 的回调函数 */
- callback: OnBeKickedOutCallback
- ): void
- /** [GameServerManager.onBroadcast(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onBroadcast.html)
- *
- * 监听收到同个房间内的广播消息 */
- onBroadcast(
- /** 的回调函数 */
- callback: OnBroadcastCallback
- ): void
- /** [GameServerManager.onDisconnect(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onDisconnect.html)
- *
- * 监听断开连接,收到此事件后,需要调用 `GameServerManager.reconnect` 进行重连 */
- onDisconnect(
- /** 断开连接,收到此事件的回调函数 */
- callback: OnDisconnectCallback
- ): void
- /** [GameServerManager.onGameEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onGameEnd.html)
- *
- * 监听帧同步游戏结束 */
- onGameEnd(
- /** 的回调函数 */
- callback: OnGameEndCallback
- ): void
- /** [GameServerManager.onGameStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onGameStart.html)
- *
- * 监听帧同步游戏开始 */
- onGameStart(
- /** 的回调函数 */
- callback: OnGameStartCallback
- ): void
- /** [GameServerManager.onInvite(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onInvite.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 监听接收邀请,当用户确认邀请之后会收到此事件 */
- onInvite(
- /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
- callback: OnInviteCallback
- ): void
- /** [GameServerManager.onLockStepError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onLockStepError.html)
- *
- * 需要基础库: `2.11.2`
- *
- * 监听帧同步出错 */
- onLockStepError(
- /** 的回调函数 */
- callback: OnLockStepErrorCallback
- ): void
- /** [GameServerManager.onLogout(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onLogout.html)
- *
- * 监听用户登出游戏服务事件,可能是主动登出也可能是其他原因被动登出 */
- onLogout(
- /** 用户登出游戏服务事件的回调函数 */
- callback: OnLogoutCallback
- ): void
- /** [GameServerManager.onMatch(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onMatch.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 监听游戏匹配成功的事件 */
- onMatch(
- /** 游戏匹配成功的事件的回调函数 */
- callback: OnMatchCallback
- ): void
- /** [GameServerManager.onRoomInfoChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onRoomInfoChange.html)
- *
- * 监听房间信息更新 */
- onRoomInfoChange(
- /** 的回调函数 */
- callback: OnRoomInfoChangeCallback
- ): void
- /** [GameServerManager.onStateUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onStateUpdate.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 监听好友在线状态变更(该接口需要在开放数据域使用) */
- onStateUpdate(
- /** 的回调函数 */
- callback: OnStateUpdateCallback
- ): void
- /** [GameServerManager.onSyncFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.onSyncFrame.html)
- *
- * 监听收到同个房间的帧同步消息 */
- onSyncFrame(
- /** 的回调函数 */
- callback: OnSyncFrameCallback
- ): void
- /** [GameServerManager.startGame(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.startGame.html)
- *
- * 启动帧同步 */
- startGame(option?: StartGameOption): void
- /** [Promise GameServerManager.broadcastInRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.broadcastInRoom.html)
- *
- * 在房间内广播 */
- broadcastInRoom(option: BroadcastInRoomOption): Promise<any>
- /** [Promise GameServerManager.cancelMatch(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.cancelMatch.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 取消游戏匹配 */
- cancelMatch(option: CancelMatchOption): Promise<any>
- /** [Promise GameServerManager.changeSeat(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.changeSeat.html)
- *
- * 玩家换座位 */
- changeSeat(option: ChangeSeatOption): Promise<any>
- /** [Promise GameServerManager.createRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.createRoom.html)
- *
- * 创建游戏房间 */
- createRoom(option: CreateRoomOption): Promise<any>
- /** [Promise GameServerManager.endGame(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.endGame.html)
- *
- * 结束帧同步 */
- endGame(option?: EndGameOption): Promise<any>
- /** [Promise GameServerManager.endStateService(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.endStateService.html)
- *
- * 结束游戏状态同步服务 */
- endStateService(option?: EndStateServiceOption): Promise<any>
- /** [Promise GameServerManager.getLastRoomInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getLastRoomInfo.html)
- *
- * 获取最近参与房间的 accessInfo */
- getLastRoomInfo(option?: GetLastRoomInfoOption): Promise<any>
- /** [Promise GameServerManager.getLostFrames(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getLostFrames.html)
- *
- * 补帧,补帧区间为 [beginFrameId, endFrameId),即左闭右合。 */
- getLostFrames(option: GetLostFramesOption): Promise<any>
- /** [Promise GameServerManager.getRoomInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.getRoomInfo.html)
- *
- * 获取房间详情 */
- getRoomInfo(option?: GetRoomInfoOption): Promise<any>
- /** [Promise GameServerManager.inviteFriend(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.inviteFriend.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 邀请好友,该好友的系统状态必须为在线(该接口需要在开放数据域使用) */
- inviteFriend(option: InviteFriendOption): Promise<any>
- /** [Promise GameServerManager.joinRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.joinRoom.html)
- *
- * 加入游戏房间 */
- joinRoom(option: JoinRoomOption): Promise<any>
- /** [Promise GameServerManager.kickoutMember(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.kickoutMember.html)
- *
- * 把一名玩家踢出房间(仅房主有权限) */
- kickoutMember(option: KickoutMemberOption): Promise<any>
- /** [Promise GameServerManager.login()](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.login.html)
- *
- * 登录游戏服务 */
- login(): Promise<any>
- /** [Promise GameServerManager.logout()](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.logout.html)
- *
- * 登出游戏服务 */
- logout(): Promise<any>
- /** [Promise GameServerManager.memberLeaveRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.memberLeaveRoom.html)
- *
- * 普通成员退出房间 */
- memberLeaveRoom(option: MemberLeaveRoomOption): Promise<any>
- /** [Promise GameServerManager.ownerLeaveRoom(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.ownerLeaveRoom.html)
- *
- * 房主退出房间,`assign_owner_to_pos_num` 参数被优先处理,其次是 `assign_to_min_pos_num`,如果二者都没有被设置,则房主退出且房间销毁。 */
- ownerLeaveRoom(option: OwnerLeaveRoomOption): Promise<any>
- /** [Promise GameServerManager.reconnect(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.reconnect.html)
- *
- * 重连游戏服务。如果此时连接并未断开或游戏未开始,会直接成功;如果游戏已开始并且连接已断开,会进行重连,并返回此时服务器的最大帧号。 */
- reconnect(option: ReconnectOption): Promise<any>
- /** [Promise GameServerManager.restart(Object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.restart.html)
- *
- * 重启游戏并进入"组队中"的状态。如果当前房间游戏已结束,调用可进入"组队中"状态并重置所有玩家的准备状态;如果当前房间已经在"组队中"状态,调用不改变状态;如果当前房间游戏进行中,调用失败。 */
- restart(option?: RestartOption): Promise<any>
- /** [Promise GameServerManager.setState(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.setState.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 更新玩家状态信息 */
- setState(option: SetStateOption): Promise<any>
- /** [Promise GameServerManager.startMatch(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.startMatch.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 开始游戏匹配 */
- startMatch(option: StartMatchOption): Promise<any>
- /** [Promise GameServerManager.startStateService(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.startStateService.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 开启状态管理服务,只有开启状态管理服务,才能获取在线好友列表以及接收好友邀请 */
- startStateService(option: StartStateServiceOption): Promise<any>
- /** [Promise GameServerManager.updateReadyStatus(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.updateReadyStatus.html)
- *
- * 更新玩家准备信息 */
- updateReadyStatus(option: UpdateReadyStatusOption): Promise<any>
- /** [Promise GameServerManager.uploadFrame(object object)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.uploadFrame.html)
- *
- * 上传游戏帧 */
- uploadFrame(option: UploadFrameOption): Promise<any>
- /** [boolean GameServerManager.setInviteData(string data)](https://developers.weixin.qq.com/minigame/dev/api/game-server-manager/GameServerManager.setInviteData.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 设置邀请好友附带的数据 */
- setInviteData(
- /** 需要设置的字符串数据 */
- data: string
- ): boolean
- }
- interface GameServerManagerError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 1001 | has not logged in to server | 未登录到服务器就调用接口 |
- * | 2100 | | 登录帧同步服务器超时 |
- * | 2101 | | 重连帧同步服务器超时 |
- * | 2200 | | 登录帧同步服务器错误或失败导致的disconnect |
- * | 2201 | | 长期未收到帧导致的disconnect |
- * | 2202 | | 长期未收到心跳导致的disconnect |
- * | 2203 | | 断线过久,无法重连导致的disconnect |
- * | 2204 | | UDPconnectionfail导致的disconnect |
- * | 2300 | | UDPsocketerror |
- * | 2301 | | UDPsystemerror |
- * | 2303 | | UDPaddresserror |
- * | 2304 | | UDPporterror |
- * | 2305 | | UDPsenderror |
- * | 2401 | | 登录帧同步服务器成功之前发送帧 |
- * | 2402 | | frame长度超过MTU |
- * | 4001 | system error | 系统错误 |
- * | 4002 | record not exist | 访问记录不存在 |
- * | 4003 | invalid req | 非法请求 |
- * | 4005 | invalid room state | 房间状态异常 |
- * | 4006 | reach room member limit | 房间到达人数上限,无法加入 |
- * | 4009 | headimg and nickname is not authorized by the user | 该房间需要用户头像昵称,但用户未授权 |
- * | 4010 | fail to start game | 启动游戏失败 |
- * | 4011 | fail to broadcast | 广播消息失败 |
- * | 4013 | buffer overflow | 自定义 buffer 超过指定大小(matchInfo 和 extInfo) |
- * | 200000 | | 无效的请求参数 |
- * | 200006 | | matchid此时为未打开状态 |
- * | 500001 | | 用户已经在匹配队列中 |
- * | 500003 | | 用户未在匹配队列中 |
- * | 500005 | | 无效的match_id |
- * | 500009 | | 路由到错误的服务器 | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 1001 | has not logged in to server | 未登录到服务器就调用接口 |
- * | 2100 | | 登录帧同步服务器超时 |
- * | 2101 | | 重连帧同步服务器超时 |
- * | 2200 | | 登录帧同步服务器错误或失败导致的disconnect |
- * | 2201 | | 长期未收到帧导致的disconnect |
- * | 2202 | | 长期未收到心跳导致的disconnect |
- * | 2203 | | 断线过久,无法重连导致的disconnect |
- * | 2204 | | UDPconnectionfail导致的disconnect |
- * | 2300 | | UDPsocketerror |
- * | 2301 | | UDPsystemerror |
- * | 2303 | | UDPaddresserror |
- * | 2304 | | UDPporterror |
- * | 2305 | | UDPsenderror |
- * | 2401 | | 登录帧同步服务器成功之前发送帧 |
- * | 2402 | | frame长度超过MTU |
- * | 4001 | system error | 系统错误 |
- * | 4002 | record not exist | 访问记录不存在 |
- * | 4003 | invalid req | 非法请求 |
- * | 4005 | invalid room state | 房间状态异常 |
- * | 4006 | reach room member limit | 房间到达人数上限,无法加入 |
- * | 4009 | headimg and nickname is not authorized by the user | 该房间需要用户头像昵称,但用户未授权 |
- * | 4010 | fail to start game | 启动游戏失败 |
- * | 4011 | fail to broadcast | 广播消息失败 |
- * | 4013 | buffer overflow | 自定义 buffer 超过指定大小(matchInfo 和 extInfo) |
- * | 200000 | | 无效的请求参数 |
- * | 200006 | | matchid此时为未打开状态 |
- * | 500001 | | 用户已经在匹配队列中 |
- * | 500003 | | 用户未在匹配队列中 |
- * | 500005 | | 无效的match_id |
- * | 500009 | | 路由到错误的服务器 | */ errCode: number
- }
- interface GridAd {
- /** [GridAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.destroy.html)
- *
- * 销毁 grid(格子) 广告。 */
- destroy(): void
- /** [GridAd.hide()](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.hide.html)
- *
- * 隐藏 grid(格子) 广告。 */
- hide(): void
- /** [GridAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.offError.html)
- *
- * 取消监听 grid(格子) 广告错误事件 */
- offError(
- /** grid(格子) 广告错误事件的回调函数 */
- callback?: BannerAdOffErrorCallback
- ): void
- /** [GridAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.offLoad.html)
- *
- * 取消监听 grid(格子) 广告加载事件 */
- offLoad(
- /** grid(格子) 广告加载事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [GridAd.offResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.offResize.html)
- *
- * 取消监听 grid(格子) 广告尺寸变化事件 */
- offResize(
- /** grid(格子) 广告尺寸变化事件的回调函数 */
- callback?: BannerAdOffResizeCallback
- ): void
- /** [GridAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.onError.html)
- *
- * 监听 grid(格子) 广告错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
- * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
- * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
- * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
- * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
- * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
- onError(
- /** grid(格子) 广告错误事件的回调函数 */
- callback: BannerAdOnErrorCallback
- ): void
- /** [GridAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.onLoad.html)
- *
- * 监听 grid(格子) 广告加载事件。 */
- onLoad(
- /** grid(格子) 广告加载事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [GridAd.onResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.onResize.html)
- *
- * 监听 grid(格子) 广告尺寸变化事件。 */
- onResize(
- /** grid(格子) 广告尺寸变化事件的回调函数 */
- callback: BannerAdOnResizeCallback
- ): void
- /** [Promise GridAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/GridAd.show.html)
- *
- * 显示 grid(格子) 广告。 */
- show(): Promise<any>
- }
- interface InnerAudioContext {
- /** [InnerAudioContext.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.destroy.html)
- *
- * 销毁当前实例 */
- destroy(): void
- /** [InnerAudioContext.offCanplay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offCanplay.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频进入可以播放状态的事件 */
- offCanplay(
- /** 音频进入可以播放状态的事件的回调函数 */
- callback?: OffCanplayCallback
- ): void
- /** [InnerAudioContext.offEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offEnded.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频自然播放至结束的事件 */
- offEnded(
- /** 音频自然播放至结束的事件的回调函数 */
- callback?: OffEndedCallback
- ): void
- /** [InnerAudioContext.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offError.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频播放错误事件 */
- offError(
- /** 音频播放错误事件的回调函数 */
- callback?: InnerAudioContextOffErrorCallback
- ): void
- /** [InnerAudioContext.offPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offPause.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频暂停事件 */
- offPause(
- /** 音频暂停事件的回调函数 */
- callback?: OffPauseCallback
- ): void
- /** [InnerAudioContext.offPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offPlay.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频播放事件 */
- offPlay(
- /** 音频播放事件的回调函数 */
- callback?: OffPlayCallback
- ): void
- /** [InnerAudioContext.offSeeked(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offSeeked.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频完成跳转操作的事件 */
- offSeeked(
- /** 音频完成跳转操作的事件的回调函数 */
- callback?: OffSeekedCallback
- ): void
- /** [InnerAudioContext.offSeeking(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offSeeking.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频进行跳转操作的事件 */
- offSeeking(
- /** 音频进行跳转操作的事件的回调函数 */
- callback?: OffSeekingCallback
- ): void
- /** [InnerAudioContext.offStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offStop.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频停止事件 */
- offStop(
- /** 音频停止事件的回调函数 */
- callback?: OffStopCallback
- ): void
- /** [InnerAudioContext.offTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offTimeUpdate.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频播放进度更新事件 */
- offTimeUpdate(
- /** 音频播放进度更新事件的回调函数 */
- callback?: InnerAudioContextOffTimeUpdateCallback
- ): void
- /** [InnerAudioContext.offWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.offWaiting.html)
- *
- * 需要基础库: `1.9.0`
- *
- * 取消监听音频加载中事件 */
- offWaiting(
- /** 音频加载中事件的回调函数 */
- callback?: OffWaitingCallback
- ): void
- /** [InnerAudioContext.onCanplay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onCanplay.html)
- *
- * 监听音频进入可以播放状态的事件。但不保证后面可以流畅播放 */
- onCanplay(
- /** 音频进入可以播放状态的事件的回调函数 */
- callback: OnCanplayCallback
- ): void
- /** [InnerAudioContext.onEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onEnded.html)
- *
- * 监听音频自然播放至结束的事件 */
- onEnded(
- /** 音频自然播放至结束的事件的回调函数 */
- callback: OnEndedCallback
- ): void
- /** [InnerAudioContext.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onError.html)
- *
- * 监听音频播放错误事件
- *
- * **Tips**
- *
- * 1. errCode=100001 时,如若 errMsg 中有 INNERCODE -11828 ,请先检查 response header 是否缺少 Content-Length
- * 2. errCode=100001 时,如若 errMsg 中有 systemErrCode:200333420,请检查文件编码格式和 fileExtension 是否一致 */
- onError(
- /** 音频播放错误事件的回调函数 */
- callback: InnerAudioContextOnErrorCallback
- ): void
- /** [InnerAudioContext.onPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onPause.html)
- *
- * 监听音频暂停事件 */
- onPause(
- /** 音频暂停事件的回调函数 */
- callback: OnPauseCallback
- ): void
- /** [InnerAudioContext.onPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onPlay.html)
- *
- * 监听音频播放事件 */
- onPlay(
- /** 音频播放事件的回调函数 */
- callback: OnPlayCallback
- ): void
- /** [InnerAudioContext.onSeeked(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onSeeked.html)
- *
- * 监听音频完成跳转操作的事件 */
- onSeeked(
- /** 音频完成跳转操作的事件的回调函数 */
- callback: OnSeekedCallback
- ): void
- /** [InnerAudioContext.onSeeking(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onSeeking.html)
- *
- * 监听音频进行跳转操作的事件 */
- onSeeking(
- /** 音频进行跳转操作的事件的回调函数 */
- callback: OnSeekingCallback
- ): void
- /** [InnerAudioContext.onStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onStop.html)
- *
- * 监听音频停止事件 */
- onStop(
- /** 音频停止事件的回调函数 */
- callback: InnerAudioContextOnStopCallback
- ): void
- /** [InnerAudioContext.onTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onTimeUpdate.html)
- *
- * 监听音频播放进度更新事件 */
- onTimeUpdate(
- /** 音频播放进度更新事件的回调函数 */
- callback: InnerAudioContextOnTimeUpdateCallback
- ): void
- /** [InnerAudioContext.onWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.onWaiting.html)
- *
- * 监听音频加载中事件。当音频因为数据不足,需要停下来加载时会触发 */
- onWaiting(
- /** 音频加载中事件的回调函数 */
- callback: OnWaitingCallback
- ): void
- /** [InnerAudioContext.pause()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.pause.html)
- *
- * 暂停。暂停后的音频再播放会从暂停处开始播放 */
- pause(): void
- /** [InnerAudioContext.play()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.play.html)
- *
- * 播放 */
- play(): void
- /** [InnerAudioContext.seek(number position)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.seek.html)
- *
- * 跳转到指定位置 */
- seek(
- /** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
- position: number
- ): void
- /** [InnerAudioContext.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.stop.html)
- *
- * 停止。停止后的音频再播放会从头开始播放。 */
- stop(): void
- }
- interface InterstitialAd {
- /** [InterstitialAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.destroy.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 销毁插屏广告实例。 */
- destroy(): void
- /** [InterstitialAd.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.offClose.html)
- *
- * 取消监听插屏广告关闭事件 */
- offClose(
- /** 插屏广告关闭事件的回调函数 */
- callback?: UDPSocketOffCloseCallback
- ): void
- /** [InterstitialAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.offError.html)
- *
- * 取消监听插屏错误事件 */
- offError(
- /** 插屏错误事件的回调函数 */
- callback?: InterstitialAdOffErrorCallback
- ): void
- /** [InterstitialAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.offLoad.html)
- *
- * 取消监听插屏广告加载事件 */
- offLoad(
- /** 插屏广告加载事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [InterstitialAd.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.onClose.html)
- *
- * 监听插屏广告关闭事件。 */
- onClose(
- /** 插屏广告关闭事件的回调函数 */
- callback: UDPSocketOnCloseCallback
- ): void
- /** [InterstitialAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.onError.html)
- *
- * 监听插屏错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
- * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
- * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
- * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
- * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
- * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
- onError(
- /** 插屏错误事件的回调函数 */
- callback: InterstitialAdOnErrorCallback
- ): void
- /** [InterstitialAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.onLoad.html)
- *
- * 监听插屏广告加载事件。 */
- onLoad(
- /** 插屏广告加载事件的回调函数 */
- callback: OnLoadCallback
- ): void
- /** [Promise InterstitialAd.load()](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.load.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 加载插屏广告。 */
- load(): Promise<any>
- /** [Promise InterstitialAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/InterstitialAd.show.html)
- *
- * 显示插屏广告。
- *
- * **错误码信息表**
- *
- * 如果插屏广告显示失败,InterstitialAd.show() 方法会返回一个rejected Promise,开发者可以获取到错误码及对应的错误信息。
- *
- * | 代码 | 异常情况 | 理由 |
- * | ------ | -------------- | -------------------------- |
- * | 2001 | 触发频率限制 | 小程序启动一定时间内不允许展示插屏广告 |
- * | 2002 | 触发频率限制 | 距离小程序插屏广告或者激励视频广告上次播放时间间隔不足,不允许展示插屏广告 |
- * | 2003 | 触发频率限制 | 当前正在播放激励视频广告或者插屏广告,不允许再次展示插屏广告 |
- * | 2004 | 广告渲染失败 | 该项错误不是开发者的异常情况,或因小程序页面切换导致广告渲染失败 |
- * | 2005 | 广告调用异常 | 插屏广告实例不允许跨页面调用 | */
- show(): Promise<any>
- }
- interface JoinVoIPChatError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | -1 | 当前已在房间内 | |
- * | -2 | 录音设备被占用,可能是当前正在使用微信内语音通话或系统通话 | |
- * | -3 | 加入会话期间退出(可能是用户主动退出,或者退后台、来电等原因),因此加入失败 | |
- * | -1000 | 系统错误 | | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | -1 | 当前已在房间内 | |
- * | -2 | 录音设备被占用,可能是当前正在使用微信内语音通话或系统通话 | |
- * | -3 | 加入会话期间退出(可能是用户主动退出,或者退后台、来电等原因),因此加入失败 | |
- * | -1000 | 系统错误 | | */ errCode: number
- }
- interface LoadSubpackageTask {
- /** [LoadSubpackageTask.onProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/subpackage/LoadSubpackageTask.onProgressUpdate.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 监听分包加载进度变化事件 */
- onProgressUpdate(
- /** 分包加载进度变化事件的回调函数 */
- callback: LoadSubpackageTaskOnProgressUpdateCallback
- ): void
- }
- interface LogManager {
- /** [LogManager.debug()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.debug.html)
- *
- * 写 debug 日志 */
- debug(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
- ...args: any[]
- ): void
- /** [LogManager.info()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.info.html)
- *
- * 写 info 日志 */
- info(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
- ...args: any[]
- ): void
- /** [LogManager.log()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.log.html)
- *
- * 写 log 日志 */
- log(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
- ...args: any[]
- ): void
- /** [LogManager.warn()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/LogManager.warn.html)
- *
- * 写 warn 日志 */
- warn(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb */
- ...args: any[]
- ): void
- }
- interface MediaAudioPlayer {
- /** [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)
- *
- * 添加音频源 */
- addAudioSource(
- /** [VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html)
- *
- * 视频解码器实例。作为音频源添加到音频播放器中 */
- source: VideoDecoder
- ): Promise<any>
- /** [Promise MediaAudioPlayer.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.destroy.html)
- *
- * 销毁播放器 */
- destroy(): Promise<any>
- /** [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)
- *
- * 移除音频源 */
- removeAudioSource(
- /** [VideoDecoder](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.html)
- *
- * 视频解码器实例 */
- source: VideoDecoder
- ): Promise<any>
- /** [Promise MediaAudioPlayer.start()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.start.html)
- *
- * 启动播放器 */
- start(): Promise<any>
- /** [Promise MediaAudioPlayer.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/MediaAudioPlayer.stop.html)
- *
- * 停止播放器 */
- stop(): Promise<any>
- }
- interface MidasFriendPaymentError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 1000 | | mode错误 |
- * | -15005 | | 索要权限被封禁(索要功能不可用) |
- * | -10073011 | | 参数错误(具体错误见errMsg) |
- * | -10073003 | | outTradeNo业务单号重复 |
- * | -10073012 | | 索要单已支付 |
- * | -10073013 | | 索要单已超时 |
- * | -10073014 | | 签名错误 |
- * | -10073015 | | 索要功能不可用 | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | 1000 | | mode错误 |
- * | -15005 | | 索要权限被封禁(索要功能不可用) |
- * | -10073011 | | 参数错误(具体错误见errMsg) |
- * | -10073003 | | outTradeNo业务单号重复 |
- * | -10073012 | | 索要单已支付 |
- * | -10073013 | | 索要单已超时 |
- * | -10073014 | | 签名错误 |
- * | -10073015 | | 索要功能不可用 | */ errCode: number
- }
- interface MidasPaymentError {
- /** 错误信息
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | -1 | | 系统失败 |
- * | -2 | | 支付取消 |
- * | -15001 | | 虚拟支付接口错误码,缺少参数 |
- * | -15002 | | 虚拟支付接口错误码,参数不合法 |
- * | -15003 | | 虚拟支付接口错误码,订单重复 |
- * | -15004 | | 虚拟支付接口错误码,后台错误 |
- * | -15005 | | 虚拟支付接口错误码,appId权限被封禁 |
- * | -15006 | | 虚拟支付接口错误码,货币类型不支持 |
- * | -15007 | | 虚拟支付接口错误码,订单已支付 |
- * | -15009 | | 虚拟支付接口错误码,由于健康系统限制,本次支付已超过限额(这种错误情况会有默认弹窗提示) |
- * | 1 | | 虚拟支付接口错误码,用户取消支付 |
- * | 2 | | 虚拟支付接口错误码,客户端错误,判断到小程序在用户处于支付中时,又发起了一笔支付请求 |
- * | 3 | | 虚拟支付接口错误码,Android独有错误:用户使用GooglePlay支付,而手机未安装GooglePlay |
- * | 4 | | 虚拟支付接口错误码,用户操作系统支付状态异常 |
- * | 5 | | 虚拟支付接口错误码,操作系统错误 |
- * | 6 | | 虚拟支付接口错误码,其他错误 |
- * | 1000 | | 参数错误 |
- * | 1003 | | 米大师Portal错误 | */ errMsg: string
- /** 错误码
- *
- * | 错误码 | 错误信息 | 说明 |
- * | - | - | - |
- * | -1 | | 系统失败 |
- * | -2 | | 支付取消 |
- * | -15001 | | 虚拟支付接口错误码,缺少参数 |
- * | -15002 | | 虚拟支付接口错误码,参数不合法 |
- * | -15003 | | 虚拟支付接口错误码,订单重复 |
- * | -15004 | | 虚拟支付接口错误码,后台错误 |
- * | -15005 | | 虚拟支付接口错误码,appId权限被封禁 |
- * | -15006 | | 虚拟支付接口错误码,货币类型不支持 |
- * | -15007 | | 虚拟支付接口错误码,订单已支付 |
- * | -15009 | | 虚拟支付接口错误码,由于健康系统限制,本次支付已超过限额(这种错误情况会有默认弹窗提示) |
- * | 1 | | 虚拟支付接口错误码,用户取消支付 |
- * | 2 | | 虚拟支付接口错误码,客户端错误,判断到小程序在用户处于支付中时,又发起了一笔支付请求 |
- * | 3 | | 虚拟支付接口错误码,Android独有错误:用户使用GooglePlay支付,而手机未安装GooglePlay |
- * | 4 | | 虚拟支付接口错误码,用户操作系统支付状态异常 |
- * | 5 | | 虚拟支付接口错误码,操作系统错误 |
- * | 6 | | 虚拟支付接口错误码,其他错误 |
- * | 1000 | | 参数错误 |
- * | 1003 | | 米大师Portal错误 | */ errCode: number
- }
- interface OpenDataContext {
- /** [OpenDataContext.postMessage(Object message)](https://developers.weixin.qq.com/minigame/dev/api/open-api/context/OpenDataContext.postMessage.html)
- *
- * 向开放数据域发送消息 */
- postMessage(
- /** 要发送的消息,message 中及嵌套对象中 key 的 value 只能是 primitive value。即 number、string、boolean、null、undefined。 */
- message: IAnyObject
- ): void
- }
- interface OpenSettingButton {
- /** [OpenSettingButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.destroy.html)
- *
- * 销毁打开设置页面按钮 */
- destroy(): void
- /** [OpenSettingButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.hide.html)
- *
- * 隐藏打开设置页面按钮。 */
- hide(): void
- /** [OpenSettingButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.offTap.html)
- *
- * 取消监听设置页面按钮的点击事件 */
- offTap(
- /** 设置页面按钮的点击事件的回调函数 */
- callback?: GameClubButtonOffTapCallback
- ): void
- /** [OpenSettingButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.onTap.html)
- *
- * 监听设置页面按钮的点击事件 */
- onTap(
- /** 设置页面按钮的点击事件的回调函数 */
- callback: GameClubButtonOnTapCallback
- ): void
- /** [OpenSettingButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/OpenSettingButton.show.html)
- *
- * 显示打开设置页面按钮 */
- show(): void
- }
- interface OpenSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | fail no such file or directory "${filePath}" | 上级目录不存在 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | fail no such file or directory "${filePath}" | 上级目录不存在 | */ errCode: number
- }
- interface Performance {
- /** [number Performance.now()](https://developers.weixin.qq.com/minigame/dev/api/base/performance/Performance.now.html)
- *
- * 可以获取当前时间以微秒为单位的时间戳 */
- now(): number
- }
- interface ReadCompressedFileSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | fail decompress fail | 指定的 compressionAlgorithm 与文件实际压缩格式不符 |
- * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
- * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有读权限 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | fail decompress fail | 指定的 compressionAlgorithm 与文件实际压缩格式不符 |
- * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
- * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有读权限 | */ errCode: number
- }
- interface ReadSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 路径没有读权限 |
- * | fail the value of "offset" is out of range | 传入的 offset 不合法 |
- * | fail the value of "length" is out of range | 传入的 length 不合法 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 路径没有读权限 |
- * | fail the value of "offset" is out of range | 传入的 offset 不合法 |
- * | fail the value of "length" is out of range | 传入的 length 不合法 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
- }
- interface RealtimeLogManager {
- /** [RealtimeLogManager.addFilterMsg(string msg)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.addFilterMsg.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 添加过滤关键字,暂不支持在插件使用 */
- addFilterMsg(
- /** 是setFilterMsg的添加接口。用于设置多个过滤关键字。 */
- msg: string
- ): void
- /** [RealtimeLogManager.error()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.error.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 写 error 日志,暂不支持在插件使用 */
- error(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb */
- ...args: any[]
- ): void
- /** [RealtimeLogManager.info()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.info.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 写 info 日志,暂不支持在插件使用 */
- info(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb */
- ...args: any[]
- ): void
- /** [RealtimeLogManager.setFilterMsg(string msg)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.setFilterMsg.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 设置过滤关键字,暂不支持在插件使用 */
- setFilterMsg(
- /** 过滤关键字,最多不超过1Kb,可以在小程序管理后台根据设置的内容搜索得到对应的日志。 */
- msg: string
- ): void
- /** [RealtimeLogManager.warn()](https://developers.weixin.qq.com/minigame/dev/api/base/debug/RealtimeLogManager.warn.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 写 warn 日志,暂不支持在插件使用 */
- warn(
- /** 日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb */
- ...args: any[]
- ): void
- }
- interface RecorderManager {
- /** [RecorderManager.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onError.html)
- *
- * 监听录音错误事件 */
- onError(
- /** 录音错误事件的回调函数 */
- callback: UDPSocketOnErrorCallback
- ): void
- /** [RecorderManager.onFrameRecorded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onFrameRecorded.html)
- *
- * 监听已录制完指定帧大小的文件事件。如果设置了 frameSize,则会回调此事件。 */
- onFrameRecorded(
- /** 已录制完指定帧大小的文件事件的回调函数 */
- callback: OnFrameRecordedCallback
- ): void
- /** [RecorderManager.onInterruptionBegin(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onInterruptionBegin.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 监听录音因为受到系统占用而被中断开始事件。以下场景会触发此事件:微信语音聊天、微信视频聊天。此事件触发后,录音会被暂停。pause 事件在此事件后触发 */
- onInterruptionBegin(
- /** 录音因为受到系统占用而被中断开始事件的回调函数 */
- callback: OnInterruptionBeginCallback
- ): void
- /** [RecorderManager.onInterruptionEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onInterruptionEnd.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 监听录音中断结束事件。在收到 interruptionBegin 事件之后,小程序内所有录音会暂停,收到此事件之后才可再次录音成功。 */
- onInterruptionEnd(
- /** 录音中断结束事件的回调函数 */
- callback: OnInterruptionEndCallback
- ): void
- /** [RecorderManager.onPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onPause.html)
- *
- * 监听录音暂停事件 */
- onPause(
- /** 录音暂停事件的回调函数 */
- callback: OnPauseCallback
- ): void
- /** [RecorderManager.onResume(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onResume.html)
- *
- * 监听录音继续事件 */
- onResume(
- /** 录音继续事件的回调函数 */
- callback: OnResumeCallback
- ): void
- /** [RecorderManager.onStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onStart.html)
- *
- * 监听录音开始事件 */
- onStart(
- /** 录音开始事件的回调函数 */
- callback: OnStartCallback
- ): void
- /** [RecorderManager.onStop(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.onStop.html)
- *
- * 监听录音结束事件 */
- onStop(
- /** 录音结束事件的回调函数 */
- callback: RecorderManagerOnStopCallback
- ): void
- /** [RecorderManager.pause()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.pause.html)
- *
- * 暂停录音 */
- pause(): void
- /** [RecorderManager.resume()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.resume.html)
- *
- * 继续录音 */
- resume(): void
- /** [RecorderManager.start(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.start.html)
- *
- * 开始录音
- *
- * **采样率与编码码率限制**
- *
- * 每种采样率有对应的编码码率范围有效值,设置不合法的采样率或编码码率会导致录音失败,具体对应关系如下表。
- *
- * | 采样率 | 编码码率 |
- * | ------ | -------------- |
- * | 8000 | 16000 ~ 48000 |
- * | 11025 | 16000 ~ 48000 |
- * | 12000 | 24000 ~ 64000 |
- * | 16000 | 24000 ~ 96000 |
- * | 22050 | 32000 ~ 128000 |
- * | 24000 | 32000 ~ 128000 |
- * | 32000 | 48000 ~ 192000 |
- * | 44100 | 64000 ~ 320000 |
- * | 48000 | 64000 ~ 320000 | */
- start(option: RecorderManagerStartOption): void
- /** [RecorderManager.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.stop.html)
- *
- * 停止录音 */
- stop(): void
- }
- interface RequestTask {
- /** [RequestTask.abort()](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.abort.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 中断请求任务 */
- abort(): void
- /** [RequestTask.offChunkReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.offChunkReceived.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 取消监听 Transfer-Encoding Chunk Received 事件 */
- offChunkReceived(
- /** Transfer-Encoding Chunk Received 事件的回调函数 */
- callback?: OffChunkReceivedCallback
- ): void
- /** [RequestTask.offHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.offHeadersReceived.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 取消监听 HTTP Response Header 事件 */
- offHeadersReceived(
- /** HTTP Response Header 事件的回调函数 */
- callback?: OffHeadersReceivedCallback
- ): void
- /** [RequestTask.onChunkReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.onChunkReceived.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。 */
- onChunkReceived(
- /** Transfer-Encoding Chunk Received 事件的回调函数 */
- callback: OnChunkReceivedCallback
- ): void
- /** [RequestTask.onHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/request/RequestTask.onHeadersReceived.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 监听 HTTP Response Header 事件。会比请求完成事件更早 */
- onHeadersReceived(
- /** HTTP Response Header 事件的回调函数 */
- callback: OnHeadersReceivedCallback
- ): void
- }
- interface RewardedVideoAd {
- /** [Promise RewardedVideoAd.load()](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.load.html)
- *
- * 加载激励视频广告。 */
- load(): Promise<any>
- /** [Promise RewardedVideoAd.show()](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.show.html)
- *
- * 显示激励视频广告。激励视频广告将从屏幕下方推入。 */
- show(): Promise<any>
- /** [RewardedVideoAd.destroy()](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.destroy.html)
- *
- * 需要基础库: `2.8.0`
- *
- * 销毁激励视频广告实例。 */
- destroy(): void
- /** [RewardedVideoAd.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.offClose.html)
- *
- * 取消监听用户点击 `关闭广告` 按钮的事件 */
- offClose(
- /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
- callback?: RewardedVideoAdOffCloseCallback
- ): void
- /** [RewardedVideoAd.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.offError.html)
- *
- * 取消监听激励视频错误事件 */
- offError(
- /** 激励视频错误事件的回调函数 */
- callback?: BannerAdOffErrorCallback
- ): void
- /** [RewardedVideoAd.offLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.offLoad.html)
- *
- * 取消监听激励视频广告加载事件 */
- offLoad(
- /** 激励视频广告加载事件的回调函数 */
- callback?: OffLoadCallback
- ): void
- /** [RewardedVideoAd.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.onClose.html)
- *
- * 监听用户点击 `关闭广告` 按钮的事件。 */
- onClose(
- /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
- callback: RewardedVideoAdOnCloseCallback
- ): void
- /** [RewardedVideoAd.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.onError.html)
- *
- * 监听激励视频错误事件。
- *
- * **错误码信息与解决方案表**
- *
- * 错误码是通过onError获取到的错误信息。调试期间,可以通过异常返回来捕获信息。
- * 在小程序发布上线之后,如果遇到异常问题,可以在[“运维中心“](https://mp.weixin.qq.com/)里面搜寻错误日志,还可以针对异常返回加上适当的监控信息。
- *
- * | 代码 | 异常情况 | 理由 | 解决方案 |
- * | ------ | -------------- | --------------- | -------------------------- |
- * | 1000 | 后端错误调用失败 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。 |
- * | 1001 | 参数错误 | 使用方法错误 | 可以前往developers.weixin.qq.com确认具体教程(小程序和小游戏分别有各自的教程,可以在顶部选项中,“设计”一栏的右侧进行切换。|
- * | 1002 | 广告单元无效 | 可能是拼写错误、或者误用了其他APP的广告ID | 请重新前往mp.weixin.qq.com确认广告位ID。 |
- * | 1003 | 内部错误 | 该项错误不是开发者的异常情况 | 一般情况下忽略一段时间即可恢复。|
- * | 1004 | 无适合的广告 | 广告不是每一次都会出现,这次没有出现可能是由于该用户不适合浏览广告 | 属于正常情况,且开发者需要针对这种情况做形态上的兼容。 |
- * | 1005 | 广告组件审核中 | 你的广告正在被审核,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1006 | 广告组件被驳回 | 你的广告审核失败,无法展现广告 | 请前往mp.weixin.qq.com确认审核状态,且开发者需要针对这种情况做形态上的兼容。|
- * | 1007 | 广告组件被驳回 | 你的广告能力已经被封禁,封禁期间无法展现广告 | 请前往mp.weixin.qq.com确认小程序广告封禁状态。 |
- * | 1008 | 广告单元已关闭 | 该广告位的广告能力已经被关闭 | 请前往mp.weixin.qq.com重新打开对应广告位的展现。| */
- onError(
- /** 激励视频错误事件的回调函数 */
- callback: BannerAdOnErrorCallback
- ): void
- /** [RewardedVideoAd.onLoad(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ad/RewardedVideoAd.onLoad.html)
- *
- * 监听激励视频广告加载事件。 */
- onLoad(
- /** 激励视频广告加载事件的回调函数 */
- callback: OnLoadCallback
- ): void
- }
- interface SocketTask {
- /** [SocketTask.close(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.close.html)
- *
- * 关闭 WebSocket 连接 */
- close(option: SocketTaskCloseOption): void
- /** [SocketTask.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onClose.html)
- *
- * 监听 WebSocket 连接关闭事件 */
- onClose(
- /** WebSocket 连接关闭事件的回调函数 */
- callback: SocketTaskOnCloseCallback
- ): void
- /** [SocketTask.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onError.html)
- *
- * 监听 WebSocket 错误事件 */
- onError(
- /** WebSocket 错误事件的回调函数 */
- callback: UDPSocketOnErrorCallback
- ): void
- /** [SocketTask.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onMessage.html)
- *
- * 监听 WebSocket 接受到服务器的消息事件 */
- onMessage(
- /** WebSocket 接受到服务器的消息事件的回调函数 */
- callback: SocketTaskOnMessageCallback
- ): void
- /** [SocketTask.onOpen(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.onOpen.html)
- *
- * 监听 WebSocket 连接打开事件 */
- onOpen(
- /** WebSocket 连接打开事件的回调函数 */
- callback: OnOpenCallback
- ): void
- /** [SocketTask.send(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.send.html)
- *
- * 通过 WebSocket 连接发送数据 */
- send(option: SocketTaskSendOption): void
- }
- interface Stats {
- /** [boolean Stats.isDirectory()](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.isDirectory.html)
- *
- * 判断当前文件是否一个目录 */
- isDirectory(): boolean
- /** [boolean Stats.isFile()](https://developers.weixin.qq.com/minigame/dev/api/file/Stats.isFile.html)
- *
- * 判断当前文件是否一个普通文件 */
- isFile(): boolean
- }
- interface TruncateSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
- * | fail illegal operation on a directory, open "${filePath}" | 指定的 filePath 是一个已经存在的目录 |
- * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有写权限 |
- * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | fail no such file or directory, open ${filePath} | 指定的 filePath 所在目录不存在 |
- * | fail illegal operation on a directory, open "${filePath}" | 指定的 filePath 是一个已经存在的目录 |
- * | fail permission denied, open ${dirPath} | 指定的 filePath 路径没有写权限 |
- * | fail the maximum size of the file storage limit is exceeded | 存储空间不足 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
- }
- interface UDPSocket {
- /** [UDPSocket.close()](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.close.html)
- *
- * 关闭 UDP Socket 实例,相当于销毁。 在关闭之后,UDP Socket 实例不能再发送消息,每次调用 `UDPSocket.send` 将会触发错误事件,并且 message 事件回调函数也不会再也执行。在 `UDPSocket` 实例被创建后将被 Native 强引用,保证其不被 GC。在 `UDPSocket.close` 后将解除对其的强引用,让 UDPSocket 实例遵从 GC。 */
- close(): void
- /** [UDPSocket.connect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.connect.html)
- *
- * 需要基础库: `2.15.0`
- *
- * 预先连接到指定的 IP 和 port,需要配合 write 方法一起使用 */
- connect(option: ConnectOption): void
- /** [UDPSocket.offClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offClose.html)
- *
- * 取消监听关闭事件 */
- offClose(
- /** 关闭事件的回调函数 */
- callback?: UDPSocketOffCloseCallback
- ): void
- /** [UDPSocket.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offError.html)
- *
- * 取消监听错误事件 */
- offError(
- /** 错误事件的回调函数 */
- callback?: UDPSocketOffErrorCallback
- ): void
- /** [UDPSocket.offListening(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offListening.html)
- *
- * 取消监听开始监听数据包消息的事件 */
- offListening(
- /** 开始监听数据包消息的事件的回调函数 */
- callback?: OffListeningCallback
- ): void
- /** [UDPSocket.offMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.offMessage.html)
- *
- * 取消监听收到消息的事件 */
- offMessage(
- /** 收到消息的事件的回调函数 */
- callback?: OffMessageCallback
- ): void
- /** [UDPSocket.onClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onClose.html)
- *
- * 监听关闭事件 */
- onClose(
- /** 关闭事件的回调函数 */
- callback: UDPSocketOnCloseCallback
- ): void
- /** [UDPSocket.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onError.html)
- *
- * 监听错误事件 */
- onError(
- /** 错误事件的回调函数 */
- callback: UDPSocketOnErrorCallback
- ): void
- /** [UDPSocket.onListening(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onListening.html)
- *
- * 监听开始监听数据包消息的事件 */
- onListening(
- /** 开始监听数据包消息的事件的回调函数 */
- callback: OnListeningCallback
- ): void
- /** [UDPSocket.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.onMessage.html)
- *
- * 监听收到消息的事件 */
- onMessage(
- /** 收到消息的事件的回调函数 */
- callback: UDPSocketOnMessageCallback
- ): void
- /** [UDPSocket.send(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.send.html)
- *
- * 向指定的 IP 和 port 发送消息。基础库 2.9.0 起支持广播 (指定地址为 255.255.255.255)。 */
- send(option: UDPSocketSendOption): void
- /** [UDPSocket.setTTL(number ttl)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.setTTL.html)
- *
- * 需要基础库: `2.18.0`
- *
- * 设置 IP_TTL 套接字选项,用于设置一个 IP 数据包传输时允许的最大跳步数 */
- setTTL(
- /** ttl 参数可以是 0 到 255 之间 */
- ttl: number
- ): void
- /** [UDPSocket.write()](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.write.html)
- *
- * 需要基础库: `2.15.0`
- *
- * 用法与 send 方法相同,如果没有预先调用 connect 则与 send 无差异(注意即使调用了 connect 也需要在本接口填入地址和端口参数) */
- write(): void
- /** [number UDPSocket.bind(number port)](https://developers.weixin.qq.com/minigame/dev/api/network/udp/UDPSocket.bind.html)
- *
- * 绑定一个系统随机分配的可用端口,或绑定一个指定的端口号 */
- bind(
- /** 需要基础库: `2.9.0`
- *
- * 指定要绑定的端口号,不传则返回系统随机分配的可用端口 */
- port?: number
- ): number
- }
- interface UpdateManager {
- /** [UpdateManager.applyUpdate()](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.applyUpdate.html)
- *
- * 强制小程序重启并使用新版本。在小程序新版本下载完成后(即收到 `onUpdateReady` 回调)调用。
- *
- * **示例代码**
- *
- * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
- applyUpdate(): void
- /** [UpdateManager.onCheckForUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.onCheckForUpdate.html)
- *
- * 监听向微信后台请求检查更新结果事件。微信在小程序冷启动时自动检查更新,不需由开发者主动触发。
- *
- * **示例代码**
- *
- * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
- onCheckForUpdate(
- /** 向微信后台请求检查更新结果事件的回调函数 */
- callback: OnCheckForUpdateCallback
- ): void
- /** [UpdateManager.onUpdateFailed(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.onUpdateFailed.html)
- *
- * 监听小程序更新失败事件。小程序有新版本,客户端主动触发下载(无需开发者触发),下载失败(可能是网络原因等)后回调
- *
- * **示例代码**
- *
- * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
- onUpdateFailed(
- /** 小程序更新失败事件的回调函数 */
- callback: OnUpdateFailedCallback
- ): void
- /** [UpdateManager.onUpdateReady(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.onUpdateReady.html)
- *
- * 监听小程序有版本更新事件。客户端主动触发下载(无需开发者触发),下载成功后回调
- *
- * **示例代码**
- *
- * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
- onUpdateReady(
- /** 小程序有版本更新事件的回调函数 */
- callback: OnUpdateReadyCallback
- ): void
- }
- interface UploadTask {
- /** [UploadTask.abort()](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.abort.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 中断上传任务 */
- abort(): void
- /** [UploadTask.offHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.offHeadersReceived.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 取消监听 HTTP Response Header 事件 */
- offHeadersReceived(
- /** HTTP Response Header 事件的回调函数 */
- callback?: OffHeadersReceivedCallback
- ): void
- /** [UploadTask.offProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.offProgressUpdate.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 取消监听上传进度变化事件 */
- offProgressUpdate(
- /** 上传进度变化事件的回调函数 */
- callback?: UploadTaskOffProgressUpdateCallback
- ): void
- /** [UploadTask.onHeadersReceived(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.onHeadersReceived.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 监听 HTTP Response Header 事件。会比请求完成事件更早 */
- onHeadersReceived(
- /** HTTP Response Header 事件的回调函数 */
- callback: OnHeadersReceivedCallback
- ): void
- /** [UploadTask.onProgressUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/upload/UploadTask.onProgressUpdate.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 监听上传进度变化事件 */
- onProgressUpdate(
- /** 上传进度变化事件的回调函数 */
- callback: UploadTaskOnProgressUpdateCallback
- ): void
- }
- interface UserCryptoManager {
- /** [UserCryptoManager.getLatestUserKey(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/crypto/UserCryptoManager.getLatestUserKey.html)
- *
- * 需要基础库: `2.17.3`
- *
- * 获取最新的用户加密密钥
- *
- * **示例代码**
- *
- * ```js
- const userCryptoManager = wx.getUserCryptoManager()
- userCryptoManager.getLatestUserKey({
- success: res => {
- const {encryptKey, iv, version, expireTime} = res
- console.log(encryptKey, iv, version, expireTime)
- }
- })
- ``` */
- getLatestUserKey(option?: GetLatestUserKeyOption): void
- /** [UserCryptoManager.getRandomValues(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/crypto/UserCryptoManager.getRandomValues.html)
- *
- * 需要基础库: `2.17.3`
- *
- * 获取密码学安全随机数
- *
- * **示例代码**
- *
- * ```js
- wx.getRandomValues({
- length: 6 // 生成 6 个字节长度的随机数,
- success: res => {
- console.log(wx.arrayBufferToBase64(res.randomValues)) // 转换为 base64 字符串后打印
- }
- })
- ``` */
- getRandomValues(option: GetRandomValuesOption): void
- }
- interface UserInfoButton {
- /** [UserInfoButton.destroy()](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.destroy.html)
- *
- * 销毁用户信息按钮 */
- destroy(): void
- /** [UserInfoButton.hide()](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.hide.html)
- *
- * 隐藏用户信息按钮。 */
- hide(): void
- /** [UserInfoButton.offTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.offTap.html)
- *
- * 取消监听用户信息按钮的点击事件 */
- offTap(
- /** 用户信息按钮的点击事件的回调函数 */
- callback?: UserInfoButtonOffTapCallback
- ): void
- /** [UserInfoButton.onTap(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.onTap.html)
- *
- * 监听用户信息按钮的点击事件 */
- onTap(
- /** 用户信息按钮的点击事件的回调函数 */
- callback: UserInfoButtonOnTapCallback
- ): void
- /** [UserInfoButton.show()](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/UserInfoButton.show.html)
- *
- * 显示用户信息按钮 */
- show(): void
- }
- interface Video {
- /** [Promise Video.exitFullScreen()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.exitFullScreen.html)
- *
- * 视频退出全屏 */
- exitFullScreen(): Promise<any>
- /** [Promise Video.pause()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.pause.html)
- *
- * 暂停视频 */
- pause(): Promise<any>
- /** [Promise Video.play()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.play.html)
- *
- * 播放视频 */
- play(): Promise<any>
- /** [Promise Video.requestFullScreen(number direction)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.requestFullScreen.html)
- *
- * 视频全屏 */
- requestFullScreen(
- /** 设置全屏时视频的方向
- *
- * 参数 direction 可选值:
- * - 0: 正常竖向;
- * - 90: 屏幕逆时针90度;
- * - -90: 屏幕顺时针90度; */
- direction: 0 | 90 | -90
- ): Promise<any>
- /** [Promise Video.seek(number time)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.seek.html)
- *
- * 视频跳转 */
- seek(
- /** 视频跳转到指定位置,单位为 s 秒 */
- time: number
- ): Promise<any>
- /** [Promise Video.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.stop.html)
- *
- * 停止视频 */
- stop(): Promise<any>
- /** [Video.destroy()](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.destroy.html)
- *
- * 销毁视频 */
- destroy(): void
- /** [Video.offEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offEnded.html)
- *
- * 取消监听视频播放到末尾事件 */
- offEnded(
- /** 视频播放到末尾事件的回调函数 */
- callback?: OffEndedCallback
- ): void
- /** [Video.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offError.html)
- *
- * 取消监听视频错误事件 */
- offError(
- /** 视频错误事件的回调函数 */
- callback?: VideoOffErrorCallback
- ): void
- /** [Video.offPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offPause.html)
- *
- * 取消监听视频暂停事件 */
- offPause(
- /** 视频暂停事件的回调函数 */
- callback?: OffPauseCallback
- ): void
- /** [Video.offPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offPlay.html)
- *
- * 取消监听视频播放事件 */
- offPlay(
- /** 视频播放事件的回调函数 */
- callback?: OffPlayCallback
- ): void
- /** [Video.offProgress(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offProgress.html)
- *
- * 取消监听视频下载(缓冲)事件 */
- offProgress(
- /** 视频下载(缓冲)事件的回调函数 */
- callback?: OffProgressCallback
- ): void
- /** [Video.offTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offTimeUpdate.html)
- *
- * 取消监听视频播放进度更新事件 */
- offTimeUpdate(
- /** 视频播放进度更新事件的回调函数 */
- callback?: VideoOffTimeUpdateCallback
- ): void
- /** [Video.offWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.offWaiting.html)
- *
- * 取消监听视频由于需要缓冲下一帧而停止时触发 */
- offWaiting(
- /** 的回调函数 */
- callback?: OffWaitingCallback
- ): void
- /** [Video.onEnded(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onEnded.html)
- *
- * 监听视频播放到末尾事件 */
- onEnded(
- /** 视频播放到末尾事件的回调函数 */
- callback: OnEndedCallback
- ): void
- /** [Video.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onError.html)
- *
- * 监听视频错误事件 */
- onError(
- /** 视频错误事件的回调函数 */
- callback: VideoOnErrorCallback
- ): void
- /** [Video.onPause(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onPause.html)
- *
- * 监听视频暂停事件 */
- onPause(
- /** 视频暂停事件的回调函数 */
- callback: OnPauseCallback
- ): void
- /** [Video.onPlay(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onPlay.html)
- *
- * 监听视频播放事件 */
- onPlay(
- /** 视频播放事件的回调函数 */
- callback: OnPlayCallback
- ): void
- /** [Video.onProgress(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onProgress.html)
- *
- * 监听视频下载(缓冲)事件 */
- onProgress(
- /** 视频下载(缓冲)事件的回调函数 */
- callback: OnProgressCallback
- ): void
- /** [Video.onTimeUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onTimeUpdate.html)
- *
- * 监听视频播放进度更新事件 */
- onTimeUpdate(
- /** 视频播放进度更新事件的回调函数 */
- callback: VideoOnTimeUpdateCallback
- ): void
- /** [Video.onWaiting(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video/Video.onWaiting.html)
- *
- * 监听视频由于需要缓冲下一帧而停止时触发 */
- onWaiting(
- /** 的回调函数 */
- callback: OnWaitingCallback
- ): void
- }
- interface VideoDecoder {
- /** [Object VideoDecoder.getFrameData()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.getFrameData.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 获取下一帧的解码数据 */
- getFrameData(): FrameDataOptions
- /** [Promise VideoDecoder.remove()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.remove.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 移除解码器 */
- remove(): Promise<any>
- /** [Promise VideoDecoder.seek(number position)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.seek.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 跳到某个时间点解码 */
- seek(
- /** 跳转的解码位置,单位 ms */
- position: number
- ): Promise<any>
- /** [Promise VideoDecoder.start(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.start.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 开始解码 */
- start(option: VideoDecoderStartOption): Promise<any>
- /** [Promise VideoDecoder.stop()](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.stop.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 停止解码 */
- stop(): Promise<any>
- /** [VideoDecoder.off(string eventName, function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.off.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 取消监听录制事件。当对应事件触发时,该回调函数不再执行 */
- off(
- /** 事件名 */
- eventName: string,
- /** 事件触发时执行的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [VideoDecoder.on(string eventName, function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/video-decoder/VideoDecoder.on.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 注册监听录制事件的回调函数。当对应事件触发时,回调函数会被执行 */
- on(
- /** 事件名
- *
- * 参数 eventName 可选值:
- * - 'start': 开始事件。返回 {width, height};
- * - 'stop': 结束事件。;
- * - 'seek': seek 完成事件。;
- * - 'bufferchange': 缓冲区变化事件。;
- * - 'ended': 解码结束事件。; */
- eventName: 'start' | 'stop' | 'seek' | 'bufferchange' | 'ended',
- /** 事件触发时执行的回调函数 */
- callback: (...args: any[]) => any
- ): void
- }
- interface WebAudioContext {
- /** [BiquadFilterNode WebAudioContext.createBiquadFilter()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createBiquadFilter.html)
- *
- * 创建一个BiquadFilterNode */
- createBiquadFilter(): BiquadFilterNode
- /** [BufferSourceNode WebAudioContext.createBufferSource()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createBufferSource.html)
- *
- * 创建一个BufferSourceNode实例,通过AudioBuffer对象来播放音频数据。 */
- createBufferSource(): BufferSourceNode
- /** [ChannelMergerNode WebAudioContext.createChannelMerger(number numberOfInputs)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createChannelMerger.html)
- *
- * 创建一个ChannelMergerNode */
- createChannelMerger(
- /** 输出流中需要保持的输入流的个数 */
- numberOfInputs: number
- ): ChannelMergerNode
- /** [ChannelSplitterNode WebAudioContext.createChannelSplitter(number numberOfOutputs)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createChannelSplitter.html)
- *
- * 创建一个ChannelSplitterNode */
- createChannelSplitter(
- /** 要分别输出的输入音频流中的通道数 */
- numberOfOutputs: number
- ): ChannelSplitterNode
- /** [ConstantSourceNode WebAudioContext.createConstantSource()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createConstantSource.html)
- *
- * 创建一个ConstantSourceNode */
- createConstantSource(): ConstantSourceNode
- /** [DelayNode WebAudioContext.createDelay(number maxDelayTime)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createDelay.html)
- *
- * 创建一个DelayNode */
- createDelay(
- /** 最大延迟时间 */
- maxDelayTime: number
- ): DelayNode
- /** [DynamicsCompressorNode WebAudioContext.createDynamicsCompressor()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createDynamicsCompressor.html)
- *
- * 创建一个DynamicsCompressorNode */
- createDynamicsCompressor(): DynamicsCompressorNode
- /** [GainNode WebAudioContext.createGain()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createGain.html)
- *
- * 创建一个GainNode */
- createGain(): GainNode
- /** [IIRFilterNode WebAudioContext.createIIRFilter(Array.<number> feedforward, Array.<number> feedback)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createIIRFilter.html)
- *
- * 创建一个IIRFilterNode */
- createIIRFilter(
- /** 一个浮点值数组,指定IIR滤波器传递函数的前馈(分子)系数。 */
- feedforward: number[],
- /** 一个浮点值数组,指定IIR滤波器传递函数的反馈(分母)系数。 */
- feedback: number[]
- ): IIRFilterNode
- /** [OscillatorNode WebAudioContext.createOscillator()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createOscillator.html)
- *
- * 创建一个OscillatorNode */
- createOscillator(): OscillatorNode
- /** [PannerNode WebAudioContext.createPanner()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createPanner.html)
- *
- * 创建一个PannerNode */
- createPanner(): PannerNode
- /** [PeriodicWaveNode WebAudioContext.createPeriodicWave(Float32Array real, Float32Array imag, object constraints)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createPeriodicWave.html)
- *
- * 创建一个PeriodicWaveNode
- *
- * **注意**
- *
- * `real`和`imag`数组必须拥有一样的长度,否则抛出错误
- * ```js
- const real = new Float32Array(2)
- const imag = new Float32Array(2)
- real[0] = 0
- imag[0] = 0
- real[1] = 1
- imag[1] = 0
- const waveNode = audioContext.createPeriodicWave(real, imag, {disableNormalization: true})
- ``` */
- createPeriodicWave(
- /** 一组余弦项(传统上是A项) */
- real: Float32Array,
- /** 一组余弦项(传统上是A项) */
- imag: Float32Array,
- /** 一个字典对象,它指定是否应该禁用规范化(默认启用规范化) */
- constraints: Constraints
- ): PeriodicWaveNode
- /** [Promise WebAudioContext.close()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.close.html)
- *
- * 关闭WebAudioContext
- *
- * **注意事项**
- *
- * 同步关闭对应的WebAudio上下文。close后会立即释放当前上下文的资源,<b>不要在close后再次访问state属性。</b>
- * ```js
- const audioCtx = wx.createWebAudioContext()
- audioCtx.close().then(() => {
- console.log(audioCtx.state) // bad case:不应该在close后再访问state
- })
- ``` */
- close(): Promise<any>
- /** [Promise WebAudioContext.resume()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.resume.html)
- *
- * 同步恢复已经被暂停的WebAudioContext上下文 */
- resume(): Promise<any>
- /** [Promise WebAudioContext.suspend()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.suspend.html)
- *
- * 同步暂停WebAudioContext上下文 */
- suspend(): Promise<any>
- /** [ScriptProcessorNode WebAudioContext.createScriptProcessor(number bufferSize, number numberOfInputChannels, number numberOfOutputChannels)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createScriptProcessor.html)
- *
- * 创建一个ScriptProcessorNode */
- createScriptProcessor(
- /** 缓冲区大小,以样本帧为单位 */
- bufferSize: number,
- /** 用于指定输入node的声道的数量 */
- numberOfInputChannels: number,
- /** 用于指定输出node的声道的数量 */
- numberOfOutputChannels: number
- ): ScriptProcessorNode
- /** [WaveShaperNode WebAudioContext.createWaveShaper()](https://developers.weixin.qq.com/minigame/dev/api/media/audio/WebAudioContext.createWaveShaper.html)
- *
- * 创建一个WaveShaperNode */
- createWaveShaper(): WaveShaperNode
- /** [[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)
- *
- * 创建一个AudioBuffer,代表着一段驻留在内存中的短音频 */
- createBuffer(
- /** 定义了 buffer 中包含的声频通道数量的整数 */
- numOfChannels: number,
- /** 代表 buffer 中的样本帧数的整数 */
- length: number,
- /** 线性音频样本的采样率,即每一秒包含的关键帧的个数 */
- sampleRate: number
- ): AudioBuffer
- /** [[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)
- *
- * 异步解码一段资源为AudioBuffer。 */
- decodeAudioData(): AudioBuffer
- }
- interface WebGLRenderingContext {
- /** [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)
- *
- * 需要基础库: `2.0.0`
- *
- * 将一个 Canvas 对应的 Texture 绑定到 WebGL 上下文。
- * - 仅 iOS 支持 wxBindCanvasTexture 接口,其他平台可使用示例代码中的替代方法
- *
- * **示例代码**
- *
- * 使用 wxBindCanvasTexture
- *
- * ```javascript
- gl.wxBindCanvasTexture(gl.TEXTURE_2D, canvas)
- ```
- * 等同于
- *
- * ```javascript
- const texture = gl.createTexture()
- gl.bindTexture(gl.TEXTURE_2D, texture)
- // ......
- gl.texImage2D(target, level, internalformat, format, type, canvas)
- ``` */
- wxBindCanvasTexture(
- /** WebGL 的纹理类型枚举值 */
- texture: number,
- /** [Canvas](https://developers.weixin.qq.com/minigame/dev/api/render/canvas/Canvas.html)
- *
- * 需要绑定为 Texture 的 Canvas */
- canvas: Canvas
- ): void
- }
- interface Worker {
- /** [Worker.getCameraFrameData()](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.getCameraFrameData.html)
- *
- * 获取摄像头当前帧图像,返回ArrayBuffer数据。仅限在 worker 线程中使用。
- * ## 注意事项
- * - 接口仅在小游戏中可用
- * - 接口仅在 iOS 上可用
- * - 接口仅在 worker 线程中可用
- * - 接口仅在 useExperimentalWorker 为 true 时可用
- * - 使用前需要先在主线程调用 Camera.listenFrameChange(worker)
- * - 该接口的目的是借助 iOS ExperimentalWorker 的JS高运行性能,配合摄像头帧数据实现 VR 游戏场景
- * - 由于安卓主线程本身已经支持JIT,因此安卓上可以直接在主线程使用 Camera.onCameraFrame 接口实现 VR 场景
- *
- * **示例代码**
- *
- * ```js
- // game.js
- const worker = wx.createWorker('workers/index.js', {
- useExperimentalWorker: true
- })
- const camera = wx.createCamera({
- success() {
- camera.listenFrameChange(worker)
- }
- })
- ```
- *
- * ```js
- // workers/index.js
- const data = worker.getCameraFrameData()
- console.log(data)
- ``` */
- getCameraFrameData(): void
- /** [Worker.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.onMessage.html)
- *
- * 监听主线程/Worker 线程向当前线程发送的消息的事件。 */
- onMessage(
- /** 主线程/Worker 线程向当前线程发送的消息的事件的回调函数 */
- callback: WorkerOnMessageCallback
- ): void
- /** [Worker.onProcessKilled(function callback)](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.onProcessKilled.html)
- *
- * 监听 worker线程被系统回收事件(当iOS系统资源紧张时,worker线程存在被系统回收的可能,开发者可监听此事件并重新创建一个worker)。仅限在主线程 worker 对象上调用。 */
- onProcessKilled(
- /** worker线程被系统回收事件的回调函数 */
- callback: OnProcessKilledCallback
- ): void
- /** [Worker.postMessage(Object message)](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.postMessage.html)
- *
- * 向主线程/Worker 线程发送的消息。
- *
- * **示例代码**
- *
- * worker 线程中
- * ```js
- worker.postMessage({
- msg: 'hello from worker'
- })
- ```
- *
- * 主线程中
- * ```js
- const worker = wx.createWorker('workers/request/index.js')
- worker.postMessage({
- msg: 'hello from main'
- })
- ```
- *
- * **提醒**
- *
- * 在基础库版本2.20.2之前,postMessage仅支持传递可序列化的key-value对象。
- * 在基础库2.20.2之后,postMessage支持传递任意类型的数据。 */
- postMessage(
- /** 需要发送的消息。 */
- message: IAnyObject
- ): void
- /** [Worker.terminate()](https://developers.weixin.qq.com/minigame/dev/api/worker/Worker.terminate.html)
- *
- * 结束当前 Worker 线程。仅限在主线程 worker 对象上调用。 */
- terminate(): void
- }
- interface WriteSyncError {
- /** 错误信息
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 路径没有写权限 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errMsg: string
- /** 错误码
- *
- * | 错误信息 | 说明 |
- * | - | - |
- * | bad file descriptor | 无效的文件描述符 |
- * | fail permission denied | 指定的 fd 路径没有写权限 |
- * | fail sdcard not mounted | android sdcard 挂载失败 | */ errCode: number
- }
- interface Wx {
- /** [ArrayBuffer wx.encode(Object object)](https://developers.weixin.qq.com/minigame/dev/api/util/wx.encode.html)
- *
- * 将字符串按照指定的编码格式编码成 ArrayBuffer */
- encode(option: EncodeOption): ArrayBuffer
- /** [Boolean wx.setHandoffQuery(String query)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.setHandoffQuery.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 设置接力参数,该接口需要在游戏域调用 */
- setHandoffQuery(
- /** 需要传递给接力设备的参数,格式 为querystring */
- query: string
- ): boolean
- /** [Object wx.getAccountInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/open-api/account-info/wx.getAccountInfoSync.html)
- *
- * 需要基础库: `2.11.2`
- *
- * 获取当前帐号信息。线上小程序版本号仅支持在正式版小程序中获取,开发版和体验版中无法获取。
- *
- * **示例代码**
- *
- * ```js
- const accountInfo = wx.getAccountInfoSync();
- console.log(accountInfo.miniProgram.appId) // 小程序 appId
- console.log(accountInfo.plugin.appId) // 插件 appId
- console.log(accountInfo.plugin.version) // 插件版本号, 'a.b.c' 这样的形式
- ``` */
- getAccountInfoSync(): AccountInfo
- /** [Object wx.getBatteryInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfoSync.html)
- *
- * [wx.getBatteryInfo](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfo.html) 的同步版本 */
- getBatteryInfoSync(): GetBatteryInfoSyncResult
- /** [Object wx.getEnterOptionsSync()](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.getEnterOptionsSync.html)
- *
- * 需要基础库: `2.13.2`
- *
- * 获取小游戏打开的参数(包括冷启动和热启动)
- *
- * **返回有效 referrerInfo 的场景**
- *
- * | 场景值 | 场景 | appId含义 |
- * | ------ | ------------------------------- | ---------- |
- * | 1020 | 公众号 profile 页相关小程序列表 | 来源公众号 |
- * | 1035 | 公众号自定义菜单 | 来源公众号 |
- * | 1036 | App 分享消息卡片 | 来源App |
- * | 1037 | 小程序打开小程序 | 来源小程序 |
- * | 1038 | 从另一个小程序返回 | 来源小程序 |
- * | 1043 | 公众号模板消息 | 来源公众号 |
- *
- * **注意**
- *
- * 部分版本在无`referrerInfo`的时候会返回 `undefined`,建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 */
- getEnterOptionsSync(): EnterOptionsGame
- /** [Object wx.getExptInfoSync(Array.<string> keys)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.getExptInfoSync.html)
- *
- * 需要基础库: `2.17.0`
- *
- * 给定实验参数数组,获取对应的实验参数值
- *
- * **提示**
- *
- * 假设实验参数有 `color`, `size`
- * 调用 wx.getExptInfoSync() 会返回 `{color:'#fff',size:20}` 类似的结果
- * 而 wx.getExptInfoSync(['color']) 则只会返回 `{color:'#fff'}` */
- getExptInfoSync(
- /** 实验参数数组,不填则获取所有实验参数 */
- keys?: string[]
- ): IAnyObject
- /** [Object wx.getExtConfigSync()](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfigSync.html)
- *
- * 需要基础库: `2.8.3`
- *
- * [wx.getExtConfig](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfig.html) 的同步版本。
- *
- * **Tips**
- *
- * 1. 本接口暂时无法通过 [wx.canIUse](#) 判断是否兼容,开发者需要自行判断 [wx.getExtConfigSync](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfigSync.html) 是否存在来兼容
- *
- * ****
- *
- * ```js
- let extConfig = wx.getExtConfigSync? wx.getExtConfigSync(): {}
- console.log(extConfig)
- ``` */
- getExtConfigSync(): IAnyObject
- /** [Object wx.getLaunchOptionsSync()](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.getLaunchOptionsSync.html)
- *
- * 获取小游戏冷启动时的参数。热启动参数通过 [wx.onShow](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onShow.html) 接口获取。
- *
- * **返回有效 referrerInfo 的场景**
- *
- * | 场景值 | 场景 | appId含义 |
- * | ------ | ------------------------------- | ---------- |
- * | 1020 | 公众号 profile 页相关小程序列表 | 来源公众号 |
- * | 1035 | 公众号自定义菜单 | 来源公众号 |
- * | 1036 | App 分享消息卡片 | 来源App |
- * | 1037 | 小程序打开小程序 | 来源小程序 |
- * | 1038 | 从另一个小程序返回 | 来源小程序 |
- * | 1043 | 公众号模板消息 | 来源公众号 |
- *
- * **注意**
- *
- * 部分版本在无`referrerInfo`的时候会返回 `undefined`,
- * 建议使用 `options.referrerInfo && options.referrerInfo.appId` 进行判断。 */
- getLaunchOptionsSync(): LaunchOptionsGame
- /** [Object wx.getMenuButtonBoundingClientRect()](https://developers.weixin.qq.com/minigame/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 获取菜单按钮(右上角胶囊按钮)的布局位置信息。坐标信息以屏幕左上角为原点。
- *
- * **示例代码**
- *
- * ```js
- const res = wx.getMenuButtonBoundingClientRect()
- console.log(res.width)
- console.log(res.height)
- console.log(res.top)
- console.log(res.right)
- console.log(res.bottom)
- console.log(res.left)
- ``` */
- getMenuButtonBoundingClientRect(): ClientRect
- /** [Object wx.getStorageInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageInfoSync.html)
- *
- * [wx.getStorageInfo](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageInfo.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- wx.getStorageInfo({
- success (res) {
- console.log(res.keys)
- console.log(res.currentSize)
- console.log(res.limitSize)
- }
- })
- ```
- *
- * ```js
- try {
- const res = wx.getStorageInfoSync()
- console.log(res.keys)
- console.log(res.currentSize)
- console.log(res.limitSize)
- } catch (e) {
- // Do something when catch error
- }
- ``` */
- getStorageInfoSync(): GetStorageInfoSyncOption
- /** [Object wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html)
- *
- * [wx.getSystemInfo](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfo.html) 的同步版本
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/WkUCgXmS7mqO)
- *
- * ```js
- wx.getSystemInfo({
- success (res) {
- console.log(res.model)
- console.log(res.pixelRatio)
- console.log(res.windowWidth)
- console.log(res.windowHeight)
- console.log(res.language)
- console.log(res.version)
- console.log(res.platform)
- }
- })
- ```
- *
- * ```js
- try {
- const res = wx.getSystemInfoSync()
- console.log(res.model)
- console.log(res.pixelRatio)
- console.log(res.windowWidth)
- console.log(res.windowHeight)
- console.log(res.language)
- console.log(res.version)
- console.log(res.platform)
- } catch (e) {
- // Do something when catch error
- }
- ``` */
- getSystemInfoSync(): SystemInfo
- /** [[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)
- *
- * 需要基础库: `2.0.4`
- *
- * 创建 banner 广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.0.4 后再使用该 API。每次调用该方法创建 banner 广告都会返回一个全新的实例。 */
- createBannerAd(option: CreateBannerAdOption): BannerAd
- /** [[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)
- *
- * 需要基础库: `2.9.0`
- *
- * 创建相机 */
- createCamera(option: CreateCameraOption): Camera
- /** [[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)
- *
- * 创建一个画布对象。首次调用创建的是显示在屏幕上的画布,之后调用创建的都是离屏画布。 */
- createCanvas(): Canvas
- /** [[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)
- *
- * 获取主域和开放数据域共享的 sharedCanvas。**只有开放数据域能调用。** */
- getSharedCanvas(): Canvas
- /** [[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)
- *
- * 下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径),单次下载允许的最大文件为 200MB。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。
- *
- * 注意:请在服务端响应的 header 中指定合理的 `Content-Type` 字段,以保证客户端正确处理文件类型。
- *
- * **示例代码**
- *
- * ```js
- wx.downloadFile({
- url: 'https://example.com/audio/123', //仅为示例,并非真实的资源
- success (res) {
- // 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
- if (res.statusCode === 200) {
- wx.playVoice({
- filePath: res.tempFilePath
- })
- }
- }
- })
- ``` */
- downloadFile(option: DownloadFileOption): DownloadTask
- /** [[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)
- *
- * 需要基础库: `2.1.2`
- *
- * 创建打开意见反馈页面的按钮 */
- createFeedbackButton(
- option: CreateOpenSettingButtonOption
- ): FeedbackButton
- /** [[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)
- *
- * 获取全局唯一的文件管理器 */
- getFileSystemManager(): FileSystemManager
- /** [[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)
- *
- * 需要基础库: `2.7.5`
- * @deprecated 基础库版本 [2.18.1](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
- *
- * 创建小游戏推荐banner组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.7.5 后再使用该 API。每次调用该方法都会返回一个全新的实例。 */
- createGameBanner(option: CreateGameBannerOption): GameBanner
- /** [[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)
- *
- * 需要基础库: `2.0.3`
- *
- * 创建游戏圈按钮。游戏圈按钮被点击后会跳转到小游戏的游戏圈。更多关于游戏圈的信息见 [游戏圈使用指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/game-club.html) */
- createGameClubButton(option: CreateGameClubButtonOption): GameClubButton
- /** [[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)
- *
- * 需要基础库: `2.8.3`
- * @deprecated 基础库版本 [2.18.1](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
- *
- * 创建小游戏推荐icon组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.8.2 后再使用该 API。每次调用该方法都会返回一个全新的实例。 */
- createGameIcon(
- option: CreateGameIconOption,
- /** 单个游戏icon的位置和样式信息 */
- styleItem: StyleItem
- ): GameIcon
- /** [[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)
- *
- * 需要基础库: `2.7.5`
- * @deprecated 基础库版本 [2.18.1](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
- *
- * 创建小游戏推荐弹窗组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.7.5 后再使用该 API。每次调用该方法都会返回一个全新的实例。 */
- createGamePortal(option: CreateGamePortalOption): GamePortal
- /** [[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)
- *
- * 需要基础库: `2.8.0`
- *
- * 创建游戏对局回放分享按钮,返回一个单例对象。按钮在被用户点击后会发起对最近一次录制完成的游戏对局回放的分享。 */
- createGameRecorderShareButton(
- option: CreateGameRecorderShareButtonOption
- ): GameRecorderShareButton
- /** [[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)
- *
- * 需要基础库: `2.8.0`
- *
- * 获取全局唯一的游戏画面录制对象 */
- getGameRecorder(): GameRecorder
- /** [[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)
- *
- * 需要基础库: `2.8.0`
- *
- * 获取 **全局唯一** 的游戏服务管理器。 */
- getGameServerManager(): GameServerManager
- /** [[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)
- *
- * 需要基础库: `2.9.2`
- *
- * 创建 grid(格子) 广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.9.2 后再使用该 API。每次调用该方法创建 grid(格子) 广告都会返回一个全新的实例。 */
- createGridAd(option: CreateGridAdOption): GridAd
- /** [[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)
- *
- * 创建一个图片对象 */
- createImage(): Image
- /** [[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)
- *
- * 需要基础库: `1.6.0`
- *
- * 创建内部 [audio](#) 上下文 [InnerAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.html) 对象。 */
- createInnerAudioContext(
- option?: CreateInnerAudioContextOption
- ): InnerAudioContext
- /** [[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)
- *
- * 需要基础库: `2.6.0`
- *
- * 创建插屏广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号后再使用该 API。每次调用该方法创建插屏广告都会返回一个全新的实例(小程序端的插屏广告实例不允许跨页面使用)。 */
- createInterstitialAd(option: CreateInterstitialAdOption): InterstitialAd
- /** [[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)
- *
- * 需要基础库: `2.1.0`
- *
- * 触发分包加载,详见 [分包加载](#) */
- loadSubpackage(option: LoadSubpackageOption): LoadSubpackageTask
- /** [[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)
- *
- * 需要基础库: `2.1.0`
- *
- * 获取日志管理器对象。
- *
- * **示例代码**
- *
- * ```js
- const logger = wx.getLogManager({level: 1})
- logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3])
- logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
- logger.debug({str: 'hello world'}, 'debug log', 100, [1, 2, 3])
- logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
- ``` */
- getLogManager(option: GetLogManagerOption): LogManager
- /** [[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)
- *
- * 需要基础库: `2.13.0`
- *
- * 创建媒体音频播放器对象 [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) 输出的音频。
- *
- * **示例代码**
- *
- * ```js
- // 创建视频解码器,具体参数见 createVideoDecoder 文档
- const videoDecoder = wx.createVideoDecoder()
- // 创建媒体音频播放器
- const mediaAudioPlayer = wx.createMediaAudioPlayer()
- // 启动视频解码器
- videoDecoder.start()
- // 启动播放器
- mediaAudioPlayer.start().then(() => {
- // 添加播放器音频来源
- mediaAudioPlayer.addAudioSource(videoDecoder).then(res => {
- videoDecoder.getFrameData() // 建议在 requestAnimationFrame 里获取每一帧视频数据
- console.log(res)
- })
- // 移除播放器音频来源
- mediaAudioPlayer.removeAudioSource(videoDecoder).then()
- // 停止播放器
- mediaAudioPlayer.stop().then()
- // 销毁播放器
- mediaAudioPlayer.destroy().then()
- // 设置播放器音量
- mediaAudioPlayer.volume = 0.5
- })
- ```
- *
- * **完整demo(小游戏)**
- *
- * - https://developers.weixin.qq.com/s/SF2duHmb7MjI */
- createMediaAudioPlayer(): MediaAudioPlayer
- /** [[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)
- *
- * 需要基础库: `1.9.92`
- *
- * 获取开放数据域 */
- getOpenDataContext(): OpenDataContext
- /** [[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)
- *
- * 需要基础库: `2.0.7`
- *
- * 创建打开设置页面的按钮 */
- createOpenSettingButton(
- option: CreateOpenSettingButtonOption
- ): OpenSettingButton
- /** [[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)
- *
- * 获取性能管理器 */
- getPerformance(): Performance
- /** [[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)
- *
- * 需要基础库: `2.14.4`
- *
- * 获取实时日志管理器对象。
- *
- * **示例代码**
- *
- * ```js
- // 小程序端
- const logger = wx.getRealtimeLogManager()
- logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
- logger.error({str: 'hello world'}, 'error log', 100, [1, 2, 3])
- logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
- // 插件端,基础库 2.16.0 版本后支持,只允许采用 key-value 的新格式上报
- const logManager = wx.getRealtimeLogManager()
- const logger = logManager.tag('plugin-log1')
- logger.info('key1', 'value1')
- logger.error('key2', {str: 'value2'})
- logger.warn('key3', 'value3')
- ``` */
- getRealtimeLogManager(): RealtimeLogManager
- /** [[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)
- *
- * 需要基础库: `1.6.0`
- *
- * 获取**全局唯一**的录音管理器 RecorderManager */
- getRecorderManager(): RecorderManager
- /** [[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)
- *
- * 发起 HTTPS 网络请求。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。
- *
- * **data 参数说明**
- *
- * 最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String 。转换规则如下:
- * - 对于 `GET` 方法的数据,会将数据转换成 query string(`encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...`)
- * - 对于 `POST` 方法且 `header['content-type']` 为 `application/json` 的数据,会对数据进行 JSON 序列化
- * - 对于 `POST` 方法且 `header['content-type']` 为 `application/x-www-form-urlencoded` 的数据,会将数据转换成 query string `(encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)`
- *
- * **示例代码**
- *
- * ```js
- wx.request({
- url: 'example.php', //仅为示例,并非真实的接口地址
- data: {
- x: '',
- y: ''
- },
- header: {
- 'content-type': 'application/json' // 默认值
- },
- success (res) {
- console.log(res.data)
- }
- })
- ``` */
- request<
- T extends string | IAnyObject | ArrayBuffer =
- | string
- | IAnyObject
- | ArrayBuffer
- >(
- option: RequestOption<T>
- ): RequestTask
- /** [[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)
- *
- * 需要基础库: `2.0.4`
- *
- * 创建激励视频广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号后再使用该 API(小游戏端要求 >= 2.0.4, 小程序端要求 >= 2.6.0)。调用该方法创建的激励视频广告是一个单例(小游戏端是全局单例,小程序端是页面内单例,在小程序端的单例对象不允许跨页面使用)。 */
- createRewardedVideoAd(
- option: CreateRewardedVideoAdOption
- ): RewardedVideoAd
- /** [[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)
- *
- * 创建一个 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 前缀的方法可能会带来一些和预期不一致的情况。**
- *
- * **并发数**
- *
- * - 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接。
- * - 1.7.0 以下版本,一个小程序同时只能有一个 WebSocket 连接,如果当前已存在一个 WebSocket 连接,会自动关闭该连接,并重新创建一个 WebSocket 连接。
- *
- * **示例代码**
- *
- * ```js
- wx.connectSocket({
- url: 'wss://example.qq.com',
- header:{
- 'content-type': 'application/json'
- },
- protocols: ['protocol1']
- })
- ``` */
- connectSocket(option: ConnectSocketOption): SocketTask
- /** [[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)
- *
- * 需要基础库: `2.7.0`
- *
- * 创建一个 UDP Socket 实例。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。 */
- createUDPSocket(): UDPSocket
- /** [[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)
- *
- * 需要基础库: `1.9.90`
- *
- * 获取**全局唯一**的版本更新管理器,用于管理小程序更新。关于小程序的更新机制,可以查看[运行机制](https://developers.weixin.qq.com/minigame/dev/guide/runtime/operating-mechanism.html)文档。
- *
- * **示例代码**
- *
- * [示例代码](https://developers.weixin.qq.com/minigame/dev/api/base/update/UpdateManager.html#示例代码) */
- getUpdateManager(): UpdateManager
- /** [[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)
- *
- * 将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 `content-type` 为 `multipart/form-data`。使用前请注意阅读[相关说明](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/network.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.chooseImage({
- success (res) {
- const tempFilePaths = res.tempFilePaths
- wx.uploadFile({
- url: 'https://example.weixin.qq.com/upload', //仅为示例,非真实的接口地址
- filePath: tempFilePaths[0],
- name: 'file',
- formData: {
- 'user': 'test'
- },
- success (res){
- const data = res.data
- //do something
- }
- })
- }
- })
- ``` */
- uploadFile(option: UploadFileOption): UploadTask
- /** [[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)
- *
- * 需要基础库: `2.17.3`
- *
- * 获取用户加密模块 */
- getUserCryptoManager(): UserCryptoManager
- /** [[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)
- *
- * 需要基础库: `2.0.1`
- *
- * 创建用户信息按钮 */
- createUserInfoButton(option: CreateUserInfoButtonOption): UserInfoButton
- /** [[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)
- *
- * 需要基础库: `2.11.1`
- *
- * 创建视频解码器,可逐帧获取解码后的数据 */
- createVideoDecoder(): VideoDecoder
- /** [[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)
- *
- * 创建视频 */
- createVideo(option: CreateVideoOption): Video
- /** [[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)
- *
- * 需要基础库: `2.19.0`
- *
- * 创建 WebAudio 上下文。 */
- createWebAudioContext(): WebAudioContext
- /** [[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)
- *
- * 需要基础库: `1.9.90`
- *
- * 创建一个 Worker 线程
- *
- * **示例代码**
- *
- * ```js
- // 创建普通worker
- wx.createWorker('workers/index.js')
- ```
- * ```js
- function createNewWorker() {
- const worker = wx.createWorker('workers/index.js', {
- useExperimentalWorker: true
- })
- // 监听worker被系统回收事件
- worker.onProcessKilled(() => {
- // 重新创建一个worker
- createNewWorker()
- })
- }
- // 创建实验worker
- createNewWorker()
- ``` */
- createWorker(
- /** worker 入口文件的**绝对路径** */
- scriptPath: string,
- /** 可选参数 */
- options?: CreateWorkerOption
- ): Worker
- /** [any wx.getStorageSync(string key, Boolean encrypt)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageSync.html)
- *
- * [wx.getStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorage.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- wx.getStorage({
- key: 'key',
- success (res) {
- console.log(res.data)
- }
- })
- ```
- *
- * ```js
- try {
- var value = wx.getStorageSync('key')
- if (value) {
- // Do something with return value
- }
- } catch (e) {
- // Do something when catch error
- }
- ```
- *
- * ```js
- // 开启加密存储
- wx.setStorage({
- key: "key",
- data: "value",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success() {
- wx.getStorage({
- key: "key",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success(res) {
- console.log(res.data)
- }
- })
- }
- })
- ``` */
- getStorageSync<T = any>(
- /** 本地缓存中指定的 key */
- key: string,
- /** 需要基础库: `2.21.3`
- *
- * 是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true */
- encrypt?: boolean
- ): T
- /** [boolean wx.setCursor(string path, number x, number y)](https://developers.weixin.qq.com/minigame/dev/api/render/cursor/wx.setCursor.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 加载自定义光标,仅支持 PC 平台
- *
- * **注意**
- *
- * - 传入图片太大可能会导致设置无效,推荐图标大小 32x32
- * - 基础库 v2.16.0 后,支持更多图片格式以及关键字种类(参考 CSS 标准) */
- setCursor(
- /** 代码包或本地路径,支持 ico 和 cur 格式,传入 'default' 代表恢复系统默认 */
- path: string,
- /** 需要基础库: `2.19.0`
- *
- * 横向偏移量 */
- x?: number,
- /** 需要基础库: `2.19.0`
- *
- * 纵向偏移量 */
- y?: number
- ): boolean
- /** [boolean wx.setMessageToFriendQuery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.setMessageToFriendQuery.html)
- *
- * 设置 wx.shareMessageToFriend 接口 query 字段的值 */
- setMessageToFriendQuery(option: SetMessageToFriendQueryOption): boolean
- /** [number wx.getTextLineHeight(Object object)](https://developers.weixin.qq.com/minigame/dev/api/render/font/wx.getTextLineHeight.html)
- *
- * 获取一行文本的行高 */
- getTextLineHeight(option: GetTextLineHeightOption): number
- /** [string wx.decode(Object object)](https://developers.weixin.qq.com/minigame/dev/api/util/wx.decode.html)
- *
- * 将 ArrayBuffer 按照指定的编码格式解码成字符串 */
- decode(option: DecodeOption): string
- /** [string wx.loadFont(string path)](https://developers.weixin.qq.com/minigame/dev/api/render/font/wx.loadFont.html)
- *
- * 加载自定义字体文件 */
- loadFont(
- /** 字体文件路径。支持本地路径、代码包路径。 */
- path: string
- ): string
- /** [wx.addCard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/card/wx.addCard.html)
- *
- * 需要基础库: `2.5.0`
- *
- * 批量添加卡券。只有通过 [认证](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)。
- *
- * **cardExt 说明**
- *
- * cardExt 是卡券的扩展参数,其值是一个 JSON 字符串。
- *
- * **示例代码**
- *
- * ```js
- wx.addCard({
- cardList: [
- {
- cardId: '',
- cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
- }, {
- cardId: '',
- cardExt: '{"code": "", "openid": "", "timestamp": "", "signature":""}'
- }
- ],
- success (res) {
- console.log(res.cardList) // 卡券添加结果
- }
- })
- ``` */
- addCard<T extends AddCardOption = AddCardOption>(
- option: T
- ): PromisifySuccessResult<T, AddCardOption>
- /** [wx.authPrivateMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.authPrivateMessage.html)
- *
- * 需要基础库: `2.13.0`
- *
- * 验证私密消息。用法详情见 [小程序私密消息使用指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/share/private-message.html)
- *
- * **示例代码**
- *
- * ```js
- wx.authPrivateMessage({
- shareTicket: 'xxxxxx',
- success(res) {
- console.log('authPrivateMessage success', res)
- // res
- // {
- // errMsg: 'authPrivateMessage:ok'
- // valid: true
- // iv: 'xxxx',
- // encryptedData: 'xxxxxx'
- // }
- },
- fail(res) {
- console.log('authPrivateMessage fail', res)
- }
- })
- ``` */
- authPrivateMessage(option?: AuthPrivateMessageOption): void
- /** [wx.authorize(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/authorize/wx.authorize.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据,但不会实际调用对应接口。如果用户之前已经同意授权,则不会出现弹窗,直接返回成功。更多用法详见 [用户授权](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html)。
- * > 小程序插件可以使用 [wx.authorizeForMiniProgram](#)
- *
- * **示例代码**
- *
- * ```js
- // 可以通过 wx.getSetting 先查询一下用户是否授权了 "scope.record" 这个 scope
- wx.getSetting({
- success(res) {
- if (!res.authSetting['scope.record']) {
- wx.authorize({
- scope: 'scope.record',
- success () {
- // 用户已经同意小程序使用录音功能,后续调用 wx.startRecord 接口不会弹窗询问
- wx.startRecord()
- }
- })
- }
- }
- })
- ``` */
- authorize<T extends AuthorizeOption = AuthorizeOption>(
- option: T
- ): PromisifySuccessResult<T, AuthorizeOption>
- /** [wx.checkHandoffEnabled(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.checkHandoffEnabled.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 检查是否可以进行接力,该接口需要在开放数据域调用 */
- checkHandoffEnabled(option?: CheckHandoffEnabledOption): void
- /** [wx.checkIsUserAdvisedToRest(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/anti-addiction/wx.checkIsUserAdvisedToRest.html)
- *
- * 需要基础库: `1.9.97`
- *
- * 根据用户当天游戏时间判断用户是否需要休息 */
- checkIsUserAdvisedToRest<
- T extends CheckIsUserAdvisedToRestOption = CheckIsUserAdvisedToRestOption
- >(
- option: T
- ): PromisifySuccessResult<T, CheckIsUserAdvisedToRestOption>
- /** [wx.checkSession(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.checkSession.html)
- *
- * 检查登录态是否过期。
- * 通过 wx.login 接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序,用户登录态越有可能失效。反之如果用户一直在使用小程序,则用户登录态一直保持有效。具体时效逻辑由微信维护,对开发者透明。开发者只需要调用 wx.checkSession 接口检测当前用户登录态是否有效。
- *
- * 登录态过期后开发者可以再调用 wx.login 获取新的用户登录态。调用成功说明当前 session_key 未过期,调用失败说明 session_key 已过期。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/login.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.checkSession({
- success () {
- //session_key 未过期,并且在本生命周期一直有效
- },
- fail () {
- // session_key 已经失效,需要重新执行登录流程
- wx.login() //重新登录
- }
- })
- ``` */
- checkSession<T extends CheckSessionOption = CheckSessionOption>(
- option?: T
- ): PromisifySuccessResult<T, CheckSessionOption>
- /** [wx.chooseImage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.chooseImage.html)
- *
- * 从本地相册选择图片或使用相机拍照。此接口不再更新,建议使用 `wx.chooseMedia`。
- *
- * ****
- *
- * ```js
- wx.chooseImage({
- count: 1,
- sizeType: ['original', 'compressed'],
- sourceType: ['album', 'camera'],
- success (res) {
- // tempFilePath可以作为img标签的src属性显示图片
- const tempFilePaths = res.tempFilePaths
- }
- })
- ``` */
- chooseImage<T extends ChooseImageOption = ChooseImageOption>(
- option?: T
- ): PromisifySuccessResult<T, ChooseImageOption>
- /** [wx.clearStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.clearStorage.html)
- *
- * 清理本地数据缓存。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.clearStorage()
- ```
- *
- * ```js
- try {
- wx.clearStorageSync()
- } catch(e) {
- // Do something when catch error
- }
- ``` */
- clearStorage<T extends ClearStorageOption = ClearStorageOption>(
- option?: T
- ): PromisifySuccessResult<T, ClearStorageOption>
- /** [wx.clearStorageSync()](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.clearStorageSync.html)
- *
- * [wx.clearStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.clearStorage.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- wx.clearStorage()
- ```
- *
- * ```js
- try {
- wx.clearStorageSync()
- } catch(e) {
- // Do something when catch error
- }
- ``` */
- clearStorageSync(): void
- /** [wx.closeBLEConnection(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.closeBLEConnection.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 断开与蓝牙低功耗设备的连接。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.closeBLEConnection({
- deviceId,
- success (res) {
- console.log(res)
- }
- })
- ``` */
- closeBLEConnection<
- T extends CloseBLEConnectionOption = CloseBLEConnectionOption
- >(
- option: T
- ): PromisifySuccessResult<T, CloseBLEConnectionOption>
- /** [wx.closeBluetoothAdapter(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.closeBluetoothAdapter.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后,与 [wx.openBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html) 成对调用。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.closeBluetoothAdapter({
- success (res) {
- console.log(res)
- }
- })
- ``` */
- closeBluetoothAdapter<
- T extends CloseBluetoothAdapterOption = CloseBluetoothAdapterOption
- >(
- option?: T
- ): PromisifySuccessResult<T, CloseBluetoothAdapterOption>
- /** [wx.closeSocket(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.closeSocket.html)
- *
- * 关闭 WebSocket 连接。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。**
- *
- * **示例代码**
- *
- * ```js
- wx.connectSocket({
- url: 'test.php'
- })
- //注意这里有时序问题,
- //如果 wx.connectSocket 还没回调 wx.onSocketOpen,而先调用 wx.closeSocket,那么就做不到关闭 WebSocket 的目的。
- //必须在 WebSocket 打开期间调用 wx.closeSocket 才能关闭。
- wx.onSocketOpen(function() {
- wx.closeSocket()
- })
- wx.onSocketClose(function(res) {
- console.log('WebSocket 已关闭!')
- })
- ``` */
- closeSocket<T extends CloseSocketOption = CloseSocketOption>(
- option?: T
- ): PromisifySuccessResult<T, CloseSocketOption>
- /** [wx.createBLEConnection(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 连接蓝牙低功耗设备。
- *
- * 若小程序在之前已有搜索过某个蓝牙设备,并成功建立连接,可直接传入之前搜索获取的 deviceId 直接尝试连接该设备,无需再次进行搜索操作。
- *
- * **注意**
- *
- * - 请保证尽量成对的调用 [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` 的时候并不能真正的断开与设备的连接。
- * - 蓝牙连接随时可能断开,建议监听 [wx.onBLEConnectionStateChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEConnectionStateChange.html) 回调事件,当蓝牙设备断开时按需执行重连操作
- * - 若对未连接的设备或已断开连接的设备调用数据读写操作的接口,会返回 10006 错误,建议进行重连操作。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.createBLEConnection({
- deviceId,
- success (res) {
- console.log(res)
- }
- })
- ``` */
- createBLEConnection<
- T extends CreateBLEConnectionOption = CreateBLEConnectionOption
- >(
- option: T
- ): PromisifySuccessResult<T, CreateBLEConnectionOption>
- /** [wx.createBLEPeripheralServer(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/wx.createBLEPeripheralServer.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 建立本地作为蓝牙低功耗外围设备的服务端,可创建多个。 */
- createBLEPeripheralServer<
- T extends CreateBLEPeripheralServerOption = CreateBLEPeripheralServerOption
- >(
- option?: T
- ): PromisifySuccessResult<T, CreateBLEPeripheralServerOption>
- /** [wx.createBufferURL(ArrayBuffer|TypedArray buffer)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.createBufferURL.html)
- *
- * 需要基础库: `2.14.0`
- *
- * 根据传入的 buffer 创建一个唯一的 URL 存在内存中 */
- createBufferURL(
- /** 需要存入内存的二进制数据 */
- buffer:
- | ArrayBuffer
- | Int8Array
- | Uint8Array
- | Uint8ClampedArray
- | Int16Array
- | Uint16Array
- | Int32Array
- | Uint32Array
- | Float32Array
- | Float64Array
- ): void
- /** [wx.createCustomAd(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ad/wx.createCustomAd.html)
- *
- * 需要基础库: `2.11.1`
- *
- * 创建原生模板广告组件。请通过 [wx.getSystemInfoSync()](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoSync.html) 返回对象的 SDKVersion 判断基础库版本号 >= 2.11.1 后再使用该 API。每次调用该方法创建原生模板广告都会返回一个全新的实例。 */
- createCustomAd(option: CreateCustomAdOption): void
- /** [wx.exitMiniProgram(Object object)](https://developers.weixin.qq.com/minigame/dev/api/navigate/wx.exitMiniProgram.html)
- *
- * 需要基础库: `2.17.3`
- *
- * 退出当前小程序。必须有点击行为才能调用成功。 */
- exitMiniProgram<
- T extends ExitMiniProgramOption = ExitMiniProgramOption
- >(
- option?: T
- ): PromisifySuccessResult<T, ExitMiniProgramOption>
- /** [wx.exitVoIPChat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.exitVoIPChat.html)
- *
- * 需要基础库: `2.7.0`
- *
- * 退出(销毁)实时语音通话 */
- exitVoIPChat<T extends ExitVoIPChatOption = ExitVoIPChatOption>(
- option?: T
- ): PromisifySuccessResult<T, ExitVoIPChatOption>
- /** [wx.faceDetect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ai/face/wx.faceDetect.html)
- *
- * 需要基础库: `2.18.0`
- *
- * 人脸识别,使用前需要通过 wx.initFaceDetect 进行一次初始化,推荐使用相机接口返回的帧数据 */
- faceDetect(option: FaceDetectOption): void
- /** [wx.getAvailableAudioSources(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.getAvailableAudioSources.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 获取当前支持的音频输入源 */
- getAvailableAudioSources<
- T extends GetAvailableAudioSourcesOption = GetAvailableAudioSourcesOption
- >(
- option?: T
- ): PromisifySuccessResult<T, GetAvailableAudioSourcesOption>
- /** [wx.getBLEDeviceCharacteristics(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceCharacteristics.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 获取蓝牙低功耗设备某个服务中所有特征 (characteristic)。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.getBLEDeviceCharacteristics({
- // 这里的 deviceId 需要已经通过 wx.createBLEConnection 与对应设备建立链接
- deviceId,
- // 这里的 serviceId 需要在 wx.getBLEDeviceServices 接口中获取
- serviceId,
- success (res) {
- console.log('device getBLEDeviceCharacteristics:', res.characteristics)
- }
- })
- ``` */
- getBLEDeviceCharacteristics<
- T extends GetBLEDeviceCharacteristicsOption = GetBLEDeviceCharacteristicsOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetBLEDeviceCharacteristicsOption>
- /** [wx.getBLEDeviceRSSI(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceRSSI.html)
- *
- * 需要基础库: `2.11.0`
- *
- * 获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI)。 */
- getBLEDeviceRSSI<
- T extends GetBLEDeviceRSSIOption = GetBLEDeviceRSSIOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetBLEDeviceRSSIOption>
- /** [wx.getBLEDeviceServices(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEDeviceServices.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 获取蓝牙低功耗设备所有服务 (service)。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.getBLEDeviceServices({
- // 这里的 deviceId 需要已经通过 wx.createBLEConnection 与对应设备建立连接
- deviceId,
- success (res) {
- console.log('device services:', res.services)
- }
- })
- ``` */
- getBLEDeviceServices<
- T extends GetBLEDeviceServicesOption = GetBLEDeviceServicesOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetBLEDeviceServicesOption>
- /** [wx.getBLEMTU(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.getBLEMTU.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 获取蓝牙低功耗的最大传输单元。需在 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 调用成功后调用。
- *
- * **注意**
- *
- * - 小程序中 MTU 为 ATT_MTU,包含 Op-Code 和 Attribute Handle 的长度,实际可以传输的数据长度为 `ATT_MTU - 3`
- * - iOS 系统中 MTU 为固定值;安卓系统中,MTU 会在系统协商成功之后发生改变,建议使用 [wx.onBLEMTUChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEMTUChange.html) 监听。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.getBLEMTU({
- deviceId: '',
- writeType: 'write',
- success (res) {
- console.log(res)
- }
- })
- ``` */
- getBLEMTU<T extends GetBLEMTUOption = GetBLEMTUOption>(
- option: T
- ): PromisifySuccessResult<T, GetBLEMTUOption>
- /** [wx.getBatteryInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfo.html)
- *
- * 获取设备电量。同步 API [wx.getBatteryInfoSync](https://developers.weixin.qq.com/minigame/dev/api/device/battery/wx.getBatteryInfoSync.html) 在 iOS 上不可用。 */
- getBatteryInfo<T extends GetBatteryInfoOption = GetBatteryInfoOption>(
- option?: T
- ): PromisifySuccessResult<T, GetBatteryInfoOption>
- /** [wx.getBeacons(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.getBeacons.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 获取所有已搜索到的 Beacon 设备 */
- getBeacons<T extends GetBeaconsOption = GetBeaconsOption>(
- option?: T
- ): PromisifySuccessResult<T, GetBeaconsOption>
- /** [wx.getBluetoothAdapterState(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getBluetoothAdapterState.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 获取本机蓝牙适配器状态。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.getBluetoothAdapterState({
- success (res) {
- console.log(res)
- }
- })
- ``` */
- getBluetoothAdapterState<
- T extends GetBluetoothAdapterStateOption = GetBluetoothAdapterStateOption
- >(
- option?: T
- ): PromisifySuccessResult<T, GetBluetoothAdapterStateOption>
- /** [wx.getBluetoothDevices(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getBluetoothDevices.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 获取在蓝牙模块生效期间所有搜索到的蓝牙设备。包括已经和本机处于连接状态的设备。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- *
- * ```js
- // ArrayBuffer转16进度字符串示例
- function ab2hex(buffer) {
- var hexArr = Array.prototype.map.call(
- new Uint8Array(buffer),
- function(bit) {
- return ('00' + bit.toString(16)).slice(-2)
- }
- )
- return hexArr.join('');
- }
- wx.getBluetoothDevices({
- success: function (res) {
- console.log(res)
- if (res.devices[0]) {
- console.log(ab2hex(res.devices[0].advertisData))
- }
- }
- })
- ```
- *
- * **注意**
- *
- * - 该接口获取到的设备列表为**蓝牙模块生效期间所有搜索到的蓝牙设备**,若在蓝牙模块使用流程结束后未及时调用 [wx.closeBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.closeBluetoothAdapter.html) 释放资源,会存在调用该接口会返回之前的蓝牙使用流程中搜索到的蓝牙设备,可能设备已经不在用户身边,无法连接。 */
- getBluetoothDevices<
- T extends GetBluetoothDevicesOption = GetBluetoothDevicesOption
- >(
- option?: T
- ): PromisifySuccessResult<T, GetBluetoothDevicesOption>
- /** [wx.getChannelsLiveInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.getChannelsLiveInfo.html)
- *
- * 需要基础库: `2.15.0`
- *
- * 获取视频号直播信息 */
- getChannelsLiveInfo(option: GetChannelsLiveInfoOption): void
- /** [wx.getChannelsLiveNoticeInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.getChannelsLiveNoticeInfo.html)
- *
- * 需要基础库: `2.19.0`
- *
- * 获取视频号直播预告信息 */
- getChannelsLiveNoticeInfo(option: GetChannelsLiveNoticeInfoOption): void
- /** [wx.getClipboardData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/clipboard/wx.getClipboardData.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 获取系统剪贴板的内容
- *
- * **示例代码**
- *
- * ```js
- wx.getClipboardData({
- success (res){
- console.log(res.data)
- }
- })
- ``` */
- getClipboardData<
- T extends GetClipboardDataOption = GetClipboardDataOption
- >(
- option?: T
- ): PromisifySuccessResult<T, GetClipboardDataOption>
- /** [wx.getConnectedBluetoothDevices(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.getConnectedBluetoothDevices.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 根据主服务 UUID 获取已连接的蓝牙设备。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.getConnectedBluetoothDevices({
- services: ['FEE7'],
- success (res) {
- console.log(res)
- }
- })
- ``` */
- getConnectedBluetoothDevices<
- T extends GetConnectedBluetoothDevicesOption = GetConnectedBluetoothDevicesOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetConnectedBluetoothDevicesOption>
- /** [wx.getExtConfig(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfig.html)
- *
- * 需要基础库: `2.8.3`
- *
- * 获取[第三方平台](https://developers.weixin.qq.com/minigame/dev/devtools/ext.html)自定义的数据字段。
- *
- * **Tips**
- *
- * 1. 本接口暂时无法通过 [wx.canIUse](#) 判断是否兼容,开发者需要自行判断 [wx.getExtConfig](https://developers.weixin.qq.com/minigame/dev/api/ext/wx.getExtConfig.html) 是否存在来兼容
- *
- * ****
- *
- * ```js
- if (wx.getExtConfig) {
- wx.getExtConfig({
- success (res) {
- console.log(res.extConfig)
- }
- })
- }
- ``` */
- getExtConfig<T extends GetExtConfigOption = GetExtConfigOption>(
- option?: T
- ): PromisifySuccessResult<T, GetExtConfigOption>
- /** [wx.getFileInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/wx.getFileInfo.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 获取文件信息
- *
- * **示例代码**
- *
- * ```js
- wx.getFileInfo({
- success (res) {
- console.log(res.size)
- console.log(res.digest)
- }
- })
- ``` */
- getFileInfo<T extends WxGetFileInfoOption = WxGetFileInfoOption>(
- option: T
- ): PromisifySuccessResult<T, WxGetFileInfoOption>
- /** [wx.getFriendCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getFriendCloudStorage.html)
- *
- * 需要基础库: `1.9.92`
- *
- * 拉取当前用户所有同玩好友的托管数据。该接口需要用户授权,且只在开放数据域下可用。 */
- getFriendCloudStorage<
- T extends GetFriendCloudStorageOption = GetFriendCloudStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetFriendCloudStorageOption>
- /** [wx.getGroupCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupCloudStorage.html)
- *
- * 需要基础库: `1.9.92`
- *
- * 获取群同玩成员的游戏数据。小游戏通过群分享卡片打开的情况下才可以调用。该接口需要用户授权,且只在开放数据域下可用。 */
- getGroupCloudStorage<
- T extends GetGroupCloudStorageOption = GetGroupCloudStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetGroupCloudStorageOption>
- /** [wx.getGroupEnterInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/group/wx.getGroupEnterInfo.html)
- *
- * 需要基础库: `2.10.4`
- *
- * 获取微信群聊场景下的小程序启动信息。群聊场景包括群聊小程序消息卡片、群待办、群工具。可用于获取当前群的 opengid。
- * ## 注意事项
- * - 基础库 v2.10.4 开始支持获取群工具小程序启动信息
- * - 基础库 v2.17.3 开始支持获取群聊小程序消息卡片、群待办小程序启动信息
- *
- * **示例代码**
- *
- * ```js
- wx.getGroupEnterInfo({
- success(res) {
- // res
- {
- errMsg: 'getGroupEnterInfo:ok',
- encryptedData: '',
- iv: ''
- }
- },
- fail() {
- }
- })
- ```
- *
- * 敏感数据有两种获取方式,一是使用 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) 。
- * 获取得到的开放数据为以下 json 结构(其中 opengid 为当前群的唯一标识):
- *
- * ```json
- {
- "opengid": "OPENGID"
- }
- ```
- *
- * **Tips**
- *
- * - 如需要展示群名称,小程序可以使用[开放数据组件](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/open-data.html)
- * - 小游戏可以通过 `wx.getGroupInfo` 接口获取群名称 */
- getGroupEnterInfo(option: GetGroupEnterInfoOption): void
- /** [wx.getGroupInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupInfo.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 获取群信息。小游戏通过群分享卡片打开的情况下才可以调用。该接口需要用户授权,且只在开放数据域下可用。 */
- getGroupInfo<T extends GetGroupInfoOption = GetGroupInfoOption>(
- option: T
- ): PromisifySuccessResult<T, GetGroupInfoOption>
- /** [wx.getLocalIPAddress(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.getLocalIPAddress.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 获取局域网IP地址
- *
- * **示例代码**
- *
- * ```js
- wx.getLocalIPAddress({
- success (res) {
- const localip = res.localip
- }
- })
- ``` */
- getLocalIPAddress(option: GetLocalIPAddressOption): void
- /** [wx.getLocation(Object object)](https://developers.weixin.qq.com/minigame/dev/api/location/wx.getLocation.html)
- *
- * 获取当前的地理位置、速度。当用户离开小程序后,此接口无法调用。开启高精度定位,接口耗时会增加,可指定 highAccuracyExpireTime 作为超时时间。地图相关使用的坐标格式应为 gcj02。高频率调用会导致耗电,如有需要可使用持续定位接口 `wx.onLocationChange`。基础库 `2.17.0` 版本起 `wx.getLocation` 增加调用频率限制,[相关公告](https://developers.weixin.qq.com/community/develop/doc/000aee91a98d206bc6dbe722b51801)。
- *
- * **示例代码**
- *
- * ```js
- wx.getLocation({
- type: 'wgs84',
- success (res) {
- const latitude = res.latitude
- const longitude = res.longitude
- const speed = res.speed
- const accuracy = res.accuracy
- }
- })
- ```
- *
- * **注意**
- *
- * - `2.17.0 起 `wx.getLocation` 增加调用频率限制,[相关公告](https://developers.weixin.qq.com/community/develop/doc/000aee91a98d206bc6dbe722b51801)
- * - 工具中定位模拟使用IP定位,可能会有一定误差。且工具目前仅支持 gcj02 坐标。
- * - 使用第三方服务进行逆地址解析时,请确认第三方服务默认的坐标系,正确进行坐标转换。 */
- getLocation<T extends GetLocationOption = GetLocationOption>(
- option: T
- ): PromisifySuccessResult<T, GetLocationOption>
- /** [wx.getNetworkType(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.getNetworkType.html)
- *
- * 获取网络类型
- *
- * **示例代码**
- *
- * ```js
- wx.getNetworkType({
- success (res) {
- const networkType = res.networkType
- }
- })
- ``` */
- getNetworkType<T extends GetNetworkTypeOption = GetNetworkTypeOption>(
- option?: T
- ): PromisifySuccessResult<T, GetNetworkTypeOption>
- /** [wx.getPotentialFriendList(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getPotentialFriendList.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 获取可能对游戏感兴趣的未注册的好友名单。每次调用最多可获得 5 个好友。该接口需要用户授权,且只在开放数据域下可用。 */
- getPotentialFriendList<
- T extends GetPotentialFriendListOption = GetPotentialFriendListOption
- >(
- option?: T
- ): PromisifySuccessResult<T, GetPotentialFriendListOption>
- /** [wx.getScreenBrightness(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.getScreenBrightness.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 获取屏幕亮度
- *
- * **说明**
- *
- * - 若安卓系统设置中开启了自动调节亮度功能,则屏幕亮度会根据光线自动调整,该接口仅能获取自动调节亮度之前的值,而非实时的亮度值。 */
- getScreenBrightness<
- T extends GetScreenBrightnessOption = GetScreenBrightnessOption
- >(
- option?: T
- ): PromisifySuccessResult<T, GetScreenBrightnessOption>
- /** [wx.getSetting(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 获取用户的当前设置。**返回值中只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html)**。
- *
- * **示例代码**
- *
- * ```js
- wx.getSetting({
- success (res) {
- console.log(res.authSetting)
- // res.authSetting = {
- // "scope.userInfo": true,
- // "scope.userLocation": true
- // }
- }
- })
- ```
- *
- * ```js
- wx.getSetting({
- withSubscriptions: true,
- success (res) {
- console.log(res.authSetting)
- // res.authSetting = {
- // "scope.userInfo": true,
- // "scope.userLocation": true
- // }
- console.log(res.subscriptionsSetting)
- // res.subscriptionsSetting = {
- // mainSwitch: true, // 订阅消息总开关
- // itemSettings: { // 每一项开关
- // SYS_MSG_TYPE_INTERACTIVE: 'accept', // 小游戏系统订阅消息
- // SYS_MSG_TYPE_RANK: 'accept'
- // zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: 'reject', // 普通一次性订阅消息
- // ke_OZC_66gZxALLcsuI7ilCJSP2OJ2vWo2ooUPpkWrw: 'ban',
- // }
- // }
- }
- })
- ``` */
- getSetting<T extends GetSettingOption = GetSettingOption>(
- option?: T
- ): PromisifySuccessResult<T, GetSettingOption>
- /** [wx.getShareInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.getShareInfo.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 获取转发详细信息
- *
- * **示例代码**
- *
- * 敏感数据获取方式 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) 。
- * 获取得到的开放数据为以下 json 结构(其中 openGId 为当前群的唯一标识):
- *
- * ```json
- {
- "openGId": "OPENGID"
- }
- ```
- *
- * **Tips**
- *
- * - 如需要展示群名称,小程序可以使用 [开放数据组件](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/open-data.html)
- * - 小游戏可以通过 [`wx.getGroupInfo`](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getGroupInfo.html) 接口获取群名称 */
- getShareInfo<T extends GetShareInfoOption = GetShareInfoOption>(
- option: T
- ): PromisifySuccessResult<T, GetShareInfoOption>
- /** [wx.getStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorage.html)
- *
- * 从本地缓存中异步获取指定 key 的内容。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.getStorage({
- key: 'key',
- success (res) {
- console.log(res.data)
- }
- })
- ```
- *
- * ```js
- try {
- var value = wx.getStorageSync('key')
- if (value) {
- // Do something with return value
- }
- } catch (e) {
- // Do something when catch error
- }
- ```
- *
- * ```js
- // 开启加密存储
- wx.setStorage({
- key: "key",
- data: "value",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success() {
- wx.getStorage({
- key: "key",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success(res) {
- console.log(res.data)
- }
- })
- }
- })
- ``` */
- getStorage<
- T = any,
- U extends GetStorageOption<T> = GetStorageOption<T>
- >(
- option: U
- ): PromisifySuccessResult<U, GetStorageOption<T>>
- /** [wx.getStorageInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.getStorageInfo.html)
- *
- * 异步获取当前storage的相关信息。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.getStorageInfo({
- success (res) {
- console.log(res.keys)
- console.log(res.currentSize)
- console.log(res.limitSize)
- }
- })
- ```
- *
- * ```js
- try {
- const res = wx.getStorageInfoSync()
- console.log(res.keys)
- console.log(res.currentSize)
- console.log(res.limitSize)
- } catch (e) {
- // Do something when catch error
- }
- ``` */
- getStorageInfo<T extends GetStorageInfoOption = GetStorageInfoOption>(
- option?: T
- ): PromisifySuccessResult<T, GetStorageInfoOption>
- /** [wx.getSystemInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfo.html)
- *
- * 获取系统信息。**由于历史原因,wx.getSystemInfo 是异步的调用格式,但是是同步返回,需要异步获取系统信息请使用 [wx.getSystemInfoAsync](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoAsync.html)。**
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/WkUCgXmS7mqO)
- *
- * ```js
- wx.getSystemInfo({
- success (res) {
- console.log(res.model)
- console.log(res.pixelRatio)
- console.log(res.windowWidth)
- console.log(res.windowHeight)
- console.log(res.language)
- console.log(res.version)
- console.log(res.platform)
- }
- })
- ```
- *
- * ```js
- try {
- const res = wx.getSystemInfoSync()
- console.log(res.model)
- console.log(res.pixelRatio)
- console.log(res.windowWidth)
- console.log(res.windowHeight)
- console.log(res.language)
- console.log(res.version)
- console.log(res.platform)
- } catch (e) {
- // Do something when catch error
- }
- ``` */
- getSystemInfo<T extends GetSystemInfoOption = GetSystemInfoOption>(
- option?: T
- ): PromisifySuccessResult<T, GetSystemInfoOption>
- /** [wx.getSystemInfoAsync(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/system/wx.getSystemInfoAsync.html)
- *
- * 需要基础库: `2.14.1`
- *
- * 异步获取系统信息。需要一定的微信客户端版本支持,在不支持的客户端上,会使用同步实现来返回。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/WkUCgXmS7mqO)
- *
- * ```js
- wx.getSystemInfoAsync({
- success (res) {
- console.log(res.model)
- console.log(res.pixelRatio)
- console.log(res.windowWidth)
- console.log(res.windowHeight)
- console.log(res.language)
- console.log(res.version)
- console.log(res.platform)
- }
- })
- ``` */
- getSystemInfoAsync(option?: GetSystemInfoAsyncOption): void
- /** [wx.getUserCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserCloudStorage.html)
- *
- * 需要基础库: `1.9.92`
- *
- * 获取当前用户托管数据当中对应 key 的数据。该接口只可在开放数据域下使用 */
- getUserCloudStorage<
- T extends GetUserCloudStorageOption = GetUserCloudStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetUserCloudStorageOption>
- /** [wx.getUserCloudStorageKeys(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserCloudStorageKeys.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 获取当前用户托管数据当中所有的 key。该接口需要用户授权,且只在开放数据域下可用。 */
- getUserCloudStorageKeys(option?: GetUserCloudStorageKeysOption): void
- /** [wx.getUserInfo(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.getUserInfo.html)
- *
- * 获取用户信息。
- *
- * **接口调整说明**
- *
- * 为优化用户登录体验,该接口将进行调整,详见 [用户信息接口调整说明](https://developers.weixin.qq.com/community/develop/doc/000cacfa20ce88df04cb468bc52801)
- *
- * **示例代码**
- *
- * ```js
- // 必须是在用户已经授权的情况下调用
- wx.getUserInfo({
- success: function(res) {
- var userInfo = res.userInfo
- var nickName = userInfo.nickName
- var avatarUrl = userInfo.avatarUrl
- var gender = userInfo.gender //性别 0:未知、1:男、2:女
- var province = userInfo.province
- var city = userInfo.city
- var country = userInfo.country
- }
- })
- ```
- *
- * 敏感数据有两种获取方式:
- * 1. 使用 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法)
- * 2. 使用 [云调用直接获取开放数据](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#云调用直接获取开放数据)
- * 获取得到的开放数据为以下 json 结构:
- *
- * ```json
- {
- "openId": "OPENID",
- "nickName": "NICKNAME",
- "gender": GENDER,
- "city": "CITY",
- "province": "PROVINCE",
- "country": "COUNTRY",
- "avatarUrl": "AVATARURL",
- "unionId": "UNIONID",
- "watermark": {
- "appid":"APPID",
- "timestamp":TIMESTAMP
- }
- }
- ```
- *
- * **小程序用户信息组件示例代码**
- *
- * ```html
- * <!-- 如果只是展示用户头像昵称,可以使用 <open-data /> 组件 -->
- * <open-data type="userAvatarUrl"></open-data>
- * <open-data type="userNickName"></open-data>
- * <!-- 需要使用 button 来授权登录 -->
- * <button wx:if="{{canIUse}}" open-type="getUserInfo" bindgetuserinfo="bindGetUserInfo">授权登录</button>
- * <view wx:else>请升级微信版本</view>
- * ```
- *
- * ```js
- Page({
- data: {
- canIUse: wx.canIUse('button.open-type.getUserInfo')
- },
- onLoad: function() {
- // 查看是否授权
- wx.getSetting({
- success (res){
- if (res.authSetting['scope.userInfo']) {
- // 已经授权,可以直接调用 getUserInfo 获取头像昵称
- wx.getUserInfo({
- success: function(res) {
- console.log(res.userInfo)
- }
- })
- }
- }
- })
- },
- bindGetUserInfo (e) {
- console.log(e.detail.userInfo)
- }
- })
- ``` */
- getUserInfo<T extends GetUserInfoOption = GetUserInfoOption>(
- option: T
- ): PromisifySuccessResult<T, GetUserInfoOption>
- /** [wx.getUserInteractiveStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.getUserInteractiveStorage.html)
- *
- * 需要基础库: `2.7.7`
- *
- * 获取当前用户互动型托管数据对应 key 的数据。该接口需要用户授权。 */
- getUserInteractiveStorage<
- T extends GetUserInteractiveStorageOption = GetUserInteractiveStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, GetUserInteractiveStorageOption>
- /** [wx.getWeRunData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/werun/wx.getWeRunData.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 获取用户过去三十天微信运动步数。需要先调用 [wx.login](https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.login.html) 接口。步数信息会在用户主动进入小程序时更新。
- *
- * **示例代码**
- *
- * ```js
- wx.getWeRunData({
- success (res) {
- // 拿 encryptedData 到开发者后台解密开放数据
- const encryptedData = res.encryptedData
- // 或拿 cloudID 通过云调用直接获取开放数据
- const cloudID = res.cloudID
- }
- })
- ```
- *
- * **开放数据 JSON 结构**
- *
- * 敏感数据有两种获取方式,一是使用 [加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) 。
- * 获取得到的开放数据为以下 json 结构:
- *
- * ```json
- {
- "stepInfoList": [
- {
- "timestamp": 1445866601,
- "step": 100
- },
- {
- "timestamp": 1445876601,
- "step": 120
- }
- ]
- }
- ```
- *
- * stepInfoList 中,每一项结构如下:
- *
- * | 属性 | 类型 | 说明 |
- * | --- | ---- | --- |
- * | timestamp | number | 时间戳,表示数据对应的时间 |
- * | step | number | 微信运动步数 | */
- getWeRunData<T extends GetWeRunDataOption = GetWeRunDataOption>(
- option?: T
- ): PromisifySuccessResult<T, GetWeRunDataOption>
- /** [wx.hideKeyboard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.hideKeyboard.html)
- *
- * 隐藏键盘 */
- hideKeyboard<T extends HideKeyboardOption = HideKeyboardOption>(
- option?: T
- ): PromisifySuccessResult<T, HideKeyboardOption>
- /** [wx.hideLoading(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.hideLoading.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 隐藏 loading 提示框 */
- hideLoading<T extends HideLoadingOption = HideLoadingOption>(
- option?: T
- ): PromisifySuccessResult<T, HideLoadingOption>
- /** [wx.hideShareMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.hideShareMenu.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 隐藏当前页面的转发按钮
- *
- * ****
- *
- * ## 注意事项
- * - "shareAppMessage"表示“发送给朋友”按钮,"shareTimeline"表示“分享到朋友圈”按钮
- * - 隐藏“发送给朋友”按钮时必须同时隐藏“分享到朋友圈”按钮,隐藏“分享到朋友圈”按钮时则允许不隐藏“发送给朋友”按钮
- *
- * **示例代码**
- *
- * ```js
- wx.hideShareMenu({
- menus: ['shareAppMessage', 'shareTimeline']
- })
- ``` */
- hideShareMenu<T extends HideShareMenuOption = HideShareMenuOption>(
- option?: T
- ): PromisifySuccessResult<T, HideShareMenuOption>
- /** [wx.hideToast(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.hideToast.html)
- *
- * 隐藏消息提示框 */
- hideToast<T extends HideToastOption = HideToastOption>(
- option?: T
- ): PromisifySuccessResult<T, HideToastOption>
- /** [wx.initFaceDetect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ai/face/wx.initFaceDetect.html)
- *
- * 需要基础库: `2.18.0`
- *
- * 初始化人脸识别 */
- initFaceDetect(option?: InitFaceDetectOption): void
- /** [wx.isBluetoothDevicePaired(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.isBluetoothDevicePaired.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 查询蓝牙设备是否配对,仅安卓支持。 */
- isBluetoothDevicePaired<
- T extends IsBluetoothDevicePairedOption = IsBluetoothDevicePairedOption
- >(
- option: T
- ): PromisifySuccessResult<T, IsBluetoothDevicePairedOption>
- /** [wx.joinVoIPChat(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.joinVoIPChat.html)
- *
- * 需要基础库: `2.7.0`
- *
- * 加入 (创建) 实时语音通话,更多信息可见 [实时语音指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/voip-chat.html)。调用前需要用户授权 `scope.record`,若房间类型为视频房间需要用户授权 `scope.camera`。 */
- joinVoIPChat<T extends JoinVoIPChatOption = JoinVoIPChatOption>(
- option: T
- ): PromisifySuccessResult<T, JoinVoIPChatOption>
- /** [wx.login(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.login.html)
- *
- * 调用接口获取登录凭证(code)。通过凭证进而换取用户登录态信息,包括用户在当前小程序的唯一标识(openid)、微信开放平台帐号下的唯一标识(unionid,若当前小程序已绑定到微信开放平台帐号)及本次登录的会话密钥(session_key)等。用户数据的加解密通讯需要依赖会话密钥完成。更多使用方法详见 [小程序登录](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/login.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.login({
- success (res) {
- if (res.code) {
- //发起网络请求
- wx.request({
- url: 'https://example.com/onLogin',
- data: {
- code: res.code
- }
- })
- } else {
- console.log('登录失败!' + res.errMsg)
- }
- }
- })
- ``` */
- login<T extends LoginOption = LoginOption>(
- option?: T
- ): PromisifySuccessResult<T, LoginOption>
- /** [wx.makeBluetoothPair(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.makeBluetoothPair.html)
- *
- * 需要基础库: `2.12.0`
- *
- * 蓝牙配对接口,仅安卓支持。
- *
- * 通常情况下(需要指定 `pin` 码或者密码时)系统会接管配对流程,直接调用 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 即可。该接口只应当在开发者不想让用户手动输入 `pin` 码且真机验证确认可以正常生效情况下用。 */
- makeBluetoothPair<
- T extends MakeBluetoothPairOption = MakeBluetoothPairOption
- >(
- option: T
- ): PromisifySuccessResult<T, MakeBluetoothPairOption>
- /** [wx.modifyFriendInteractiveStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.modifyFriendInteractiveStorage.html)
- *
- * 需要基础库: `2.7.7`
- *
- * 修改好友的互动型托管数据,该接口只可在开放数据域下使用。
- *
- * **赠送动作的校验**
- *
- * 调用该接口需要上传 JSServer 函数 "checkInteractiveData",该函数可用于执行赠送动作的校验逻辑,校验通过后返回结果表示本次赠送是否合法。只有 checkInteractiveData 返回了 `{ret: true}`,此次修改才会成功。
- *
- * **使用模板规则进行交互**
- *
- * 每次调用该接口会弹窗询问用户是否确认执行该操作,2.9.0 之后版本,需要在 game.json 中设置 `modifyFriendInteractiveStorageTemplates` 来定制交互的文案。
- * `modifyFriendInteractiveStorageTemplates` 是一个模板数组,每一个模板需要有 key, action, object 参数,还有一个可选参数 ratio,详细说明见示例配置:
- * ```json
- {
- "modifyFriendInteractiveStorageTemplates": [
- {
- "key": "1", // 这个 key 与接口中同名参数相对应,不同的 key 对应不同的模板
- "action": "赠送", // 互动行为
- "object": "金币", // 互动物品
- "ratio": 10 // 物品比率,opNum * ratio 代表物品个数
- }
- ]
- }
- ```
- * 最后生成的文案为 "确认 ${action} ${nickname} ${object}?",或者 "确认 ${action} ${nickname} ${object} x ${opNum * ratio}?"
- *
- * **使用自定义文案进行交互**
- *
- * 2.7.7 之后,2.9.0 之前的版本,文案通过 game.json 的 `modifyFriendInteractiveStorageConfirmWording` 字段配置。
- * 配置内容可包含 nickname 变量,用 ${nickname} 表示,实际调用时会被替换成好友的昵称。示例配置:
- * ```json
- {
- "modifyFriendInteractiveStorageConfirmWording": "确认送给${nickname}一个体力?"
- }
- ```
- * 2.9.0 之后,在 `modifyFriendInteractiveStorageTemplates` 和 `modifyFriendInteractiveStorageConfirmWording` 都存在的情况下,会优先使用前者。 */
- modifyFriendInteractiveStorage<
- T extends ModifyFriendInteractiveStorageOption = ModifyFriendInteractiveStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, ModifyFriendInteractiveStorageOption>
- /** [wx.navigateToMiniProgram(Object object)](https://developers.weixin.qq.com/minigame/dev/api/navigate/wx.navigateToMiniProgram.html)
- *
- * 需要基础库: `2.2.0`
- *
- * 打开另一个小程序
- *
- * **使用限制**
- *
- * ##### 需要用户触发跳转
- * 从 2.3.0 版本开始,若用户未点击小程序页面任意位置,则开发者将无法调用此接口自动跳转至其他小程序。
- * ##### 需要用户确认跳转
- * 从 2.3.0 版本开始,在跳转至其他小程序前,将统一增加弹窗,询问是否跳转,用户确认后才可以跳转其他小程序。如果用户点击取消,则回调 `fail cancel`。
- * ##### 无需声明跳转名单,不限跳转数量(众测中)
- * 1. 从2020年4月24日起,使用跳转其他小程序功能将无需在全局配置中声明跳转名单,调用此接口时将不再校验所跳转的 AppID 是否在 navigateToMiniProgramAppIdList 中。
- * 2. 从2020年4月24日起,跳转其他小程序将不再受数量限制,使用此功能时请注意遵守运营规范。
- *
- * **运营规范**
- *
- * 平台将坚决打击小程序盒子等互推行为,使用此功能时请严格遵守[《微信小程序平台运营规范》](https://developers.weixin.qq.com/miniprogram/product/#_5-10-%E4%BA%92%E6%8E%A8%E8%A1%8C%E4%B8%BA),若发现小程序违反运营规范将被下架处理。
- *
- * **关于调试**
- *
- * - 在开发者工具上调用此 API 并不会真实的跳转到另外的小程序,但是开发者工具会校验本次调用跳转是否成功。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持)
- * - 开发者工具上支持被跳转的小程序处理接收参数的调试。[详情](https://developers.weixin.qq.com/miniprogram/dev/devtools/different.html#跳转小程序调试支持)
- *
- * **示例代码**
- *
- * ```js
- wx.navigateToMiniProgram({
- appId: '',
- path: 'page/index/index?id=123',
- extraData: {
- foo: 'bar'
- },
- envVersion: 'develop',
- success(res) {
- // 打开成功
- }
- })
- ``` */
- navigateToMiniProgram<
- T extends NavigateToMiniProgramOption = NavigateToMiniProgramOption
- >(
- option: T
- ): PromisifySuccessResult<T, NavigateToMiniProgramOption>
- /** [wx.notifyBLECharacteristicValueChange(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 启用蓝牙低功耗设备特征值变化时的 notify 功能,订阅特征。注意:必须设备的特征支持 notify 或者 indicate 才可以成功调用。
- *
- * 另外,必须先启用 [wx.notifyBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) 才能监听到设备 `characteristicValueChange` 事件
- *
- * **注意**
- *
- * - 订阅操作成功后需要设备主动更新特征的 value,才会触发 [wx.onBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html) 回调。
- * - 安卓平台上,在本接口调用成功后立即调用 [wx.writeBLECharacteristicValue](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.writeBLECharacteristicValue.html) 接口,在部分机型上会发生 10008 系统错误
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.notifyBLECharacteristicValueChange({
- state: true, // 启用 notify 功能
- // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
- deviceId,
- // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取
- serviceId,
- // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取
- characteristicId,
- success (res) {
- console.log('notifyBLECharacteristicValueChange success', res.errMsg)
- }
- })
- ``` */
- notifyBLECharacteristicValueChange<
- T extends NotifyBLECharacteristicValueChangeOption = NotifyBLECharacteristicValueChangeOption
- >(
- option: T
- ): PromisifySuccessResult<T, NotifyBLECharacteristicValueChangeOption>
- /** [wx.offAccelerometerChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.offAccelerometerChange.html)
- *
- * 需要基础库: `2.9.3`
- *
- * 取消监听加速度数据事件,参数为空,则取消所有的事件监听。 */
- offAccelerometerChange(
- /** 加速度数据事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offAddToFavorites(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offAddToFavorites.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 取消监听用户点击菜单「收藏」按钮时触发的事件 */
- offAddToFavorites(
- /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
- callback?: OffAddToFavoritesCallback
- ): void
- /** [wx.offAudioInterruptionBegin(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offAudioInterruptionBegin.html)
- *
- * 需要基础库: `1.8.0`
- *
- * 取消监听音频因为受到系统占用而被中断开始事件 */
- offAudioInterruptionBegin(
- /** 音频因为受到系统占用而被中断开始事件的回调函数 */
- callback?: OffAudioInterruptionBeginCallback
- ): void
- /** [wx.offAudioInterruptionEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offAudioInterruptionEnd.html)
- *
- * 需要基础库: `1.8.0`
- *
- * 取消监听音频中断结束事件 */
- offAudioInterruptionEnd(
- /** 音频中断结束事件的回调函数 */
- callback?: OffAudioInterruptionEndCallback
- ): void
- /** [wx.offBLECharacteristicValueChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.offBLECharacteristicValueChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 取消监听蓝牙低功耗设备的特征值变化事件。 */
- offBLECharacteristicValueChange(
- /** 蓝牙低功耗设备的特征值变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offBLEConnectionStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.offBLEConnectionStateChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 取消监听蓝牙低功耗连接状态的改变事件 */
- offBLEConnectionStateChange(
- /** 蓝牙低功耗连接状态的改变事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offBLEMTUChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.offBLEMTUChange.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 取消监听蓝牙低功耗的最大传输单元变化事件 */
- offBLEMTUChange(
- /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
- callback?: OffBLEMTUChangeCallback
- ): void
- /** [wx.offBLEPeripheralConnectionStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/wx.offBLEPeripheralConnectionStateChanged.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 取消监听当前外围设备被连接或断开连接事件 */
- offBLEPeripheralConnectionStateChanged(
- /** 当前外围设备被连接或断开连接事件的回调函数 */
- callback?: OffBLEPeripheralConnectionStateChangedCallback
- ): void
- /** [wx.offBeaconServiceChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.offBeaconServiceChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 取消监听 Beacon 服务状态变化事件 */
- offBeaconServiceChange(
- /** Beacon 服务状态变化事件的回调函数 */
- callback?: OffBeaconServiceChangeCallback
- ): void
- /** [wx.offBeaconUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.offBeaconUpdate.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 取消监听 Beacon 设备更新事件 */
- offBeaconUpdate(
- /** Beacon 设备更新事件的回调函数 */
- callback?: OffBeaconUpdateCallback
- ): void
- /** [wx.offBluetoothAdapterStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.offBluetoothAdapterStateChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 取消监听蓝牙适配器状态变化事件。 */
- offBluetoothAdapterStateChange(
- /** 蓝牙适配器状态变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offBluetoothDeviceFound(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.offBluetoothDeviceFound.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 取消监听寻找到新设备的事件。 */
- offBluetoothDeviceFound(
- /** 寻找到新设备的事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offCompassChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.offCompassChange.html)
- *
- * 需要基础库: `2.9.3`
- *
- * 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听。 */
- offCompassChange(
- /** 罗盘数据变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offCopyUrl(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offCopyUrl.html)
- *
- * 需要基础库: `2.14.3`
- *
- * 取消监听用户点击右上角菜单的「复制链接」按钮时触发的事件 */
- offCopyUrl(
- /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
- callback?: OffCopyUrlCallback
- ): void
- /** [wx.offDeviceMotionChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.offDeviceMotionChange.html)
- *
- * 需要基础库: `2.9.3`
- *
- * 取消监听设备方向变化事件,参数为空,则取消所有的事件监听。 */
- offDeviceMotionChange(
- /** 设备方向变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offDeviceOrientationChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/orientation/wx.offDeviceOrientationChange.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 取消监听横竖屏切换事件 */
- offDeviceOrientationChange(
- /** 横竖屏切换事件的回调函数 */
- callback?: OffDeviceOrientationChangeCallback
- ): void
- /** [wx.offError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offError.html)
- *
- * 取消监听全局错误事件 */
- offError(
- /** 全局错误事件的回调函数 */
- callback?: WxOffErrorCallback
- ): void
- /** [wx.offGyroscopeChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.offGyroscopeChange.html)
- *
- * 需要基础库: `2.9.3`
- *
- * 取消监听陀螺仪数据变化事件。 */
- offGyroscopeChange(
- /** 陀螺仪数据变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offHandoff(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offHandoff.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 取消监听用户点击菜单「在电脑上打开」按钮时触发的事件 */
- offHandoff(
- /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
- callback?: OffHandoffCallback
- ): void
- /** [wx.offHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.offHide.html)
- *
- * 取消监听小游戏隐藏到后台事件 */
- offHide(
- /** 小游戏隐藏到后台事件的回调函数 */
- callback?: OffHideCallback
- ): void
- /** [wx.offInteractiveStorageModified(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.offInteractiveStorageModified.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 取消监听成功修改好友的互动型托管数据事件,该接口在游戏主域使用 */
- offInteractiveStorageModified(
- /** 事件发生的回调函数,留空则清除所有回调 */
- callback?: (...args: any[]) => any
- ): void
- /** [wx.offKeyDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyDown.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 取消监听键盘按键按下事件 */
- offKeyDown(
- /** 键盘按键按下事件的回调函数 */
- callback?: OffKeyDownCallback
- ): void
- /** [wx.offKeyUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyUp.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 取消监听键盘按键弹起事件 */
- offKeyUp(
- /** 键盘按键弹起事件的回调函数 */
- callback?: OffKeyUpCallback
- ): void
- /** [wx.offKeyboardComplete(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardComplete.html)
- *
- * 取消监听监听键盘收起的事件 */
- offKeyboardComplete(
- /** 监听键盘收起的事件的回调函数 */
- callback?: OffKeyboardCompleteCallback
- ): void
- /** [wx.offKeyboardConfirm(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardConfirm.html)
- *
- * 取消监听用户点击键盘 Confirm 按钮时的事件 */
- offKeyboardConfirm(
- /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
- callback?: OffKeyboardConfirmCallback
- ): void
- /** [wx.offKeyboardHeightChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardHeightChange.html)
- *
- * 需要基础库: `2.21.3`
- *
- * 取消监听键盘高度变化事件 */
- offKeyboardHeightChange(
- /** 键盘高度变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offKeyboardInput(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.offKeyboardInput.html)
- *
- * 取消监听键盘输入事件 */
- offKeyboardInput(
- /** 键盘输入事件的回调函数 */
- callback?: OffKeyboardInputCallback
- ): void
- /** [wx.offMemoryWarning(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/memory/wx.offMemoryWarning.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 取消监听内存不足告警事件。 */
- offMemoryWarning(
- /** 内存不足告警事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offMouseDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.offMouseDown.html)
- *
- * 取消监听鼠标按键按下事件 */
- offMouseDown(
- /** 鼠标按键按下事件的回调函数 */
- callback?: OffMouseDownCallback
- ): void
- /** [wx.offMouseMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.offMouseMove.html)
- *
- * 取消监听鼠标移动事件 */
- offMouseMove(
- /** 鼠标移动事件的回调函数 */
- callback?: OffMouseMoveCallback
- ): void
- /** [wx.offMouseUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.offMouseUp.html)
- *
- * 取消监听鼠标按键弹起事件 */
- offMouseUp(
- /** 鼠标按键弹起事件的回调函数 */
- callback?: OffMouseUpCallback
- ): void
- /** [wx.offNetworkStatusChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.offNetworkStatusChange.html)
- *
- * 需要基础库: `2.9.3`
- *
- * 取消监听网络状态变化事件,参数为空,则取消所有的事件监听。 */
- offNetworkStatusChange(
- /** 网络状态变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offNetworkWeakChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.offNetworkWeakChange.html)
- *
- * 需要基础库: `2.21.0`
- *
- * 取消监听弱网状态变化事件 */
- offNetworkWeakChange(
- /** 弱网状态变化事件的回调函数 */
- callback?: OffNetworkWeakChangeCallback
- ): void
- /** [wx.offShareAppMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offShareAppMessage.html)
- *
- * 取消监听用户点击右上角菜单的「转发」按钮时触发的事件 */
- offShareAppMessage(
- /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
- callback?: OffShareAppMessageCallback
- ): void
- /** [wx.offShareTimeline(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.offShareTimeline.html)
- *
- * 需要基础库: `2.11.3`
- *
- * 取消监听用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件 */
- offShareTimeline(
- /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
- callback?: OffShareTimelineCallback
- ): void
- /** [wx.offShow(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.offShow.html)
- *
- * 取消监听小游戏回到前台的事件 */
- offShow(
- /** 小游戏回到前台的事件的回调函数 */
- callback?: OffShowCallback
- ): void
- /** [wx.offTouchCancel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchCancel.html)
- *
- * 取消监听触点失效事件 */
- offTouchCancel(
- /** 触点失效事件的回调函数 */
- callback?: OffTouchCancelCallback
- ): void
- /** [wx.offTouchEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchEnd.html)
- *
- * 取消监听触摸结束事件 */
- offTouchEnd(
- /** 触摸结束事件的回调函数 */
- callback?: OffTouchEndCallback
- ): void
- /** [wx.offTouchMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchMove.html)
- *
- * 取消监听触点移动事件 */
- offTouchMove(
- /** 触点移动事件的回调函数 */
- callback?: OffTouchMoveCallback
- ): void
- /** [wx.offTouchStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.offTouchStart.html)
- *
- * 取消监听开始触摸事件 */
- offTouchStart(
- /** 开始触摸事件的回调函数 */
- callback?: OffTouchStartCallback
- ): void
- /** [wx.offUnhandledRejection(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.offUnhandledRejection.html)
- *
- * 需要基础库: `2.10.0`
- *
- * 取消监听未处理的 Promise 拒绝事件 */
- offUnhandledRejection(
- /** 未处理的 Promise 拒绝事件的回调函数 */
- callback?: OffUnhandledRejectionCallback
- ): void
- /** [wx.offVoIPChatInterrupted(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatInterrupted.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 取消监听被动断开实时语音通话事件。 */
- offVoIPChatInterrupted(
- /** 被动断开实时语音通话事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offVoIPChatMembersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatMembersChanged.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 取消监听实时语音通话成员在线状态变化事件。 */
- offVoIPChatMembersChanged(
- /** 实时语音通话成员在线状态变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offVoIPChatSpeakersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatSpeakersChanged.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 取消监听实时语音通话成员通话状态变化事件。 */
- offVoIPChatSpeakersChanged(
- /** 实时语音通话成员通话状态变化事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.offVoIPChatStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.offVoIPChatStateChanged.html)
- *
- * 需要基础库: `2.16.0`
- *
- * 取消监听房间状态变化事件 */
- offVoIPChatStateChanged(
- /** 房间状态变化事件的回调函数 */
- callback?: OffVoIPChatStateChangedCallback
- ): void
- /** [wx.offWheel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/wheel-event/wx.offWheel.html)
- *
- * 取消监听鼠标滚轮事件 */
- offWheel(
- /** 鼠标滚轮事件的回调函数 */
- callback?: OffWheelCallback
- ): void
- /** [wx.offWindowResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ui/window/wx.offWindowResize.html)
- *
- * 取消监听窗口尺寸变化事件 */
- offWindowResize(
- /** 窗口尺寸变化事件的回调函数 */
- callback?: OffWindowResizeCallback
- ): void
- /** [wx.onAccelerometerChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.onAccelerometerChange.html)
- *
- * 监听加速度数据事件。频率根据 [wx.startAccelerometer()](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.startAccelerometer.html) 的 interval 参数, 接口调用后会自动开始监听。
- *
- * **示例代码**
- *
- * ```js
- wx.onAccelerometerChange(callback)
- ``` */
- onAccelerometerChange(
- /** 加速度数据事件的回调函数 */
- callback: OnAccelerometerChangeCallback
- ): void
- /** [wx.onAddToFavorites(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onAddToFavorites.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 监听用户点击菜单「收藏」按钮时触发的事件(安卓7.0.15起支持,iOS 暂不支持) */
- onAddToFavorites(
- /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
- callback: OnAddToFavoritesCallback
- ): void
- /** [wx.onAudioInterruptionBegin(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onAudioInterruptionBegin.html)
- *
- * 需要基础库: `1.8.0`
- *
- * 监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后,小程序内所有音频会暂停。 */
- onAudioInterruptionBegin(
- /** 音频因为受到系统占用而被中断开始事件的回调函数 */
- callback: OnAudioInterruptionBeginCallback
- ): void
- /** [wx.onAudioInterruptionEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onAudioInterruptionEnd.html)
- *
- * 需要基础库: `1.8.0`
- *
- * 监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功 */
- onAudioInterruptionEnd(
- /** 音频中断结束事件的回调函数 */
- callback: OnAudioInterruptionEndCallback
- ): void
- /** [wx.onBLECharacteristicValueChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 监听蓝牙低功耗设备的特征值变化事件。必须先调用 [wx.notifyBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) 接口才能接收到设备推送的 notification。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- *
- * ```js
- // ArrayBuffer转16进制字符串示例
- function ab2hex(buffer) {
- let hexArr = Array.prototype.map.call(
- new Uint8Array(buffer),
- function(bit) {
- return ('00' + bit.toString(16)).slice(-2)
- }
- )
- return hexArr.join('');
- }
- wx.onBLECharacteristicValueChange(function(res) {
- console.log(`characteristic ${res.characteristicId} has changed, now is ${res.value}`)
- console.log(ab2hex(res.value))
- })
- ``` */
- onBLECharacteristicValueChange(
- /** 蓝牙低功耗设备的特征值变化事件的回调函数 */
- callback: OnBLECharacteristicValueChangeCallback
- ): void
- /** [wx.onBLEConnectionStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEConnectionStateChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 监听蓝牙低功耗连接状态的改变事件。包括开发者主动连接或断开连接,设备丢失,连接异常断开等等
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.onBLEConnectionStateChange(function(res) {
- // 该方法回调中可以用于处理连接意外断开等异常情况
- console.log(`device ${res.deviceId} state has changed, connected: ${res.connected}`)
- })
- ``` */
- onBLEConnectionStateChange(
- /** 蓝牙低功耗连接状态的改变事件的回调函数 */
- callback: OnBLEConnectionStateChangeCallback
- ): void
- /** [wx.onBLEMTUChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLEMTUChange.html)
- *
- * 需要基础库: `2.20.1`
- *
- * 监听蓝牙低功耗的最大传输单元变化事件(仅安卓触发)。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.onBLEMTUChange(function (res) {
- console.log('bluetooth mtu is', res.mtu)
- })
- ``` */
- onBLEMTUChange(
- /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
- callback: OnBLEMTUChangeCallback
- ): void
- /** [wx.onBLEPeripheralConnectionStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-peripheral/wx.onBLEPeripheralConnectionStateChanged.html)
- *
- * 需要基础库: `2.10.3`
- *
- * 监听当前外围设备被连接或断开连接事件 */
- onBLEPeripheralConnectionStateChanged(
- /** 当前外围设备被连接或断开连接事件的回调函数 */
- callback: OnBLEPeripheralConnectionStateChangedCallback
- ): void
- /** [wx.onBeaconServiceChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.onBeaconServiceChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 监听 Beacon 服务状态变化事件,仅能注册一个监听 */
- onBeaconServiceChange(
- /** Beacon 服务状态变化事件的回调函数 */
- callback: OnBeaconServiceChangeCallback
- ): void
- /** [wx.onBeaconUpdate(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.onBeaconUpdate.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 监听 Beacon 设备更新事件,仅能注册一个监听 */
- onBeaconUpdate(
- /** Beacon 设备更新事件的回调函数 */
- callback: OnBeaconUpdateCallback
- ): void
- /** [wx.onBluetoothAdapterStateChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.onBluetoothAdapterStateChange.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 监听蓝牙适配器状态变化事件
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.onBluetoothAdapterStateChange(function (res) {
- console.log('adapterState changed, now is', res)
- })
- ``` */
- onBluetoothAdapterStateChange(
- /** 蓝牙适配器状态变化事件的回调函数 */
- callback: OnBluetoothAdapterStateChangeCallback
- ): void
- /** [wx.onBluetoothDeviceFound(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.onBluetoothDeviceFound.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 监听搜索到新设备的事件
- *
- * **注意**
- *
- * - 若在 [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) 接口获取到的数组中。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- *
- * ```js
- // ArrayBuffer转16进度字符串示例
- function ab2hex(buffer) {
- var hexArr = Array.prototype.map.call(
- new Uint8Array(buffer),
- function(bit) {
- return ('00' + bit.toString(16)).slice(-2)
- }
- )
- return hexArr.join('');
- }
- wx.onBluetoothDeviceFound(function(res) {
- var devices = res.devices;
- console.log('new device list has founded')
- console.dir(devices)
- console.log(ab2hex(devices[0].advertisData))
- })
- ```
- *
- * **注意**
- *
- * - 蓝牙设备在被搜索到时,系统返回的 `name` 字段一般为广播包中的 `LocalName` 字段中的设备名称,而如果与蓝牙设备建立连接,系统返回的 `name` 字段会改为从蓝牙设备上获取到的 `GattName`。若需要动态改变设备名称并展示,建议使用 `localName` 字段。
- * - 安卓下部分机型需要有位置权限才能搜索到设备,需留意是否开启了位置权限 */
- onBluetoothDeviceFound(
- /** 搜索到新设备的事件的回调函数 */
- callback: OnBluetoothDeviceFoundCallback
- ): void
- /** [wx.onCompassChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.onCompassChange.html)
- *
- * 监听罗盘数据变化事件。频率:5 次/秒,接口调用后会自动开始监听,可使用 wx.stopCompass 停止监听。
- *
- * **accuracy 在 iOS/Android 的差异**
- *
- * 由于平台差异,accuracy 在 iOS/Android 的值不同。
- *
- * - iOS:accuracy 是一个 number 类型的值,表示相对于磁北极的偏差。0 表示设备指向磁北,90 表示指向东,180 表示指向南,依此类推。
- * - Android:accuracy 是一个 string 类型的枚举值。
- *
- * | 值 | 说明 |
- * | --------------- | -------------------------------------------------------------------------------------- |
- * | high | 高精度 |
- * | medium | 中等精度 |
- * | low | 低精度 |
- * | no-contact | 不可信,传感器失去连接 |
- * | unreliable | 不可信,原因未知 |
- * | unknow ${value} | 未知的精度枚举值,即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值 | */
- onCompassChange(
- /** 罗盘数据变化事件的回调函数 */
- callback: OnCompassChangeCallback
- ): void
- /** [wx.onCopyUrl(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onCopyUrl.html)
- *
- * 需要基础库: `2.14.3`
- *
- * 监听用户点击右上角菜单的「复制链接」按钮时触发的事件。本接口为 Beta 版本,暂只在 Android 平台支持。 */
- onCopyUrl(
- /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
- callback: OnCopyUrlCallback
- ): void
- /** [wx.onDeviceMotionChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.onDeviceMotionChange.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 监听设备方向变化事件。频率根据 [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) 停止监听。 */
- onDeviceMotionChange(
- /** 设备方向变化事件的回调函数 */
- callback: OnDeviceMotionChangeCallback
- ): void
- /** [wx.onDeviceOrientationChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/orientation/wx.onDeviceOrientationChange.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 监听横竖屏切换事件 */
- onDeviceOrientationChange(
- /** 横竖屏切换事件的回调函数 */
- callback: OnDeviceOrientationChangeCallback
- ): void
- /** [wx.onError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onError.html)
- *
- * 监听全局错误事件 */
- onError(
- /** 全局错误事件的回调函数 */
- callback: WxOnErrorCallback
- ): void
- /** [wx.onGyroscopeChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.onGyroscopeChange.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 监听陀螺仪数据变化事件。频率根据 [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) 停止监听。 */
- onGyroscopeChange(
- /** 陀螺仪数据变化事件的回调函数 */
- callback: OnGyroscopeChangeCallback
- ): void
- /** [wx.onHandoff(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onHandoff.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 监听用户点击菜单「在电脑上打开」按钮时触发的事件 */
- onHandoff(
- /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
- callback: OnHandoffCallback
- ): void
- /** [wx.onHide(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onHide.html)
- *
- * 监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。 */
- onHide(
- /** 小游戏隐藏到后台事件的回调函数 */
- callback: OnHideCallback
- ): void
- /** [wx.onInteractiveStorageModified(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.onInteractiveStorageModified.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 监听成功修改好友的互动型托管数据事件,该接口在游戏主域使用 */
- onInteractiveStorageModified(
- /** 事件发生的回调函数,只有一个参数为 `wx.modifyFriendInteractiveStorage` 传入的 key */
- callback: (...args: any[]) => any
- ): void
- /** [wx.onKeyDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyDown.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 监听键盘按键按下事件,仅适用于 PC 平台 */
- onKeyDown(
- /** 键盘按键按下事件的回调函数 */
- callback: OnKeyDownCallback
- ): void
- /** [wx.onKeyUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyUp.html)
- *
- * 需要基础库: `2.10.1`
- *
- * 监听键盘按键弹起事件,仅适用于 PC 平台 */
- onKeyUp(
- /** 键盘按键弹起事件的回调函数 */
- callback: OnKeyUpCallback
- ): void
- /** [wx.onKeyboardComplete(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardComplete.html)
- *
- * 监听监听键盘收起的事件 */
- onKeyboardComplete(
- /** 监听键盘收起的事件的回调函数 */
- callback: OnKeyboardCompleteCallback
- ): void
- /** [wx.onKeyboardConfirm(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardConfirm.html)
- *
- * 监听用户点击键盘 Confirm 按钮时的事件 */
- onKeyboardConfirm(
- /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
- callback: OnKeyboardConfirmCallback
- ): void
- /** [wx.onKeyboardHeightChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardHeightChange.html)
- *
- * 需要基础库: `2.21.3`
- *
- * 监听键盘高度变化
- *
- * **示例代码**
- *
- * ```js
- wx.onKeyboardHeightChange(res => {
- console.log(res.height)
- })
- ``` */
- onKeyboardHeightChange(callback: OnKeyboardHeightChangeCallback): void
- /** [wx.onKeyboardInput(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.onKeyboardInput.html)
- *
- * 监听键盘输入事件 */
- onKeyboardInput(
- /** 键盘输入事件的回调函数 */
- callback: OnKeyboardInputCallback
- ): void
- /** [wx.onMemoryWarning(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/memory/wx.onMemoryWarning.html)
- *
- * 需要基础库: `2.0.2`
- *
- * 监听内存不足告警事件。
- *
- * 当 iOS/Android 向小程序进程发出内存警告时,触发该事件。触发该事件不意味小程序被杀,大部分情况下仅仅是告警,开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。
- *
- * **示例代码**
- *
- * ```js
- * wx.onMemoryWarning(function () {
- * console.log('onMemoryWarningReceive')
- * })
- * `` */
- onMemoryWarning(
- /** 内存不足告警事件的回调函数 */
- callback: OnMemoryWarningCallback
- ): void
- /** [wx.onMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/open-api/context/wx.onMessage.html)
- *
- * 监听主域发送的消息 */
- onMessage(
- /** 监听事件的回调函数 */
- callback: (...args: any[]) => any
- ): void
- /** [wx.onMouseDown(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.onMouseDown.html)
- *
- * 监听鼠标按键按下事件 */
- onMouseDown(
- /** 鼠标按键按下事件的回调函数 */
- callback: OnMouseDownCallback
- ): void
- /** [wx.onMouseMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.onMouseMove.html)
- *
- * 监听鼠标移动事件 */
- onMouseMove(
- /** 鼠标移动事件的回调函数 */
- callback: OnMouseMoveCallback
- ): void
- /** [wx.onMouseUp(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/mouse-event/wx.onMouseUp.html)
- *
- * 监听鼠标按键弹起事件 */
- onMouseUp(
- /** 鼠标按键弹起事件的回调函数 */
- callback: OnMouseUpCallback
- ): void
- /** [wx.onNetworkStatusChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.onNetworkStatusChange.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 监听网络状态变化事件
- *
- * **示例代码**
- *
- * ```js
- wx.onNetworkStatusChange(function (res) {
- console.log(res.isConnected)
- console.log(res.networkType)
- })
- ``` */
- onNetworkStatusChange(
- /** 网络状态变化事件的回调函数 */
- callback: OnNetworkStatusChangeCallback
- ): void
- /** [wx.onNetworkWeakChange(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/network/wx.onNetworkWeakChange.html)
- *
- * 需要基础库: `2.21.0`
- *
- * 监听弱网状态变化事件
- *
- * **示例代码**
- *
- * ```js
- wx.onNetworkWeakChange(function (res) {
- console.log(res.weakNet)
- console.log(res.networkType)
- })
- // 取消监听
- wx.offNetworkWeakChange()
- ``` */
- onNetworkWeakChange(
- /** 弱网状态变化事件的回调函数 */
- callback: OnNetworkWeakChangeCallback
- ): void
- /** [wx.onShareAppMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onShareAppMessage.html)
- *
- * 监听用户点击右上角菜单的「转发」按钮时触发的事件 */
- onShareAppMessage(
- /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
- callback: OnShareAppMessageCallback
- ): void
- /** [wx.onShareMessageToFriend(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onShareMessageToFriend.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 监听主域接收 `wx.shareMessageToFriend` 接口的成功失败通知 */
- onShareMessageToFriend(
- /** 的回调函数 */
- callback: OnShareMessageToFriendCallback
- ): void
- /** [wx.onShareTimeline(function callback)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.onShareTimeline.html)
- *
- * 需要基础库: `2.11.3`
- *
- * 监听用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件。本接口为 Beta 版本,暂只在 Android 平台支持。 */
- onShareTimeline(
- /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
- callback: OnShareTimelineCallback
- ): void
- /** [wx.onShow(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/life-cycle/wx.onShow.html)
- *
- * 监听小游戏回到前台的事件 */
- onShow(
- /** 小游戏回到前台的事件的回调函数 */
- callback: OnShowCallback
- ): void
- /** [wx.onSocketClose(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketClose.html)
- *
- * 监听 WebSocket 连接关闭事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
- onSocketClose(
- /** WebSocket 连接关闭事件的回调函数 */
- callback: OnSocketCloseCallback
- ): void
- /** [wx.onSocketError(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketError.html)
- *
- * 监听 WebSocket 错误事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
- onSocketError(
- /** WebSocket 错误事件的回调函数 */
- callback: OnSocketErrorCallback
- ): void
- /** [wx.onSocketMessage(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketMessage.html)
- *
- * 监听 WebSocket 接受到服务器的消息事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
- onSocketMessage(
- /** WebSocket 接受到服务器的消息事件的回调函数 */
- callback: OnSocketMessageCallback
- ): void
- /** [wx.onSocketOpen(function callback)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.onSocketOpen.html)
- *
- * 监听 WebSocket 连接打开事件。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。** */
- onSocketOpen(
- /** WebSocket 连接打开事件的回调函数 */
- callback: OnSocketOpenCallback
- ): void
- /** [wx.onTouchCancel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchCancel.html)
- *
- * 监听触点失效事件 */
- onTouchCancel(
- /** 触点失效事件的回调函数 */
- callback: OnTouchCancelCallback
- ): void
- /** [wx.onTouchEnd(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchEnd.html)
- *
- * 监听触摸结束事件 */
- onTouchEnd(
- /** 触摸结束事件的回调函数 */
- callback: OnTouchEndCallback
- ): void
- /** [wx.onTouchMove(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchMove.html)
- *
- * 监听触点移动事件 */
- onTouchMove(
- /** 触点移动事件的回调函数 */
- callback: OnTouchMoveCallback
- ): void
- /** [wx.onTouchStart(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/touch-event/wx.onTouchStart.html)
- *
- * 监听开始触摸事件 */
- onTouchStart(
- /** 开始触摸事件的回调函数 */
- callback: OnTouchStartCallback
- ): void
- /** [wx.onUnhandledRejection(function callback)](https://developers.weixin.qq.com/minigame/dev/api/base/app/app-event/wx.onUnhandledRejection.html)
- *
- * 需要基础库: `2.10.0`
- *
- * 监听未处理的 Promise 拒绝事件
- *
- * **注意**
- *
- * 安卓平台暂时不会派发该事件 */
- onUnhandledRejection(
- /** 未处理的 Promise 拒绝事件的回调函数 */
- callback: OnUnhandledRejectionCallback
- ): void
- /** [wx.onUserCaptureScreen(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.onUserCaptureScreen.html)
- *
- * 需要基础库: `2.8.1`
- *
- * 监听用户主动截屏事件。用户使用系统截屏按键截屏时触发,只能注册一个监听
- *
- * **示例代码**
- *
- * ```js
- wx.onUserCaptureScreen(function (res) {
- console.log('用户截屏了')
- })
- ``` */
- onUserCaptureScreen(
- /** 用户主动截屏事件的回调函数 */
- callback: OnUserCaptureScreenCallback
- ): void
- /** [wx.onVoIPChatInterrupted(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatInterrupted.html)
- *
- * 需要基础库: `2.7.0`
- *
- * 监听被动断开实时语音通话事件。包括小游戏切入后端时断开 */
- onVoIPChatInterrupted(
- /** 被动断开实时语音通话事件的回调函数 */
- callback: OnVoIPChatInterruptedCallback
- ): void
- /** [wx.onVoIPChatMembersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatMembersChanged.html)
- *
- * 需要基础库: `2.7.0`
- *
- * 监听实时语音通话成员在线状态变化事件。有成员加入/退出通话时触发回调 */
- onVoIPChatMembersChanged(
- /** 实时语音通话成员在线状态变化事件的回调函数 */
- callback: OnVoIPChatMembersChangedCallback
- ): void
- /** [wx.onVoIPChatSpeakersChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatSpeakersChanged.html)
- *
- * 需要基础库: `2.7.0`
- *
- * 监听实时语音通话成员通话状态变化事件。有成员开始/停止说话时触发回调 */
- onVoIPChatSpeakersChanged(
- /** 实时语音通话成员通话状态变化事件的回调函数 */
- callback: OnVoIPChatSpeakersChangedCallback
- ): void
- /** [wx.onVoIPChatStateChanged(function callback)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.onVoIPChatStateChanged.html)
- *
- * 需要基础库: `2.16.0`
- *
- * 监听房间状态变化事件。 */
- onVoIPChatStateChanged(
- /** 房间状态变化事件的回调函数 */
- callback: OnVoIPChatStateChangedCallback
- ): void
- /** [wx.onWheel(function callback)](https://developers.weixin.qq.com/minigame/dev/api/device/wheel-event/wx.onWheel.html)
- *
- * 监听鼠标滚轮事件 */
- onWheel(
- /** 鼠标滚轮事件的回调函数 */
- callback: OnWheelCallback
- ): void
- /** [wx.onWindowResize(function callback)](https://developers.weixin.qq.com/minigame/dev/api/ui/window/wx.onWindowResize.html)
- *
- * 监听窗口尺寸变化事件 */
- onWindowResize(
- /** 窗口尺寸变化事件的回调函数 */
- callback: OnWindowResizeCallback
- ): void
- /** [wx.openBluetoothAdapter(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 初始化蓝牙模块。iOS 上开启主机/从机(外围设备)模式时需分别调用一次,并指定对应的 `mode`。
- *
- * **object.fail 回调函数返回的 state 参数(仅 iOS)**
- *
- * | 状态码 | 说明 |
- * | ------ | ------ |
- * | 0 | 未知 |
- * | 1 | 重置中 |
- * | 2 | 不支持 |
- * | 3 | 未授权 |
- * | 4 | 未开启 |
- *
- * **注意**
- *
- * - 其他蓝牙相关 API 必须在 [wx.openBluetoothAdapter](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.openBluetoothAdapter.html) 调用之后使用。否则 API 会返回错误(errCode=10000)。
- * - 在用户蓝牙开关未开启或者手机不支持蓝牙功能的情况下,调用 [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。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.openBluetoothAdapter({
- success (res) {
- console.log(res)
- }
- })
- ``` */
- openBluetoothAdapter<
- T extends OpenBluetoothAdapterOption = OpenBluetoothAdapterOption
- >(
- option?: T
- ): PromisifySuccessResult<T, OpenBluetoothAdapterOption>
- /** [wx.openCard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/card/wx.openCard.html)
- *
- * 需要基础库: `2.5.0`
- *
- * 查看微信卡包中的卡券。只有通过 [认证](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)。
- *
- * **示例代码**
- *
- * ```js
- wx.openCard({
- cardList: [{
- cardId: '',
- code: ''
- }, {
- cardId: '',
- code: ''
- }],
- success (res) { }
- })
- ``` */
- openCard<T extends OpenCardOption = OpenCardOption>(
- option: T
- ): PromisifySuccessResult<T, OpenCardOption>
- /** [wx.openChannelsActivity(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsActivity.html)
- *
- * 需要基础库: `2.19.2`
- *
- * 打开视频号视频 */
- openChannelsActivity(option: OpenChannelsActivityOption): void
- /** [wx.openChannelsEvent(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsEvent.html)
- *
- * 需要基础库: `2.21.0`
- *
- * 打开视频号活动页 */
- openChannelsEvent(option: OpenChannelsEventOption): void
- /** [wx.openChannelsLive(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsLive.html)
- *
- * 需要基础库: `2.15.0`
- *
- * 打开视频号直播 */
- openChannelsLive(option: OpenChannelsLiveOption): void
- /** [wx.openChannelsUserProfile(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.openChannelsUserProfile.html)
- *
- * 需要基础库: `2.21.2`
- *
- * 打开视频号主页 */
- openChannelsUserProfile(option: OpenChannelsUserProfileOption): void
- /** [wx.openCustomerServiceConversation(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/customer-message/wx.openCustomerServiceConversation.html)
- *
- * 需要基础库: `2.0.3`
- *
- * 进入客服会话。要求在用户发生过至少一次 touch 事件后才能调用。后台接入方式与小程序一致,详见 [客服消息接入](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/customer-message.html) */
- openCustomerServiceConversation<
- T extends OpenCustomerServiceConversationOption = OpenCustomerServiceConversationOption
- >(
- option: T
- ): PromisifySuccessResult<T, OpenCustomerServiceConversationOption>
- /** [wx.openSetting(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.openSetting.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 调起客户端小程序设置界面,返回用户设置的操作结果。**设置界面只会出现小程序已经向用户请求过的[权限](https://developers.weixin.qq.com/minigame/dev/guide/framework/authorize.html)**。
- *
- * ****
- *
- * - 注意:[2.3.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始,用户发生点击行为后,才可以跳转打开设置页,管理授权信息。[详情](https://developers.weixin.qq.com/community/develop/doc/000cea2305cc5047af5733de751008)
- *
- * **示例代码**
- *
- * ```js
- wx.openSetting({
- success (res) {
- console.log(res.authSetting)
- // res.authSetting = {
- // "scope.userInfo": true,
- // "scope.userLocation": true
- // }
- }
- })
- ``` */
- openSetting<T extends OpenSettingOption = OpenSettingOption>(
- option?: T
- ): PromisifySuccessResult<T, OpenSettingOption>
- /** [wx.previewImage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.previewImage.html)
- *
- * 在新页面中全屏预览图片。预览的过程中用户可以进行保存图片、发送给朋友等操作。
- *
- * **示例代码**
- *
- * ```js
- wx.previewImage({
- current: '', // 当前显示图片的http链接
- urls: [] // 需要预览的图片http链接列表
- })
- ``` */
- previewImage<T extends PreviewImageOption = PreviewImageOption>(
- option: T
- ): PromisifySuccessResult<T, PreviewImageOption>
- /** [wx.previewMedia(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.previewMedia.html)
- *
- * 需要基础库: `2.12.0`
- *
- * 预览图片和视频。 */
- previewMedia<T extends PreviewMediaOption = PreviewMediaOption>(
- option: T
- ): PromisifySuccessResult<T, PreviewMediaOption>
- /** [wx.readBLECharacteristicValue(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.readBLECharacteristicValue.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 读取蓝牙低功耗设备特征值的二进制数据。注意:必须设备的特征支持 read 才可以成功调用。
- *
- * **注意**
- *
- * - 并行调用多次会存在读失败的可能性。
- * - 接口读取到的信息需要在 [wx.onBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.onBLECharacteristicValueChange.html) 方法注册的回调中获取。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- // 必须在这里的回调才能获取
- wx.onBLECharacteristicValueChange(function(characteristic) {
- console.log('characteristic value comed:', characteristic)
- })
- wx.readBLECharacteristicValue({
- // 这里的 deviceId 需要已经通过 createBLEConnection 与对应设备建立链接
- deviceId,
- // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取
- serviceId,
- // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取
- characteristicId,
- success (res) {
- console.log('readBLECharacteristicValue:', res.errCode)
- }
- })
- ``` */
- readBLECharacteristicValue<
- T extends ReadBLECharacteristicValueOption = ReadBLECharacteristicValueOption
- >(
- option: T
- ): PromisifySuccessResult<T, ReadBLECharacteristicValueOption>
- /** [wx.removeStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.removeStorage.html)
- *
- * 从本地缓存中移除指定 key。缓存相关策略请查看 [存储](https://developers.weixin.qq.com/minigame/dev/guide/base-ability/storage.html)。
- *
- * **示例代码**
- *
- * ```js
- wx.removeStorage({
- key: 'key',
- success (res) {
- console.log(res)
- }
- })
- ```
- *
- * ```js
- try {
- wx.removeStorageSync('key')
- } catch (e) {
- // Do something when catch error
- }
- ``` */
- removeStorage<T extends RemoveStorageOption = RemoveStorageOption>(
- option: T
- ): PromisifySuccessResult<T, RemoveStorageOption>
- /** [wx.removeStorageSync(string key)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.removeStorageSync.html)
- *
- * [wx.removeStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.removeStorage.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- wx.removeStorage({
- key: 'key',
- success (res) {
- console.log(res)
- }
- })
- ```
- *
- * ```js
- try {
- wx.removeStorageSync('key')
- } catch (e) {
- // Do something when catch error
- }
- ``` */
- removeStorageSync(
- /** 本地缓存中指定的 key */
- key: string
- ): void
- /** [wx.removeUserCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.removeUserCloudStorage.html)
- *
- * 需要基础库: `1.9.92`
- *
- * 删除用户托管数据当中对应 key 的数据。 */
- removeUserCloudStorage<
- T extends RemoveUserCloudStorageOption = RemoveUserCloudStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, RemoveUserCloudStorageOption>
- /** [wx.reportEvent(string eventId, object data)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.reportEvent.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 事件上报 */
- reportEvent(
- /** 在 mp 实验系统中设置的事件英文名 */
- eventId: string,
- /** 可被 JSON.stringily 的对象,将一起上报至系统 */
- data?: IAnyObject
- ): void
- /** [wx.reportMonitor(string name, number value)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.reportMonitor.html)
- *
- * 需要基础库: `2.1.2`
- *
- * 自定义业务数据监控上报接口。
- *
- * **使用说明**
- *
- * 使用前,需要在「小程序管理后台-运维中心-性能监控-业务数据监控」中新建监控事件,配置监控描述与告警类型。每一个监控事件对应唯一的监控ID,开发者最多可以创建128个监控事件。
- *
- * **示例代码**
- *
- * ```js
- wx.reportMonitor('1', 1)
- ``` */
- reportMonitor(
- /** 监控ID,在「小程序管理后台」新建数据指标后获得 */
- name: string,
- /** 上报数值,经处理后会在「小程序管理后台」上展示每分钟的上报总量 */
- value: number
- ): void
- /** [wx.reportPerformance(Number id, Number value, String|Array dimensions)](https://developers.weixin.qq.com/minigame/dev/api/base/performance/wx.reportPerformance.html)
- *
- * 需要基础库: `2.10.0`
- *
- * 小程序测速上报。使用前,需要在小程序管理后台配置。 详情参见[小程序测速](https://developers.weixin.qq.com/miniprogram/dev/framework/performanceReport/)指南。
- *
- * **示例代码**
- *
- * ```js
- wx.reportPerformance(1101, 680)
- wx.reportPerformance(1101, 680, 'custom')
- ``` */
- reportPerformance(
- /** 指标 id */
- id: number,
- /** 需要上报的数值 */
- value: number,
- /** 自定义维度 (选填) */
- dimensions?: string | any[]
- ): void
- /** [wx.reportUserBehaviorBranchAnalytics(Object object)](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.reportUserBehaviorBranchAnalytics.html)
- *
- * 需要基础库: `2.12.0`
- *
- * 用于分支相关的UI组件(一般是按钮)相关事件的上报,事件目前有曝光、点击两种 */
- reportUserBehaviorBranchAnalytics(
- option: ReportUserBehaviorBranchAnalyticsOption
- ): void
- /** [wx.requestMidasFriendPayment(Object object)](https://developers.weixin.qq.com/minigame/dev/api/midas-payment/wx.requestMidasFriendPayment.html)
- *
- * 需要基础库: `2.11.0`
- *
- * 发起米大师朋友礼物索要。接口用法详见 [小游戏礼物索要接入指南](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/friend-payment.html)
- *
- * **示例代码**
- *
- * ```js
- wx.requestMidasFriendPayment({
- success(res) {
- // res
- {
- errMsg: 'requestMidasFriendPayment:ok',
- encryptedData: 'xxxx',
- iv: 'xxx'
- }
- },
- fail() {
- }
- })
- ```
- *
- * encryptedData 解密后数据结构如下:
- *
- * ```json
- {
- "outTradeNo": "xxxxxxxx",
- "orderNo": "PBgAAHMjeOhixxxx",
- "watermark": {
- "timestamp": 1585537091,
- "appid": "wx7a727ff7d940xxxx"
- }
- }
- ```
- *
- * **buyQuantity限制说明**
- *
- * 购买游戏币的时候,buyQuantity 不可任意填写。需满足 buyQuantity * 游戏币单价 = 限定的价格等级。如:游戏币单价为 0.1 元,一次购买最少数量是 10。
- *
- * 有效价格等级如下:
- *
- * | 价格等级(单位:人民币) |
- * |----------------------|
- * | 1 |
- * | 3 |
- * | 6 |
- * | 8 |
- * | 12 |
- * | 18 |
- * | 25 |
- * | 30 |
- * | 40 |
- * | 45 |
- * | 50 |
- * | 60 |
- * | 68 |
- * | 73 |
- * | 78 |
- * | 88 |
- * | 98 |
- * | 108 |
- * | 118 |
- * | 128 |
- * | 148 |
- * | 168 |
- * | 188 |
- * | 198 |
- * | 328 |
- * | 648 |
- * | 998 |
- * | 1998 |
- * | 2998 | */
- requestMidasFriendPayment(option: RequestMidasFriendPaymentOption): void
- /** [wx.requestMidasPayment(Object object)](https://developers.weixin.qq.com/minigame/dev/api/midas-payment/wx.requestMidasPayment.html)
- *
- * 发起米大师支付
- *
- * **buyQuantity 限制说明**
- *
- * 购买游戏币的时候,buyQuantity 不可任意填写。需满足 buyQuantity * 游戏币单价 = 限定的价格等级。如:游戏币单价为 0.1 元,一次购买最少数量是 10。
- *
- * 有效价格等级如下:
- *
- * | 价格等级(单位:人民币) |
- * |----------------------|
- * | 1 |
- * | 3 |
- * | 6 |
- * | 8 |
- * | 12 |
- * | 18 |
- * | 25 |
- * | 30 |
- * | 40 |
- * | 45 |
- * | 50 |
- * | 60 |
- * | 68 |
- * | 73 |
- * | 78 |
- * | 88 |
- * | 98 |
- * | 108 |
- * | 118 |
- * | 128 |
- * | 148 |
- * | 168 |
- * | 188 |
- * | 198 |
- * | 328 |
- * | 648 |
- * | 998 |
- * | 1998 |
- * | 2998 | */
- requestMidasPayment<
- T extends RequestMidasPaymentOption = RequestMidasPaymentOption
- >(
- option: T
- ): PromisifySuccessResult<T, RequestMidasPaymentOption>
- /** [wx.requestSubscribeMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html)
- *
- * 需要基础库: `2.4.4`
- *
- * 调起客户端小游戏订阅消息界面,返回用户订阅消息的操作结果。当用户勾选了订阅面板中的“总是保持以上选择,不再询问”时,模板消息会被添加到用户的小游戏设置页,通过 [wx.getSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html) 接口可获取用户对相关模板消息的订阅状态。
- *
- * ## 注意事项
- * - 一次性模板 id 和永久模板 id 不可同时使用。
- * - 低版本基础库2.4.4~2.8.3 已支持订阅消息接口调用,仅支持传入一个一次性 tmplId / 永久 tmplId。
- * - [2.8.2](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始,用户发生点击行为或者发起支付回调后,才可以调起订阅消息界面。
- * - [2.10.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 版本开始,开发版和体验版小游戏将禁止使用模板消息 fomrId。
- * - 使用前建议阅读 [小游戏订阅消息使用指引](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/subscribe-message.html)。
- * - 一次授权调用里,每个tmplId对应的模板标题不能存在相同的,若出现相同的,只保留一个。
- *
- * **错误码**
- *
- * | errCode | errMsg | 说明 |
- * | ------- | ------------------------------------------------------ | -------------------------------------------------------------- |
- * | 10001 | TmplIds can't be empty | 参数传空了 |
- * | 10002 | Request list fail | 网络问题,请求消息列表失败 |
- * | 10003 | Request subscribe fail | 网络问题,订阅请求发送失败 |
- * | 10004 | Invalid template id | 参数类型错误 |
- * | 10005 | Cannot show subscribe message UI | 无法展示 UI,一般是小游戏这个时候退后台了导致的 |
- * | 20001 | No template data return, verify the template id exist | 没有模板数据,一般是模板 ID 不存在 或者和模板类型不对应 导致的 |
- * | 20002 | Templates type must be same | 模板消息类型 既有一次性的又有永久的 |
- * | 20003 | Templates count out of max bounds | 模板消息数量超过上限 |
- * | 20004 | The main switch is switched off | 用户关闭了主开关,无法进行订阅 |
- * | 20005 | This mini program was banned from subscribing messages | 小游戏被禁封 |
- *
- * **示例代码**
- *
- * ```js
- wx.requestSubscribeMessage({
- tmplIds: [''],
- success (res) {
- console.log(res)
- res === {
- errMsg: "requestSubscribeMessage:ok",
- "zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE": "accept"
- }
- }
- })
- ``` */
- requestSubscribeMessage<
- T extends RequestSubscribeMessageOption = RequestSubscribeMessageOption
- >(
- option: T
- ): PromisifySuccessResult<T, RequestSubscribeMessageOption>
- /** [wx.requestSubscribeSystemMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeSystemMessage.html)
- *
- * 需要基础库: `2.9.4`
- *
- * 调起小游戏系统订阅消息界面,返回用户订阅消息的操作结果。当用户勾选了订阅面板中的“总是保持以上选择,不再询问”时,模板消息会被添加到用户的小游戏设置页,通过 [wx.getSetting](https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html) 接口可获取用户对相关模板消息的订阅状态。
- *
- * ## 注意事项
- * - 需要在 touchend 事件的回调中调用。
- * - 使用前建议阅读 [小游戏系统订阅消息使用指引](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/subscribe-system-message.html)。
- * - 系统订阅消息只需要订阅一次,永久有效。
- *
- * **错误码**
- *
- * | errCode | errMsg | 说明 |
- * | ------- | ------------------------------------------------------ | -------------------------------------------------------------- |
- * | 10001 | TmplIds can't be empty | 参数传空了 |
- * | 10002 | Request list fail | 网络问题,请求消息列表失败 |
- * | 10003 | Request subscribe fail | 网络问题,订阅请求发送失败 |
- * | 10004 | Invalid template id | 参数类型错误 |
- * | 10005 | Cannot show subscribe message UI | 无法展示 UI,一般是小游戏这个时候退后台了导致的 |
- * | 20004 | The main switch is switched off | 用户关闭了主开关,无法进行订阅 |
- * | 20005 | This mini program was banned from subscribing messages | 小游戏被禁封 |
- *
- * **示例代码**
- *
- * ```js
- wx.requestSubscribeSystemMessage({
- msgTypeList: ['SYS_MSG_TYPE_INTERACTIVE', 'SYS_MSG_TYPE_RANK'],
- success (res) {
- console.log(res)
- // res === {
- // errMsg: "requestSubscribeSystemMessage:ok",
- // SYS_MSG_TYPE_INTERACTIVE: "accept",
- // SYS_MSG_TYPE_RANK: 'reject'
- // }
- }
- })
- ``` */
- requestSubscribeSystemMessage<
- T extends RequestSubscribeSystemMessageOption = RequestSubscribeSystemMessageOption
- >(
- option: T
- ): PromisifySuccessResult<T, RequestSubscribeSystemMessageOption>
- /** [wx.reserveChannelsLive(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/channels/wx.reserveChannelsLive.html)
- *
- * 需要基础库: `2.19.0`
- *
- * 预约视频号直播 */
- reserveChannelsLive(option: ReserveChannelsLiveOption): void
- /** [wx.revokeBufferURL(string url)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.revokeBufferURL.html)
- *
- * 需要基础库: `2.14.0`
- *
- * 根据 URL 销毁存在内存中的数据 */
- revokeBufferURL(
- /** 需要销毁的二进制数据 URL */
- url: string
- ): void
- /** [wx.saveFileToDisk(Object object)](https://developers.weixin.qq.com/minigame/dev/api/file/wx.saveFileToDisk.html)
- *
- * 需要基础库: `2.11.0`
- *
- * 保存文件系统的文件到用户磁盘,仅在 PC 端支持
- *
- * **示例代码**
- *
- * ```js
- wx.saveFileToDisk({
- filePath: `${wx.env.USER_DATA_PATH}/hello.txt`,
- success(res) {
- console.log(res)
- },
- fail(res) {
- console.error(res)
- }
- })
- ``` */
- saveFileToDisk(option: SaveFileToDiskOption): void
- /** [wx.saveImageToPhotosAlbum(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/image/wx.saveImageToPhotosAlbum.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 保存图片到系统相册。
- *
- * **示例代码**
- *
- * ```js
- wx.saveImageToPhotosAlbum({
- success(res) { }
- })
- ``` */
- saveImageToPhotosAlbum<
- T extends SaveImageToPhotosAlbumOption = SaveImageToPhotosAlbumOption
- >(
- option: T
- ): PromisifySuccessResult<T, SaveImageToPhotosAlbumOption>
- /** [wx.scanCode(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/scan/wx.scanCode.html)
- *
- * 需要基础库: `2.16.1`
- *
- * 调起客户端扫码界面进行扫码
- *
- * **示例代码**
- *
- * ```js
- // 允许从相机和相册扫码
- wx.scanCode({
- success (res) {
- console.log(res)
- }
- })
- // 只允许从相机扫码
- wx.scanCode({
- onlyFromCamera: true,
- success (res) {
- console.log(res)
- }
- })
- ``` */
- scanCode<T extends ScanCodeOption = ScanCodeOption>(
- option: T
- ): PromisifySuccessResult<T, ScanCodeOption>
- /** [wx.sendSocketMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/wx.sendSocketMessage.html)
- *
- * 通过 WebSocket 连接发送数据。需要先 wx.connectSocket,并在 wx.onSocketOpen 回调之后才能发送。**推荐使用 [SocketTask](https://developers.weixin.qq.com/minigame/dev/api/network/websocket/SocketTask.html) 的方式去管理 webSocket 链接,每一条链路的生命周期都更加可控。同时存在多个 webSocket 的链接的情况下使用 wx 前缀的方法可能会带来一些和预期不一致的情况。**
- *
- * **示例代码**
- *
- * ```js
- let socketOpen = false
- let socketMsgQueue = []
- wx.connectSocket({
- url: 'test.php'
- })
- wx.onSocketOpen(function(res) {
- socketOpen = true
- for (let i = 0; i < socketMsgQueue.length; i++){
- sendSocketMessage(socketMsgQueue[i])
- }
- socketMsgQueue = []
- })
- function sendSocketMessage(msg) {
- if (socketOpen) {
- wx.sendSocketMessage({
- data:msg
- })
- } else {
- socketMsgQueue.push(msg)
- }
- }
- ``` */
- sendSocketMessage<
- T extends SendSocketMessageOption = SendSocketMessageOption
- >(
- option: T
- ): PromisifySuccessResult<T, SendSocketMessageOption>
- /** [wx.setBLEMTU(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.setBLEMTU.html)
- *
- * 需要基础库: `2.11.0`
- *
- * 协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU)。需在 [wx.createBLEConnection](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.createBLEConnection.html) 调用成功后调用。仅安卓系统 5.1 以上版本有效,iOS 因系统限制不支持。 */
- setBLEMTU<T extends SetBLEMTUOption = SetBLEMTUOption>(
- option: T
- ): PromisifySuccessResult<T, SetBLEMTUOption>
- /** [wx.setClipboardData(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/clipboard/wx.setClipboardData.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 设置系统剪贴板的内容。调用成功后,会弹出 toast 提示"内容已复制",持续 1.5s
- *
- * **示例代码**
- *
- * ```js
- wx.setClipboardData({
- data: 'data',
- success (res) {
- wx.getClipboardData({
- success (res) {
- console.log(res.data) // data
- }
- })
- }
- })
- ``` */
- setClipboardData<
- T extends SetClipboardDataOption = SetClipboardDataOption
- >(
- option: T
- ): PromisifySuccessResult<T, SetClipboardDataOption>
- /** [wx.setEnableDebug(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/debug/wx.setEnableDebug.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 设置是否打开调试开关。此开关对正式版也能生效。
- *
- * **示例代码**
- *
- * ```javascript
- // 打开调试
- wx.setEnableDebug({
- enableDebug: true
- })
- // 关闭调试
- wx.setEnableDebug({
- enableDebug: false
- })
- ```
- *
- * **Tips**
- *
- * - 在正式版打开调试还有一种方法,就是先在开发版或体验版打开调试,再切到正式版就能看到vConsole。 */
- setEnableDebug<T extends SetEnableDebugOption = SetEnableDebugOption>(
- option: T
- ): PromisifySuccessResult<T, SetEnableDebugOption>
- /** [wx.setInnerAudioOption(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/audio/wx.setInnerAudioOption.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 设置 [InnerAudioContext](https://developers.weixin.qq.com/minigame/dev/api/media/audio/InnerAudioContext.html) 的播放选项。设置之后对当前小程序全局生效。
- *
- * ****
- *
- * ## 注意事项
- * - 为保证微信整体体验,speakerOn 为 true 时,客户端会忽略 mixWithOthers 参数的内容,强制与其它音频互斥
- * - 不支持在播放音频的过程中切换为扬声器播放,开发者如需切换可以先暂停当前播放的音频并记录下当前暂停的时间点,然后切换后重新从原来暂停的时间点开始播放音频
- * - 目前 wx.setInnerAudioOption 接口不兼容 wx.createWebAudioContext 接口,也不兼容 wx.createInnerAudioContext 开启 useWebAudioImplement 的情况,将在后续版本中支持 */
- setInnerAudioOption<
- T extends SetInnerAudioOption = SetInnerAudioOption
- >(
- option: T
- ): PromisifySuccessResult<T, SetInnerAudioOption>
- /** [wx.setKeepScreenOn(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.setKeepScreenOn.html)
- *
- * 需要基础库: `1.4.0`
- *
- * 设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效。
- *
- * **示例代码**
- *
- * ```js
- wx.setKeepScreenOn({
- keepScreenOn: true
- })
- ``` */
- setKeepScreenOn<
- T extends SetKeepScreenOnOption = SetKeepScreenOnOption
- >(
- option: T
- ): PromisifySuccessResult<T, SetKeepScreenOnOption>
- /** [wx.setMenuStyle(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/menu/wx.setMenuStyle.html)
- *
- * 动态设置通过右上角按钮拉起的菜单的样式。 */
- setMenuStyle<T extends SetMenuStyleOption = SetMenuStyleOption>(
- option: T
- ): PromisifySuccessResult<T, SetMenuStyleOption>
- /** [wx.setPreferredFramesPerSecond(number fps)](https://developers.weixin.qq.com/minigame/dev/api/render/frame/wx.setPreferredFramesPerSecond.html)
- *
- * 可以修改渲染帧率。默认渲染帧率为 60 帧每秒。修改后,requestAnimationFrame 的回调频率会发生改变。 */
- setPreferredFramesPerSecond(
- /** 帧率,有效范围 1 - 60。 */
- fps: number
- ): void
- /** [wx.setScreenBrightness(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/screen/wx.setScreenBrightness.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 设置屏幕亮度 */
- setScreenBrightness<
- T extends SetScreenBrightnessOption = SetScreenBrightnessOption
- >(
- option: T
- ): PromisifySuccessResult<T, SetScreenBrightnessOption>
- /** [wx.setStatusBarStyle(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/statusbar/wx.setStatusBarStyle.html)
- *
- * 当在配置中设置 showStatusBarStyle 时,屏幕顶部会显示状态栏。此接口可以修改状态栏的样式。 */
- setStatusBarStyle<
- T extends SetStatusBarStyleOption = SetStatusBarStyleOption
- >(
- option: T
- ): PromisifySuccessResult<T, SetStatusBarStyleOption>
- /** [wx.setStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.setStorage.html)
- *
- * 将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。
- *
- * **示例代码**
- *
- * ```js
- wx.setStorage({
- key:"key",
- data:"value"
- })
- ```
- * ```js
- try {
- wx.setStorageSync('key', 'value')
- } catch (e) { }
- ```
- * ```js
- // 开启加密存储
- wx.setStorage({
- key: "key",
- data: "value",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success() {
- wx.getStorage({
- key: "key",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success(res) {
- console.log(res.data)
- }
- })
- }
- })
- ``` */
- setStorage<
- T = any,
- U extends SetStorageOption<T> = SetStorageOption<T>
- >(
- option: U
- ): PromisifySuccessResult<U, SetStorageOption<T>>
- /** [wx.setStorageSync(string key, any data, Boolean encrypt)](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.setStorageSync.html)
- *
- * [wx.setStorage](https://developers.weixin.qq.com/minigame/dev/api/storage/wx.setStorage.html) 的同步版本
- *
- * **示例代码**
- *
- * ```js
- wx.setStorage({
- key:"key",
- data:"value"
- })
- ```
- * ```js
- try {
- wx.setStorageSync('key', 'value')
- } catch (e) { }
- ```
- * ```js
- // 开启加密存储
- wx.setStorage({
- key: "key",
- data: "value",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success() {
- wx.getStorage({
- key: "key",
- encrypt: true, // 若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true
- success(res) {
- console.log(res.data)
- }
- })
- }
- })
- ``` */
- setStorageSync<T = any>(
- /** 本地缓存中指定的 key */
- key: string,
- /** 需要存储的内容。只支持原生类型、Date、及能够通过`JSON.stringify`序列化的对象。 */
- data: T,
- /** 需要基础库: `2.21.3`
- *
- * 是否开启加密存储。只有异步的 setStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 加密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true。此外,由于加密后的数据会比原始数据膨胀1.4倍,因此开启 encrypt 的情况下,单个 key 允许存储的最大数据长度为 0.7MB,所有数据存储上限为 7.1MB */
- encrypt?: boolean
- ): void
- /** [wx.setUserCloudStorage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.setUserCloudStorage.html)
- *
- * 需要基础库: `1.9.92`
- *
- * 对用户托管数据进行写数据操作。允许同时写多组 KV 数据。
- *
- * **托管数据的限制**
- *
- * 1. 每个openid所标识的微信用户在每个游戏上托管的数据不能超过128个key-value对。
- * 2. 上报的key-value列表当中每一项的key+value长度都不能超过1K(1024)字节。
- * 3. 上报的key-value列表当中每一个key长度都不能超过128字节。 */
- setUserCloudStorage<
- T extends SetUserCloudStorageOption = SetUserCloudStorageOption
- >(
- option: T
- ): PromisifySuccessResult<T, SetUserCloudStorageOption>
- /** [wx.setWindowSize(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/window/wx.setWindowSize.html)
- *
- * 需要基础库: `2.10.1`
- * @deprecated 基础库版本 [2.11.0](https://developers.weixin.qq.com/miniprogram/dev/framework/compatibility.html) 起已废弃
- *
- * 设置窗口大小,该接口仅适用于 PC 平台,使用细则请参见指南 */
- setWindowSize(option: SetWindowSizeOption): void
- /** [wx.shareAppMessage(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.shareAppMessage.html)
- *
- * 主动拉起转发,进入选择通讯录界面。 */
- shareAppMessage(option: ShareAppMessageOption): void
- /** [wx.shareMessageToFriend(Object object)](https://developers.weixin.qq.com/minigame/dev/api/open-api/data/wx.shareMessageToFriend.html)
- *
- * 需要基础库: `2.9.0`
- *
- * 给指定的好友分享游戏信息,该接口只可在开放数据域下使用。接收者打开之后,可以用 `wx.modifyFriendInteractiveStorage` 传入参数 quiet=true 发起一次无需弹框确认的好友互动。
- *
- * ****
- *
- * 定向分享不允许直接在开放数据域设置 query 参数
- * 需要设置请参见游戏域 `wx.setMessageToFriendQuery` 接口 */
- shareMessageToFriend(option: ShareMessageToFriendOption): void
- /** [wx.showActionSheet(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showActionSheet.html)
- *
- * 显示操作菜单
- *
- * **示例代码**
- *
- * ```js
- wx.showActionSheet({
- itemList: ['A', 'B', 'C'],
- success (res) {
- console.log(res.tapIndex)
- },
- fail (res) {
- console.log(res.errMsg)
- }
- })
- ```
- *
- * **注意**
- *
- * - Android 6.7.2 以下版本,点击取消或蒙层时,回调 fail, errMsg 为 "fail cancel";
- * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗,所以尽量避免使用「取消」分支中实现业务逻辑 */
- showActionSheet<
- T extends ShowActionSheetOption = ShowActionSheetOption
- >(
- option: T
- ): PromisifySuccessResult<T, ShowActionSheetOption>
- /** [wx.showKeyboard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.showKeyboard.html)
- *
- * 显示键盘 */
- showKeyboard<T extends ShowKeyboardOption = ShowKeyboardOption>(
- option: T
- ): PromisifySuccessResult<T, ShowKeyboardOption>
- /** [wx.showLoading(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showLoading.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框
- *
- * **示例代码**
- *
- * ```js
- wx.showLoading({
- title: '加载中',
- })
- setTimeout(function () {
- wx.hideLoading()
- }, 2000)
- ```
- *
- * **注意**
- *
- * - [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) 同时只能显示一个
- * - [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) 配对使用 */
- showLoading<T extends ShowLoadingOption = ShowLoadingOption>(
- option: T
- ): PromisifySuccessResult<T, ShowLoadingOption>
- /** [wx.showModal(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showModal.html)
- *
- * 显示模态对话框
- *
- * **示例代码**
- *
- * ```js
- wx.showModal({
- title: '提示',
- content: '这是一个模态弹窗',
- success (res) {
- if (res.confirm) {
- console.log('用户点击确定')
- } else if (res.cancel) {
- console.log('用户点击取消')
- }
- }
- })
- ```
- *
- * **注意**
- *
- * - Android 6.7.2 以下版本,点击取消或蒙层时,回调 fail, errMsg 为 "fail cancel";
- * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗,所以尽量避免使用「取消」分支中实现业务逻辑
- * - 自基础库 2.17.1 版本起,支持传入 editable 参数,显示带输入框的弹窗 */
- showModal<T extends ShowModalOption = ShowModalOption>(
- option: T
- ): PromisifySuccessResult<T, ShowModalOption>
- /** [wx.showShareImageMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.showShareImageMenu.html)
- *
- * 需要基础库: `2.14.3`
- *
- * 打开分享图片弹窗,可以将图片发送给朋友、收藏或下载 */
- showShareImageMenu<
- T extends ShowShareImageMenuOption = ShowShareImageMenuOption
- >(
- option: T
- ): PromisifySuccessResult<T, ShowShareImageMenuOption>
- /** [wx.showShareMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.showShareMenu.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 显示当前页面的转发按钮
- *
- * ****
- *
- * ## 注意事项
- * - "shareAppMessage"表示“发送给朋友”按钮,"shareTimeline"表示“分享到朋友圈”按钮
- * - 显示“分享到朋友圈”按钮时必须同时显示“发送给朋友”按钮,显示“发送给朋友”按钮时则允许不显示“分享到朋友圈”按钮
- *
- * **示例代码**
- *
- * ```js
- wx.showShareMenu({
- withShareTicket: true,
- menus: ['shareAppMessage', 'shareTimeline']
- })
- ``` */
- showShareMenu<T extends ShowShareMenuOption = ShowShareMenuOption>(
- option: T
- ): PromisifySuccessResult<T, ShowShareMenuOption>
- /** [wx.showToast(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ui/interaction/wx.showToast.html)
- *
- * 显示消息提示框
- *
- * **示例代码**
- *
- * ```js
- wx.showToast({
- title: '成功',
- icon: 'success',
- duration: 2000
- })
- ```
- *
- * **注意**
- *
- * - [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) 同时只能显示一个
- * - [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) 配对使用 */
- showToast<T extends ShowToastOption = ShowToastOption>(
- option: T
- ): PromisifySuccessResult<T, ShowToastOption>
- /** [wx.startAccelerometer(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.startAccelerometer.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 开始监听加速度数据。
- *
- * **示例代码**
- *
- * ```js
- wx.startAccelerometer({
- interval: 'game'
- })
- ```
- *
- * **注意**
- *
- * - 根据机型性能、当前 CPU 与内存的占用情况,`interval` 的设置与实际 `wx.onAccelerometerChange()` 回调函数的执行频率会有一些出入。 */
- startAccelerometer<
- T extends StartAccelerometerOption = StartAccelerometerOption
- >(
- option?: T
- ): PromisifySuccessResult<T, StartAccelerometerOption>
- /** [wx.startBeaconDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.startBeaconDiscovery.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 开始搜索附近的 Beacon 设备
- *
- * **示例代码**
- *
- * ```js
- wx.startBeaconDiscovery({
- success(res) { }
- })
- ``` */
- startBeaconDiscovery<
- T extends StartBeaconDiscoveryOption = StartBeaconDiscoveryOption
- >(
- option: T
- ): PromisifySuccessResult<T, StartBeaconDiscoveryOption>
- /** [wx.startBluetoothDevicesDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.startBluetoothDevicesDiscovery.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 开始搜寻附近的蓝牙外围设备。
- *
- * **此操作比较耗费系统资源,请在搜索到需要的设备后及时调用 [wx.stopBluetoothDevicesDiscovery](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.stopBluetoothDevicesDiscovery.html) 停止搜索。**
- *
- * **注意**
- *
- * - 考虑到蓝牙功能可以间接进行定位,安卓 6.0 及以上版本,无定位权限或定位开关未打开时,无法进行设备搜索。这种情况下,安卓 8.0.16 前,接口调用成功但无法扫描设备;8.0.16 及以上版本,会返回错误。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/m7klFDmZ72i1)
- *
- * ```js
- // 以微信硬件平台的蓝牙智能灯为例,主服务的 UUID 是 FEE7。传入这个参数,只搜索主服务 UUID 为 FEE7 的设备
- wx.startBluetoothDevicesDiscovery({
- services: ['FEE7'],
- success (res) {
- console.log(res)
- }
- })
- ``` */
- startBluetoothDevicesDiscovery<
- T extends StartBluetoothDevicesDiscoveryOption = StartBluetoothDevicesDiscoveryOption
- >(
- option: T
- ): PromisifySuccessResult<T, StartBluetoothDevicesDiscoveryOption>
- /** [wx.startCompass(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.startCompass.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 开始监听罗盘数据
- *
- * **示例代码**
- *
- * ```js
- wx.startCompass()
- ``` */
- startCompass<T extends StartCompassOption = StartCompassOption>(
- option?: T
- ): PromisifySuccessResult<T, StartCompassOption>
- /** [wx.startDeviceMotionListening(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.startDeviceMotionListening.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 开始监听设备方向的变化。 */
- startDeviceMotionListening<
- T extends StartDeviceMotionListeningOption = StartDeviceMotionListeningOption
- >(
- option?: T
- ): PromisifySuccessResult<T, StartDeviceMotionListeningOption>
- /** [wx.startGyroscope(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.startGyroscope.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 开始监听陀螺仪数据。 */
- startGyroscope<T extends StartGyroscopeOption = StartGyroscopeOption>(
- option?: T
- ): PromisifySuccessResult<T, StartGyroscopeOption>
- /** [wx.startHandoff(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.startHandoff.html)
- *
- * 需要基础库: `2.14.4`
- *
- * 开始进行接力,该接口需要在开放数据域调用 */
- startHandoff(option?: StartHandoffOption): void
- /** [wx.stopAccelerometer(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/accelerometer/wx.stopAccelerometer.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 停止监听加速度数据。
- *
- * **示例代码**
- *
- * ```js
- wx.stopAccelerometer()
- ``` */
- stopAccelerometer<
- T extends StopAccelerometerOption = StopAccelerometerOption
- >(
- option?: T
- ): PromisifySuccessResult<T, StopAccelerometerOption>
- /** [wx.stopBeaconDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/ibeacon/wx.stopBeaconDiscovery.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 停止搜索附近的 Beacon 设备 */
- stopBeaconDiscovery<
- T extends StopBeaconDiscoveryOption = StopBeaconDiscoveryOption
- >(
- option?: T
- ): PromisifySuccessResult<T, StopBeaconDiscoveryOption>
- /** [wx.stopBluetoothDevicesDiscovery(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth/wx.stopBluetoothDevicesDiscovery.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时,建议调用该接口停止蓝牙搜索。
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- wx.stopBluetoothDevicesDiscovery({
- success (res) {
- console.log(res)
- }
- })
- ``` */
- stopBluetoothDevicesDiscovery<
- T extends StopBluetoothDevicesDiscoveryOption = StopBluetoothDevicesDiscoveryOption
- >(
- option?: T
- ): PromisifySuccessResult<T, StopBluetoothDevicesDiscoveryOption>
- /** [wx.stopCompass(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/compass/wx.stopCompass.html)
- *
- * 需要基础库: `1.1.0`
- *
- * 停止监听罗盘数据
- *
- * **示例代码**
- *
- * ```js
- wx.stopCompass()
- ``` */
- stopCompass<T extends StopCompassOption = StopCompassOption>(
- option?: T
- ): PromisifySuccessResult<T, StopCompassOption>
- /** [wx.stopDeviceMotionListening(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/motion/wx.stopDeviceMotionListening.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 停止监听设备方向的变化。 */
- stopDeviceMotionListening<
- T extends StopDeviceMotionListeningOption = StopDeviceMotionListeningOption
- >(
- option?: T
- ): PromisifySuccessResult<T, StopDeviceMotionListeningOption>
- /** [wx.stopFaceDetect(Object object)](https://developers.weixin.qq.com/minigame/dev/api/ai/face/wx.stopFaceDetect.html)
- *
- * 需要基础库: `2.18.0`
- *
- * 停止人脸识别 */
- stopFaceDetect(option?: StopFaceDetectOption): void
- /** [wx.stopGyroscope(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/gyroscope/wx.stopGyroscope.html)
- *
- * 需要基础库: `2.3.0`
- *
- * 停止监听陀螺仪数据。 */
- stopGyroscope<T extends StopGyroscopeOption = StopGyroscopeOption>(
- option?: T
- ): PromisifySuccessResult<T, StopGyroscopeOption>
- /** [wx.triggerGC()](https://developers.weixin.qq.com/minigame/dev/api/base/performance/wx.triggerGC.html)
- *
- * 加快触发 JavaScriptCore 垃圾回收(Garbage Collection)。GC 时机是由 JavaScriptCore 来控制的,并不能保证调用后马上触发 GC。 */
- triggerGC(): void
- /** [wx.updateKeyboard(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/keyboard/wx.updateKeyboard.html)
- *
- * 需要基础库: `2.1.0`
- *
- * 更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果 */
- updateKeyboard<T extends UpdateKeyboardOption = UpdateKeyboardOption>(
- option: T
- ): PromisifySuccessResult<T, UpdateKeyboardOption>
- /** [wx.updateShareMenu(Object object)](https://developers.weixin.qq.com/minigame/dev/api/share/wx.updateShareMenu.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 更新转发属性
- *
- * **示例代码**
- *
- * ```js
- wx.updateShareMenu({
- withShareTicket: true,
- success () { }
- })
- ```
- * ```js
- // 转发私密消息
- wx.updateShareMenu({
- isPrivateMessage: true,
- activityId: 'xxx',
- templateInfo: {},
- success () { },
- fail () {}
- })
- ``` */
- updateShareMenu<
- T extends UpdateShareMenuOption = UpdateShareMenuOption
- >(
- option: T
- ): PromisifySuccessResult<T, UpdateShareMenuOption>
- /** [wx.updateVoIPChatMuteConfig(Object object)](https://developers.weixin.qq.com/minigame/dev/api/media/voip/wx.updateVoIPChatMuteConfig.html)
- *
- * 需要基础库: `2.7.0`
- *
- * 更新实时语音静音设置 */
- updateVoIPChatMuteConfig<
- T extends UpdateVoIPChatMuteConfigOption = UpdateVoIPChatMuteConfigOption
- >(
- option: T
- ): PromisifySuccessResult<T, UpdateVoIPChatMuteConfigOption>
- /** [wx.updateWeChatApp(Object object)](https://developers.weixin.qq.com/minigame/dev/api/base/update/wx.updateWeChatApp.html)
- *
- * 需要基础库: `2.12.0`
- *
- * 更新客户端版本。当判断用户小程序所在客户端版本过低时,可使用该接口跳转到更新微信页面。 */
- updateWeChatApp<
- T extends UpdateWeChatAppOption = UpdateWeChatAppOption
- >(
- option?: T
- ): PromisifySuccessResult<T, UpdateWeChatAppOption>
- /** [wx.vibrateLong(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/vibrate/wx.vibrateLong.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 使手机发生较长时间的振动(400 ms) */
- vibrateLong<T extends VibrateLongOption = VibrateLongOption>(
- option?: T
- ): PromisifySuccessResult<T, VibrateLongOption>
- /** [wx.vibrateShort(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/vibrate/wx.vibrateShort.html)
- *
- * 需要基础库: `1.2.0`
- *
- * 使手机发生较短时间的振动(15 ms)。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效 */
- vibrateShort<T extends VibrateShortOption = VibrateShortOption>(
- option: T
- ): PromisifySuccessResult<T, VibrateShortOption>
- /** [wx.writeBLECharacteristicValue(Object object)](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.writeBLECharacteristicValue.html)
- *
- * 需要基础库: `2.9.2`
- *
- * 向蓝牙低功耗设备特征值中写入二进制数据。注意:必须设备的特征支持 write 才可以成功调用。
- *
- * **注意**
- *
- * - 并行调用多次会存在写失败的可能性。
- * - 小程序不会对写入数据包大小做限制,但系统与蓝牙设备会限制蓝牙 4.0 单次传输的数据大小,超过最大字节数后会发生写入错误,建议每次写入不超过 20 字节。
- * - 若单次写入数据过长,iOS 上存在系统不会有任何回调的情况(包括错误回调)。
- * - 安卓平台上,在调用 [wx.notifyBLECharacteristicValueChange](https://developers.weixin.qq.com/minigame/dev/api/device/bluetooth-ble/wx.notifyBLECharacteristicValueChange.html) 成功后立即调用本接口,在部分机型上会发生 10008 系统错误
- *
- * **示例代码**
- *
- * [在微信开发者工具中查看示例](https://developers.weixin.qq.com/s/pQU51zmz7a3K)
- * ```js
- // 向蓝牙设备发送一个0x00的16进制数据
- let buffer = new ArrayBuffer(1)
- let dataView = new DataView(buffer)
- dataView.setUint8(0, 0)
- wx.writeBLECharacteristicValue({
- // 这里的 deviceId 需要在 getBluetoothDevices 或 onBluetoothDeviceFound 接口中获取
- deviceId,
- // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取
- serviceId,
- // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取
- characteristicId,
- // 这里的value是ArrayBuffer类型
- value: buffer,
- success (res) {
- console.log('writeBLECharacteristicValue success', res.errMsg)
- }
- })
- ``` */
- writeBLECharacteristicValue<
- T extends WriteBLECharacteristicValueOption = WriteBLECharacteristicValueOption
- >(
- option: T
- ): PromisifySuccessResult<T, WriteBLECharacteristicValueOption>
- /** 小程序云开发 */
- cloud: WxCloud
- /** 文件系统中的用户目录路径 */
- env: { USER_DATA_PATH: string }
- }
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type AccessCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type AccessFailCallback = (result: AccessFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type AccessSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type AddCardCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type AddCardFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type AddCardSuccessCallback = (result: AddCardSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type AddServiceCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type AddServiceFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type AddServiceSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type AppendFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type AppendFileFailCallback = (result: AppendFileFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type AppendFileSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type AuthPrivateMessageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type AuthPrivateMessageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type AuthPrivateMessageSuccessCallback = (
- result: AuthPrivateMessageSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type AuthorizeCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type AuthorizeFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type AuthorizeSuccessCallback = (res: GeneralCallbackResult) => void
- type BannerAdOffErrorCallback = (
- result: BannerAdOnErrorCallbackResult
- ) => void
- type BannerAdOffResizeCallback = (result: OnResizeCallbackResult) => void
- type BannerAdOnErrorCallback = (
- result: BannerAdOnErrorCallbackResult
- ) => void
- type BannerAdOnResizeCallback = (result: OnResizeCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type BroadcastInRoomCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type BroadcastInRoomFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type BroadcastInRoomSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CancelMatchCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type CancelMatchFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CancelMatchSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ChangeSeatCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ChangeSeatFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ChangeSeatSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CheckHandoffEnabledCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type CheckHandoffEnabledFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CheckHandoffEnabledSuccessCallback = (
- result: CheckHandoffEnabledSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CheckIsUserAdvisedToRestCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type CheckIsUserAdvisedToRestFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type CheckIsUserAdvisedToRestSuccessCallback = (
- result: CheckIsUserAdvisedToRestSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CheckSessionCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type CheckSessionFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CheckSessionSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ChooseImageCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ChooseImageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ChooseImageSuccessCallback = (
- result: ChooseImageSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ClearStorageCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ClearStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ClearStorageSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CloseBLEConnectionCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type CloseBLEConnectionFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type CloseBLEConnectionSuccessCallback = (res: BluetoothError) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CloseBluetoothAdapterCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type CloseBluetoothAdapterFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type CloseBluetoothAdapterSuccessCallback = (res: BluetoothError) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CloseCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CloseSocketCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type CloseSocketFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CloseSocketSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CloseSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ConnectSocketCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ConnectSocketFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ConnectSocketSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CopyFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type CopyFileFailCallback = (result: CopyFileFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CopyFileSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CreateBLEConnectionCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type CreateBLEConnectionFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type CreateBLEConnectionSuccessCallback = (res: BluetoothError) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CreateBLEPeripheralServerCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type CreateBLEPeripheralServerFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type CreateBLEPeripheralServerSuccessCallback = (
- result: CreateBLEPeripheralServerSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CreateCameraCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type CreateCameraFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CreateCameraSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type CreateRoomCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type CreateRoomFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type CreateRoomSuccessCallback = (
- result: CreateRoomSuccessCallbackResult
- ) => void
- /** 原生模板广告错误事件的回调函数 */
- type CustomAdOffErrorCallback = (
- result: CustomAdOnErrorCallbackResult
- ) => void
- /** 原生模板广告错误事件的回调函数 */
- type CustomAdOnErrorCallback = (
- result: CustomAdOnErrorCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type DownloadFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type DownloadFileFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type DownloadFileSuccessCallback = (
- result: DownloadFileSuccessCallbackResult
- ) => void
- /** 下载进度变化事件的回调函数 */
- type DownloadTaskOffProgressUpdateCallback = (
- result: DownloadTaskOnProgressUpdateCallbackResult
- ) => void
- /** 下载进度变化事件的回调函数 */
- type DownloadTaskOnProgressUpdateCallback = (
- result: DownloadTaskOnProgressUpdateCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type EndGameCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type EndGameFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type EndGameSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type EndStateServiceCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type EndStateServiceFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type EndStateServiceSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ExitMiniProgramCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ExitMiniProgramFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ExitMiniProgramSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ExitVoIPChatCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ExitVoIPChatFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ExitVoIPChatSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type FaceDetectCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type FaceDetectFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type FaceDetectSuccessCallback = (
- result: FaceDetectSuccessCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type FileSystemManagerCloseFailCallback = (
- result: CloseFailCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type FileSystemManagerGetFileInfoFailCallback = (
- result: GetFileInfoFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type FileSystemManagerGetFileInfoSuccessCallback = (
- result: FileSystemManagerGetFileInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type FstatCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type FstatFailCallback = (result: FstatFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type FstatSuccessCallback = (result: FstatSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type FtruncateCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type FtruncateFailCallback = (result: FtruncateFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type FtruncateSuccessCallback = (res: GeneralCallbackResult) => void
- type GameBannerOffErrorCallback = (
- result: GameBannerOnErrorCallbackResult
- ) => void
- type GameBannerOffResizeCallback = (res: GeneralCallbackResult) => void
- type GameBannerOnErrorCallback = (
- result: GameBannerOnErrorCallbackResult
- ) => void
- type GameBannerOnResizeCallback = (res: GeneralCallbackResult) => void
- type GameClubButtonOffTapCallback = (res: GeneralCallbackResult) => void
- type GameClubButtonOnTapCallback = (res: GeneralCallbackResult) => void
- /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
- type GamePortalOffErrorCallback = (
- result: GamePortalOnErrorCallbackResult
- ) => void
- /** 小游戏推荐弹窗组件加载错误事件的回调函数 */
- type GamePortalOnErrorCallback = (
- result: GamePortalOnErrorCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetAvailableAudioSourcesCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetAvailableAudioSourcesFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetAvailableAudioSourcesSuccessCallback = (
- result: GetAvailableAudioSourcesSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBLEDeviceCharacteristicsCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type GetBLEDeviceCharacteristicsFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type GetBLEDeviceCharacteristicsSuccessCallback = (
- result: GetBLEDeviceCharacteristicsSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBLEDeviceRSSICompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetBLEDeviceRSSIFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetBLEDeviceRSSISuccessCallback = (
- result: GetBLEDeviceRSSISuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBLEDeviceServicesCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type GetBLEDeviceServicesFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type GetBLEDeviceServicesSuccessCallback = (
- result: GetBLEDeviceServicesSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBLEMTUCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type GetBLEMTUFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type GetBLEMTUSuccessCallback = (
- result: GetBLEMTUSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBatteryInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetBatteryInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetBatteryInfoSuccessCallback = (
- result: GetBatteryInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBeaconsCompleteCallback = (res: BeaconError) => void
- /** 接口调用失败的回调函数 */
- type GetBeaconsFailCallback = (res: BeaconError) => void
- /** 接口调用成功的回调函数 */
- type GetBeaconsSuccessCallback = (
- result: GetBeaconsSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBluetoothAdapterStateCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type GetBluetoothAdapterStateFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type GetBluetoothAdapterStateSuccessCallback = (
- result: GetBluetoothAdapterStateSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetBluetoothDevicesCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type GetBluetoothDevicesFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type GetBluetoothDevicesSuccessCallback = (
- result: GetBluetoothDevicesSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetChannelsLiveInfoCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetChannelsLiveInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetChannelsLiveInfoSuccessCallback = (
- result: GetChannelsLiveInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetChannelsLiveNoticeInfoCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetChannelsLiveNoticeInfoFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetChannelsLiveNoticeInfoSuccessCallback = (
- result: GetChannelsLiveNoticeInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetClipboardDataCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetClipboardDataFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetClipboardDataSuccessCallback = (
- option: GetClipboardDataSuccessCallbackOption
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetConnectedBluetoothDevicesCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type GetConnectedBluetoothDevicesFailCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用成功的回调函数 */
- type GetConnectedBluetoothDevicesSuccessCallback = (
- result: GetConnectedBluetoothDevicesSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetExtConfigCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetExtConfigFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetExtConfigSuccessCallback = (
- result: GetExtConfigSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetFileInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetFriendCloudStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetFriendCloudStorageFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetFriendCloudStorageSuccessCallback = (
- result: GetFriendCloudStorageSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetFriendsStateDataCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetFriendsStateDataFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetFriendsStateDataSuccessCallback = (result: Res) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetGroupCloudStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetGroupCloudStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetGroupCloudStorageSuccessCallback = (
- result: GetGroupCloudStorageSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetGroupEnterInfoCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetGroupEnterInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetGroupEnterInfoSuccessCallback = (
- result: GetGroupEnterInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetGroupInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetGroupInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetGroupInfoSuccessCallback = (
- result: GetGroupInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetLastRoomInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetLastRoomInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetLastRoomInfoSuccessCallback = (
- result: GetLastRoomInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetLatestUserKeyCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetLatestUserKeyFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetLatestUserKeySuccessCallback = (
- result: GetLatestUserKeySuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetLocalIPAddressCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetLocalIPAddressFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetLocalIPAddressSuccessCallback = (
- result: GetLocalIPAddressSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetLocationCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetLocationFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetLocationSuccessCallback = (
- result: GetLocationSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetLostFramesCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetLostFramesFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetLostFramesSuccessCallback = (
- result: GetLostFramesSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetNetworkTypeCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetNetworkTypeFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetNetworkTypeSuccessCallback = (
- result: GetNetworkTypeSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetPotentialFriendListCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetPotentialFriendListFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetPotentialFriendListSuccessCallback = (
- result: GetPotentialFriendListSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetRandomValuesCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetRandomValuesFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetRandomValuesSuccessCallback = (
- result: GetRandomValuesSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetRoomInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetRoomInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetRoomInfoSuccessCallback = (
- result: GetRoomInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetSavedFileListCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetSavedFileListFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetSavedFileListSuccessCallback = (
- result: GetSavedFileListSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetScreenBrightnessCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetScreenBrightnessFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetScreenBrightnessSuccessCallback = (
- option: GetScreenBrightnessSuccessCallbackOption
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetSettingCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetSettingFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetSettingSuccessCallback = (
- result: GetSettingSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetShareInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetShareInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetShareInfoSuccessCallback = (
- result: GetGroupEnterInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetStorageCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetStorageInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetStorageInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetStorageInfoSuccessCallback = (
- option: GetStorageInfoSuccessCallbackOption
- ) => void
- /** 接口调用成功的回调函数 */
- type GetStorageSuccessCallback<T = any> = (
- result: GetStorageSuccessCallbackResult<T>
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetSystemInfoAsyncCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetSystemInfoAsyncFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetSystemInfoAsyncSuccessCallback = (result: SystemInfo) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetSystemInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetSystemInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetSystemInfoSuccessCallback = (result: SystemInfo) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetTextLineHeightCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetTextLineHeightFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetTextLineHeightSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetUserCloudStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetUserCloudStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetUserCloudStorageKeysCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetUserCloudStorageKeysFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetUserCloudStorageKeysSuccessCallback = (
- result: GetUserCloudStorageKeysSuccessCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetUserCloudStorageSuccessCallback = (
- result: GetUserCloudStorageSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetUserInfoCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetUserInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetUserInfoSuccessCallback = (
- result: GetUserInfoSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetUserInteractiveStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type GetUserInteractiveStorageFailCallback = (
- result: GetUserInteractiveStorageFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type GetUserInteractiveStorageSuccessCallback = (
- result: GetUserInteractiveStorageSuccessCallbackResult,
- /** 加密算法的初始向量,详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/guide/open-ability/signature.html#加密数据解密算法) */
- iv: string
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type GetWeRunDataCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type GetWeRunDataFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type GetWeRunDataSuccessCallback = (
- result: GetWeRunDataSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type HideKeyboardCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type HideKeyboardFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type HideKeyboardSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type HideLoadingCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type HideLoadingFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type HideLoadingSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type HideShareMenuCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type HideShareMenuFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type HideShareMenuSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type HideToastCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type HideToastFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type HideToastSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type InitFaceDetectCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type InitFaceDetectFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type InitFaceDetectSuccessCallback = (res: GeneralCallbackResult) => void
- /** 音频播放错误事件的回调函数 */
- type InnerAudioContextOffErrorCallback = (
- result: InnerAudioContextOnErrorCallbackResult
- ) => void
- /** 音频播放进度更新事件的回调函数 */
- type InnerAudioContextOffTimeUpdateCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 音频播放错误事件的回调函数 */
- type InnerAudioContextOnErrorCallback = (
- result: InnerAudioContextOnErrorCallbackResult
- ) => void
- /** 音频停止事件的回调函数 */
- type InnerAudioContextOnStopCallback = (res: GeneralCallbackResult) => void
- /** 音频播放进度更新事件的回调函数 */
- type InnerAudioContextOnTimeUpdateCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 插屏错误事件的回调函数 */
- type InterstitialAdOffErrorCallback = (
- result: InterstitialAdOnErrorCallbackResult
- ) => void
- /** 插屏错误事件的回调函数 */
- type InterstitialAdOnErrorCallback = (
- result: InterstitialAdOnErrorCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type InviteFriendCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type InviteFriendFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type InviteFriendSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type IsBluetoothDevicePairedCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type IsBluetoothDevicePairedFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type IsBluetoothDevicePairedSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type JoinRoomCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type JoinRoomFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type JoinRoomSuccessCallback = (
- result: JoinRoomSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type JoinVoIPChatCompleteCallback = (res: JoinVoIPChatError) => void
- /** 接口调用失败的回调函数 */
- type JoinVoIPChatFailCallback = (res: JoinVoIPChatError) => void
- /** 接口调用成功的回调函数 */
- type JoinVoIPChatSuccessCallback = (
- result: JoinVoIPChatSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type KickoutMemberCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type KickoutMemberFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type KickoutMemberSuccessCallback = (res: GeneralCallbackResult) => void
- /** 分包加载进度变化事件的回调函数 */
- type LoadSubpackageTaskOnProgressUpdateCallback = (
- result: LoadSubpackageTaskOnProgressUpdateCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type LoginCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type LoginFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type LoginSuccessCallback = (result: LoginSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type MakeBluetoothPairCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type MakeBluetoothPairFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type MakeBluetoothPairSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type MemberLeaveRoomCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type MemberLeaveRoomFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type MemberLeaveRoomSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type MkdirCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type MkdirFailCallback = (result: MkdirFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type MkdirSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ModifyFriendInteractiveStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type ModifyFriendInteractiveStorageFailCallback = (
- result: ModifyFriendInteractiveStorageFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type ModifyFriendInteractiveStorageSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type NavigateToMiniProgramCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type NavigateToMiniProgramFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type NavigateToMiniProgramSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type NotifyBLECharacteristicValueChangeCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type NotifyBLECharacteristicValueChangeFailCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用成功的回调函数 */
- type NotifyBLECharacteristicValueChangeSuccessCallback = (
- res: BluetoothError
- ) => void
- /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
- type OffAddToFavoritesCallback = (
- result: OnAddToFavoritesCallbackResult
- ) => void
- /** 音频因为受到系统占用而被中断开始事件的回调函数 */
- type OffAudioInterruptionBeginCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 音频中断结束事件的回调函数 */
- type OffAudioInterruptionEndCallback = (res: GeneralCallbackResult) => void
- /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
- type OffBLEMTUChangeCallback = (
- result: OnBLEMTUChangeCallbackResult
- ) => void
- /** 当前外围设备被连接或断开连接事件的回调函数 */
- type OffBLEPeripheralConnectionStateChangedCallback = (
- result: OnBLEPeripheralConnectionStateChangedCallbackResult
- ) => void
- /** 的回调函数 */
- type OffBeKickedOutCallback = (result: OnBeKickedOutCallbackResult) => void
- /** Beacon 服务状态变化事件的回调函数 */
- type OffBeaconServiceChangeCallback = (res: GeneralCallbackResult) => void
- /** Beacon 设备更新事件的回调函数 */
- type OffBeaconUpdateCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OffBroadcastCallback = (result: OnBroadcastCallbackResult) => void
- /** 音频进入可以播放状态的事件的回调函数 */
- type OffCanplayCallback = (res: GeneralCallbackResult) => void
- /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
- type OffCharacteristicReadRequestCallback = (
- result: OnCharacteristicReadRequestCallbackResult
- ) => void
- /** 特征订阅事件的回调函数 */
- type OffCharacteristicSubscribedCallback = (
- result: OnCharacteristicSubscribedCallbackResult
- ) => void
- /** 取消特征订阅事件的回调函数 */
- type OffCharacteristicUnsubscribedCallback = (
- result: OnCharacteristicSubscribedCallbackResult
- ) => void
- /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
- type OffCharacteristicWriteRequestCallback = (
- result: OnCharacteristicWriteRequestCallbackResult
- ) => void
- /** Transfer-Encoding Chunk Received 事件的回调函数 */
- type OffChunkReceivedCallback = (
- result: RequestTaskOnChunkReceivedCallbackResult
- ) => void
- /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
- type OffCopyUrlCallback = (result: OnCopyUrlCallbackResult) => void
- /** 横竖屏切换事件的回调函数 */
- type OffDeviceOrientationChangeCallback = (
- result: OnDeviceOrientationChangeCallbackResult
- ) => void
- /** 断开连接,收到此事件的回调函数 */
- type OffDisconnectCallback = (
- result: GameServerManagerOnDisconnectCallbackResult
- ) => void
- type OffEndedCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OffGameEndCallback = (result: OnGameEndCallbackResult) => void
- /** 的回调函数 */
- type OffGameStartCallback = (res: GeneralCallbackResult) => void
- /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
- type OffHandoffCallback = (result: OnHandoffCallbackResult) => void
- /** HTTP Response Header 事件的回调函数 */
- type OffHeadersReceivedCallback = (
- result: OnHeadersReceivedCallbackResult
- ) => void
- type OffHideCallback = (res: GeneralCallbackResult) => void
- /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
- type OffInviteCallback = (result: OnInviteCallbackResult) => void
- /** 键盘按键按下事件的回调函数 */
- type OffKeyDownCallback = (result: OnKeyDownCallbackResult) => void
- /** 键盘按键弹起事件的回调函数 */
- type OffKeyUpCallback = (result: OnKeyDownCallbackResult) => void
- /** 监听键盘收起的事件的回调函数 */
- type OffKeyboardCompleteCallback = (
- result: OnKeyboardInputCallbackResult
- ) => void
- /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
- type OffKeyboardConfirmCallback = (
- result: OnKeyboardInputCallbackResult
- ) => void
- /** 键盘输入事件的回调函数 */
- type OffKeyboardInputCallback = (
- result: OnKeyboardInputCallbackResult
- ) => void
- /** 开始监听数据包消息的事件的回调函数 */
- type OffListeningCallback = (res: GeneralCallbackResult) => void
- type OffLoadCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OffLockStepErrorCallback = (
- result: OnLockStepErrorCallbackResult
- ) => void
- /** 用户登出游戏服务事件的回调函数 */
- type OffLogoutCallback = (res: GeneralCallbackResult) => void
- /** 游戏匹配成功的事件的回调函数 */
- type OffMatchCallback = (
- result: GameServerManagerOnMatchCallbackResult
- ) => void
- /** 收到消息的事件的回调函数 */
- type OffMessageCallback = (result: UDPSocketOnMessageCallbackResult) => void
- /** 鼠标按键按下事件的回调函数 */
- type OffMouseDownCallback = (result: OnMouseDownCallbackResult) => void
- /** 鼠标移动事件的回调函数 */
- type OffMouseMoveCallback = (result: OnMouseMoveCallbackResult) => void
- /** 鼠标按键弹起事件的回调函数 */
- type OffMouseUpCallback = (result: OnMouseDownCallbackResult) => void
- /** 弱网状态变化事件的回调函数 */
- type OffNetworkWeakChangeCallback = (
- result: OnNetworkWeakChangeCallbackResult
- ) => void
- type OffPauseCallback = (res: GeneralCallbackResult) => void
- type OffPlayCallback = (res: GeneralCallbackResult) => void
- /** 视频下载(缓冲)事件的回调函数 */
- type OffProgressCallback = (result: OnProgressCallbackResult) => void
- /** 的回调函数 */
- type OffRoomInfoChangeCallback = (
- result: GameServerManagerOnRoomInfoChangeCallbackResult
- ) => void
- /** 音频完成跳转操作的事件的回调函数 */
- type OffSeekedCallback = (res: GeneralCallbackResult) => void
- /** 音频进行跳转操作的事件的回调函数 */
- type OffSeekingCallback = (res: GeneralCallbackResult) => void
- /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
- type OffShareAppMessageCallback = (
- result: OnShareAppMessageCallbackResult
- ) => void
- /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
- type OffShareTimelineCallback = (
- result: OnShareTimelineCallbackResult
- ) => void
- /** 小游戏回到前台的事件的回调函数 */
- type OffShowCallback = (result: OnShowCallbackResult) => void
- /** 的回调函数 */
- type OffStateUpdateCallback = (
- result: GameServerManagerOnStateUpdateCallbackResult
- ) => void
- /** 音频停止事件的回调函数 */
- type OffStopCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OffSyncFrameCallback = (result: OnSyncFrameCallbackResult) => void
- /** 触点失效事件的回调函数 */
- type OffTouchCancelCallback = (result: OnTouchStartCallbackResult) => void
- /** 触摸结束事件的回调函数 */
- type OffTouchEndCallback = (result: OnTouchStartCallbackResult) => void
- /** 触点移动事件的回调函数 */
- type OffTouchMoveCallback = (result: OnTouchStartCallbackResult) => void
- /** 开始触摸事件的回调函数 */
- type OffTouchStartCallback = (result: OnTouchStartCallbackResult) => void
- /** 未处理的 Promise 拒绝事件的回调函数 */
- type OffUnhandledRejectionCallback = (
- result: OnUnhandledRejectionCallbackResult
- ) => void
- /** 房间状态变化事件的回调函数 */
- type OffVoIPChatStateChangedCallback = (
- result: OnVoIPChatStateChangedCallbackResult
- ) => void
- type OffWaitingCallback = (res: GeneralCallbackResult) => void
- /** 鼠标滚轮事件的回调函数 */
- type OffWheelCallback = (result: OnWheelCallbackResult) => void
- /** 窗口尺寸变化事件的回调函数 */
- type OffWindowResizeCallback = (
- result: OnWindowResizeCallbackResult
- ) => void
- /** 加速度数据事件的回调函数 */
- type OnAccelerometerChangeCallback = (
- result: OnAccelerometerChangeCallbackResult
- ) => void
- /** 用户点击菜单「收藏」按钮时触发的事件的回调函数 */
- type OnAddToFavoritesCallback = (
- result: OnAddToFavoritesCallbackResult
- ) => void
- /** 音频因为受到系统占用而被中断开始事件的回调函数 */
- type OnAudioInterruptionBeginCallback = (res: GeneralCallbackResult) => void
- /** 音频中断结束事件的回调函数 */
- type OnAudioInterruptionEndCallback = (res: GeneralCallbackResult) => void
- /** 蓝牙低功耗设备的特征值变化事件的回调函数 */
- type OnBLECharacteristicValueChangeCallback = (
- result: OnBLECharacteristicValueChangeCallbackResult
- ) => void
- /** 蓝牙低功耗连接状态的改变事件的回调函数 */
- type OnBLEConnectionStateChangeCallback = (
- result: OnBLEConnectionStateChangeCallbackResult
- ) => void
- /** 蓝牙低功耗的最大传输单元变化事件的回调函数 */
- type OnBLEMTUChangeCallback = (result: OnBLEMTUChangeCallbackResult) => void
- /** 当前外围设备被连接或断开连接事件的回调函数 */
- type OnBLEPeripheralConnectionStateChangedCallback = (
- result: OnBLEPeripheralConnectionStateChangedCallbackResult
- ) => void
- /** 的回调函数 */
- type OnBeKickedOutCallback = (result: OnBeKickedOutCallbackResult) => void
- /** Beacon 服务状态变化事件的回调函数 */
- type OnBeaconServiceChangeCallback = (
- result: OnBeaconServiceChangeCallbackResult
- ) => void
- /** Beacon 设备更新事件的回调函数 */
- type OnBeaconUpdateCallback = (result: OnBeaconUpdateCallbackResult) => void
- /** 蓝牙适配器状态变化事件的回调函数 */
- type OnBluetoothAdapterStateChangeCallback = (
- result: OnBluetoothAdapterStateChangeCallbackResult
- ) => void
- /** 搜索到新设备的事件的回调函数 */
- type OnBluetoothDeviceFoundCallback = (
- result: OnBluetoothDeviceFoundCallbackResult
- ) => void
- /** 的回调函数 */
- type OnBroadcastCallback = (result: OnBroadcastCallbackResult) => void
- /** 摄像头返回实时帧数据的回调函数 */
- type OnCameraFrameCallback = (result: OnCameraFrameCallbackResult) => void
- /** 音频进入可以播放状态的事件的回调函数 */
- type OnCanplayCallback = (res: GeneralCallbackResult) => void
- /** 已连接的设备请求读当前外围设备的特征值事件的回调函数 */
- type OnCharacteristicReadRequestCallback = (
- result: OnCharacteristicReadRequestCallbackResult
- ) => void
- /** 特征订阅事件的回调函数 */
- type OnCharacteristicSubscribedCallback = (
- result: OnCharacteristicSubscribedCallbackResult
- ) => void
- /** 取消特征订阅事件的回调函数 */
- type OnCharacteristicUnsubscribedCallback = (
- result: OnCharacteristicSubscribedCallbackResult
- ) => void
- /** 已连接的设备请求写当前外围设备的特征值事件的回调函数 */
- type OnCharacteristicWriteRequestCallback = (
- result: OnCharacteristicWriteRequestCallbackResult
- ) => void
- /** 向微信后台请求检查更新结果事件的回调函数 */
- type OnCheckForUpdateCallback = (
- result: OnCheckForUpdateCallbackResult
- ) => void
- /** Transfer-Encoding Chunk Received 事件的回调函数 */
- type OnChunkReceivedCallback = (
- result: RequestTaskOnChunkReceivedCallbackResult
- ) => void
- /** 罗盘数据变化事件的回调函数 */
- type OnCompassChangeCallback = (
- result: OnCompassChangeCallbackResult
- ) => void
- /** 用户点击右上角菜单的「复制链接」按钮时触发的事件的回调函数 */
- type OnCopyUrlCallback = (result: OnCopyUrlCallbackResult) => void
- /** 设备方向变化事件的回调函数 */
- type OnDeviceMotionChangeCallback = (
- result: OnDeviceMotionChangeCallbackResult
- ) => void
- /** 横竖屏切换事件的回调函数 */
- type OnDeviceOrientationChangeCallback = (
- result: OnDeviceOrientationChangeCallbackResult
- ) => void
- /** 断开连接,收到此事件的回调函数 */
- type OnDisconnectCallback = (
- result: GameServerManagerOnDisconnectCallbackResult
- ) => void
- type OnEndedCallback = (res: GeneralCallbackResult) => void
- /** 已录制完指定帧大小的文件事件的回调函数 */
- type OnFrameRecordedCallback = (
- result: OnFrameRecordedCallbackResult
- ) => void
- /** 的回调函数 */
- type OnGameEndCallback = (result: OnGameEndCallbackResult) => void
- /** 的回调函数 */
- type OnGameStartCallback = (res: GeneralCallbackResult) => void
- /** 陀螺仪数据变化事件的回调函数 */
- type OnGyroscopeChangeCallback = (
- result: OnGyroscopeChangeCallbackResult
- ) => void
- /** 用户点击菜单「在电脑上打开」按钮时触发的事件的回调函数 */
- type OnHandoffCallback = (result: OnHandoffCallbackResult) => void
- /** HTTP Response Header 事件的回调函数 */
- type OnHeadersReceivedCallback = (
- result: OnHeadersReceivedCallbackResult
- ) => void
- type OnHideCallback = (res: GeneralCallbackResult) => void
- /** 录音因为受到系统占用而被中断开始事件的回调函数 */
- type OnInterruptionBeginCallback = (res: GeneralCallbackResult) => void
- /** 录音中断结束事件的回调函数 */
- type OnInterruptionEndCallback = (res: GeneralCallbackResult) => void
- /** 接收邀请,当用户确认邀请之后会收到此事件的回调函数 */
- type OnInviteCallback = (result: OnInviteCallbackResult) => void
- /** 键盘按键按下事件的回调函数 */
- type OnKeyDownCallback = (result: OnKeyDownCallbackResult) => void
- /** 键盘按键弹起事件的回调函数 */
- type OnKeyUpCallback = (result: OnKeyDownCallbackResult) => void
- /** 监听键盘收起的事件的回调函数 */
- type OnKeyboardCompleteCallback = (
- result: OnKeyboardInputCallbackResult
- ) => void
- /** 用户点击键盘 Confirm 按钮时的事件的回调函数 */
- type OnKeyboardConfirmCallback = (
- result: OnKeyboardInputCallbackResult
- ) => void
- type OnKeyboardHeightChangeCallback = (
- result: OnKeyboardHeightChangeCallbackResult
- ) => void
- /** 键盘输入事件的回调函数 */
- type OnKeyboardInputCallback = (
- result: OnKeyboardInputCallbackResult
- ) => void
- /** 开始监听数据包消息的事件的回调函数 */
- type OnListeningCallback = (res: GeneralCallbackResult) => void
- type OnLoadCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OnLockStepErrorCallback = (
- result: OnLockStepErrorCallbackResult
- ) => void
- /** 用户登出游戏服务事件的回调函数 */
- type OnLogoutCallback = (res: GeneralCallbackResult) => void
- /** 游戏匹配成功的事件的回调函数 */
- type OnMatchCallback = (
- result: GameServerManagerOnMatchCallbackResult
- ) => void
- /** 内存不足告警事件的回调函数 */
- type OnMemoryWarningCallback = (
- result: OnMemoryWarningCallbackResult
- ) => void
- /** 鼠标按键按下事件的回调函数 */
- type OnMouseDownCallback = (result: OnMouseDownCallbackResult) => void
- /** 鼠标移动事件的回调函数 */
- type OnMouseMoveCallback = (result: OnMouseMoveCallbackResult) => void
- /** 鼠标按键弹起事件的回调函数 */
- type OnMouseUpCallback = (result: OnMouseDownCallbackResult) => void
- /** 网络状态变化事件的回调函数 */
- type OnNetworkStatusChangeCallback = (
- result: OnNetworkStatusChangeCallbackResult
- ) => void
- /** 弱网状态变化事件的回调函数 */
- type OnNetworkWeakChangeCallback = (
- result: OnNetworkWeakChangeCallbackResult
- ) => void
- /** WebSocket 连接打开事件的回调函数 */
- type OnOpenCallback = (result: OnOpenCallbackResult) => void
- type OnPauseCallback = (res: GeneralCallbackResult) => void
- type OnPlayCallback = (res: GeneralCallbackResult) => void
- /** worker线程被系统回收事件的回调函数 */
- type OnProcessKilledCallback = (res: GeneralCallbackResult) => void
- /** 视频下载(缓冲)事件的回调函数 */
- type OnProgressCallback = (result: OnProgressCallbackResult) => void
- /** 录音继续事件的回调函数 */
- type OnResumeCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OnRoomInfoChangeCallback = (
- result: GameServerManagerOnRoomInfoChangeCallbackResult
- ) => void
- /** 音频完成跳转操作的事件的回调函数 */
- type OnSeekedCallback = (res: GeneralCallbackResult) => void
- /** 音频进行跳转操作的事件的回调函数 */
- type OnSeekingCallback = (res: GeneralCallbackResult) => void
- /** 用户点击右上角菜单的「转发」按钮时触发的事件的回调函数 */
- type OnShareAppMessageCallback = (
- result: OnShareAppMessageCallbackResult
- ) => void
- /** 的回调函数 */
- type OnShareMessageToFriendCallback = (
- result: OnShareMessageToFriendCallbackResult
- ) => void
- /** 用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件的回调函数 */
- type OnShareTimelineCallback = (
- result: OnShareTimelineCallbackResult
- ) => void
- /** 小游戏回到前台的事件的回调函数 */
- type OnShowCallback = (result: OnShowCallbackResult) => void
- /** WebSocket 连接关闭事件的回调函数 */
- type OnSocketCloseCallback = (
- result: SocketTaskOnCloseCallbackResult
- ) => void
- /** WebSocket 错误事件的回调函数 */
- type OnSocketErrorCallback = (result: GeneralCallbackResult) => void
- /** WebSocket 接受到服务器的消息事件的回调函数 */
- type OnSocketMessageCallback = (
- result: SocketTaskOnMessageCallbackResult
- ) => void
- /** WebSocket 连接打开事件的回调函数 */
- type OnSocketOpenCallback = (result: OnSocketOpenCallbackResult) => void
- /** 录音开始事件的回调函数 */
- type OnStartCallback = (res: GeneralCallbackResult) => void
- /** 的回调函数 */
- type OnStateUpdateCallback = (
- result: GameServerManagerOnStateUpdateCallbackResult
- ) => void
- /** 的回调函数 */
- type OnSyncFrameCallback = (result: OnSyncFrameCallbackResult) => void
- /** 触点失效事件的回调函数 */
- type OnTouchCancelCallback = (result: OnTouchStartCallbackResult) => void
- /** 触摸结束事件的回调函数 */
- type OnTouchEndCallback = (result: OnTouchStartCallbackResult) => void
- /** 触点移动事件的回调函数 */
- type OnTouchMoveCallback = (result: OnTouchStartCallbackResult) => void
- /** 开始触摸事件的回调函数 */
- type OnTouchStartCallback = (result: OnTouchStartCallbackResult) => void
- /** 未处理的 Promise 拒绝事件的回调函数 */
- type OnUnhandledRejectionCallback = (
- result: OnUnhandledRejectionCallbackResult
- ) => void
- /** 小程序更新失败事件的回调函数 */
- type OnUpdateFailedCallback = (res: GeneralCallbackResult) => void
- /** 小程序有版本更新事件的回调函数 */
- type OnUpdateReadyCallback = (res: GeneralCallbackResult) => void
- /** 用户主动截屏事件的回调函数 */
- type OnUserCaptureScreenCallback = (res: GeneralCallbackResult) => void
- /** 被动断开实时语音通话事件的回调函数 */
- type OnVoIPChatInterruptedCallback = (
- result: OnVoIPChatInterruptedCallbackResult
- ) => void
- /** 实时语音通话成员在线状态变化事件的回调函数 */
- type OnVoIPChatMembersChangedCallback = (
- result: OnVoIPChatMembersChangedCallbackResult
- ) => void
- /** 实时语音通话成员通话状态变化事件的回调函数 */
- type OnVoIPChatSpeakersChangedCallback = (
- result: OnVoIPChatSpeakersChangedCallbackResult
- ) => void
- /** 房间状态变化事件的回调函数 */
- type OnVoIPChatStateChangedCallback = (
- result: OnVoIPChatStateChangedCallbackResult
- ) => void
- type OnWaitingCallback = (res: GeneralCallbackResult) => void
- /** 鼠标滚轮事件的回调函数 */
- type OnWheelCallback = (result: OnWheelCallbackResult) => void
- /** 窗口尺寸变化事件的回调函数 */
- type OnWindowResizeCallback = (result: OnWindowResizeCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenBluetoothAdapterCompleteCallback = (res: BluetoothError) => void
- /** 接口调用失败的回调函数 */
- type OpenBluetoothAdapterFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type OpenBluetoothAdapterSuccessCallback = (res: BluetoothError) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenCardCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type OpenCardFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type OpenCardSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenChannelsActivityCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type OpenChannelsActivityFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type OpenChannelsActivitySuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenChannelsEventCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type OpenChannelsEventFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type OpenChannelsEventSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenChannelsLiveCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type OpenChannelsLiveFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type OpenChannelsLiveSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenChannelsUserProfileCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type OpenChannelsUserProfileFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type OpenChannelsUserProfileSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenCustomerServiceConversationCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type OpenCustomerServiceConversationFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type OpenCustomerServiceConversationSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type OpenFailCallback = (result: OpenFailCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OpenSettingCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type OpenSettingFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type OpenSettingSuccessCallback = (
- result: OpenSettingSuccessCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type OpenSuccessCallback = (result: OpenSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type OwnerLeaveRoomCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type OwnerLeaveRoomFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type OwnerLeaveRoomSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type PreviewImageCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type PreviewImageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type PreviewImageSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type PreviewMediaCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type PreviewMediaFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type PreviewMediaSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReadBLECharacteristicValueCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type ReadBLECharacteristicValueFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type ReadBLECharacteristicValueSuccessCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReadCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReadCompressedFileCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type ReadCompressedFileFailCallback = (
- result: ReadCompressedFileFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type ReadCompressedFileSuccessCallback = (
- result: ReadCompressedFileSuccessCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type ReadFailCallback = (result: ReadFailCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReadFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ReadFileFailCallback = (result: ReadFileFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ReadFileSuccessCallback = (
- result: ReadFileSuccessCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type ReadSuccessCallback = (result: ReadSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReadZipEntryCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ReadZipEntryFailCallback = (result: ReadFileFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ReadZipEntrySuccessCallback = (
- result: ReadZipEntrySuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReaddirCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ReaddirFailCallback = (result: ReaddirFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ReaddirSuccessCallback = (result: ReaddirSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ReconnectCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ReconnectFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ReconnectSuccessCallback = (
- result: ReconnectSuccessCallbackResult
- ) => void
- /** 录音结束事件的回调函数 */
- type RecorderManagerOnStopCallback = (result: OnStopCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RemoveSavedFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RemoveSavedFileFailCallback = (
- result: RemoveSavedFileFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type RemoveSavedFileSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RemoveServiceCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RemoveServiceFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type RemoveServiceSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RemoveStorageCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RemoveStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type RemoveStorageSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RemoveUserCloudStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type RemoveUserCloudStorageFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type RemoveUserCloudStorageSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RenameCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RenameFailCallback = (result: RenameFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type RenameSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RequestCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RequestFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RequestMidasFriendPaymentCompleteCallback = (
- res: MidasFriendPaymentError
- ) => void
- /** 接口调用失败的回调函数 */
- type RequestMidasFriendPaymentFailCallback = (
- res: MidasFriendPaymentError
- ) => void
- /** 接口调用成功的回调函数 */
- type RequestMidasFriendPaymentSuccessCallback = (
- result: RequestMidasFriendPaymentSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RequestMidasPaymentCompleteCallback = (res: MidasPaymentError) => void
- /** 接口调用失败的回调函数 */
- type RequestMidasPaymentFailCallback = (res: MidasPaymentError) => void
- /** 接口调用成功的回调函数 */
- type RequestMidasPaymentSuccessCallback = (
- result: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RequestSubscribeMessageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type RequestSubscribeMessageFailCallback = (
- result: RequestSubscribeMessageFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type RequestSubscribeMessageSuccessCallback = (
- result: RequestSubscribeMessageSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RequestSubscribeSystemMessageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type RequestSubscribeSystemMessageFailCallback = (
- result: RequestSubscribeMessageFailCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type RequestSubscribeSystemMessageSuccessCallback = (
- result: RequestSubscribeSystemMessageSuccessCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type RequestSuccessCallback<
- T extends string | IAnyObject | ArrayBuffer =
- | string
- | IAnyObject
- | ArrayBuffer
- > = (result: RequestSuccessCallbackResult<T>) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RestartCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RestartFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type RestartSuccessCallback = (res: GeneralCallbackResult) => void
- /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
- type RewardedVideoAdOffCloseCallback = (
- result: RewardedVideoAdOnCloseCallbackResult
- ) => void
- /** 用户点击 `关闭广告` 按钮的事件的回调函数 */
- type RewardedVideoAdOnCloseCallback = (
- result: RewardedVideoAdOnCloseCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type RmdirCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type RmdirFailCallback = (result: RmdirFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type RmdirSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SaveFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SaveFileFailCallback = (result: SaveFileFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SaveFileSuccessCallback = (
- result: SaveFileSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SaveFileToDiskCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SaveFileToDiskFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SaveFileToDiskSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SaveImageToPhotosAlbumCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type SaveImageToPhotosAlbumFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type SaveImageToPhotosAlbumSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ScanCodeCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ScanCodeFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ScanCodeSuccessCallback = (
- result: ScanCodeSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SendCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SendFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SendSocketMessageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type SendSocketMessageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SendSocketMessageSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SendSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetBLEMTUCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetBLEMTUFailCallback = (result: SetBLEMTUFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetBLEMTUSuccessCallback = (
- result: SetBLEMTUSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetClipboardDataCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetClipboardDataFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetClipboardDataSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetEnableDebugCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetEnableDebugFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetEnableDebugSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetInnerAudioOptionCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type SetInnerAudioOptionFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetInnerAudioOptionSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetKeepScreenOnCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetKeepScreenOnFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetKeepScreenOnSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetMenuStyleCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetMenuStyleFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetMenuStyleSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetScreenBrightnessCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type SetScreenBrightnessFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetScreenBrightnessSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetStateCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetStateFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetStateSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetStatusBarStyleCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type SetStatusBarStyleFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetStatusBarStyleSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetStorageCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetStorageSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetUserCloudStorageCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type SetUserCloudStorageFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetUserCloudStorageSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type SetWindowSizeCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SetWindowSizeFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type SetWindowSizeSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShareMessageToFriendCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type ShareMessageToFriendFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShareMessageToFriendSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowActionSheetCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ShowActionSheetFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowActionSheetSuccessCallback = (
- result: ShowActionSheetSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowKeyboardCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ShowKeyboardFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowKeyboardSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowLoadingCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ShowLoadingFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowLoadingSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowModalCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ShowModalFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowModalSuccessCallback = (
- result: ShowModalSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowShareImageMenuCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type ShowShareImageMenuFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowShareImageMenuSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowShareMenuCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ShowShareMenuFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowShareMenuSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ShowToastCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ShowToastFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ShowToastSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type SocketTaskCloseFailCallback = (res: GeneralCallbackResult) => void
- /** WebSocket 连接关闭事件的回调函数 */
- type SocketTaskOnCloseCallback = (
- result: SocketTaskOnCloseCallbackResult
- ) => void
- /** WebSocket 接受到服务器的消息事件的回调函数 */
- type SocketTaskOnMessageCallback = (
- result: SocketTaskOnMessageCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartAccelerometerCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type StartAccelerometerFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartAccelerometerSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartAdvertisingCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StartAdvertisingFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartAdvertisingSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartBeaconDiscoveryCompleteCallback = (res: BeaconError) => void
- /** 接口调用失败的回调函数 */
- type StartBeaconDiscoveryFailCallback = (res: BeaconError) => void
- /** 接口调用成功的回调函数 */
- type StartBeaconDiscoverySuccessCallback = (res: BeaconError) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartBluetoothDevicesDiscoveryCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type StartBluetoothDevicesDiscoveryFailCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用成功的回调函数 */
- type StartBluetoothDevicesDiscoverySuccessCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartCompassCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StartCompassFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartCompassSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartDeviceMotionListeningCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type StartDeviceMotionListeningFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type StartDeviceMotionListeningSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartGameCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StartGameFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartGameSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartGyroscopeCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StartGyroscopeFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartGyroscopeSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartHandoffCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StartHandoffFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartHandoffSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartMatchCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StartMatchFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartMatchSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StartStateServiceCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type StartStateServiceFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StartStateServiceSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StatCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StatFailCallback = (result: StatFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StatSuccessCallback = (result: StatSuccessCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopAccelerometerCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type StopAccelerometerFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StopAccelerometerSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopAdvertisingCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StopAdvertisingFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StopAdvertisingSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopBeaconDiscoveryCompleteCallback = (res: BeaconError) => void
- /** 接口调用失败的回调函数 */
- type StopBeaconDiscoveryFailCallback = (res: BeaconError) => void
- /** 接口调用成功的回调函数 */
- type StopBeaconDiscoverySuccessCallback = (res: BeaconError) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopBluetoothDevicesDiscoveryCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type StopBluetoothDevicesDiscoveryFailCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用成功的回调函数 */
- type StopBluetoothDevicesDiscoverySuccessCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopCompassCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StopCompassFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StopCompassSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopDeviceMotionListeningCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type StopDeviceMotionListeningFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type StopDeviceMotionListeningSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopFaceDetectCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StopFaceDetectFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StopFaceDetectSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type StopGyroscopeCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type StopGyroscopeFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type StopGyroscopeSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type ToTempFilePathCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type ToTempFilePathFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type ToTempFilePathSuccessCallback = (
- result: ToTempFilePathSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type TruncateCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type TruncateFailCallback = (result: TruncateFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type TruncateSuccessCallback = (res: GeneralCallbackResult) => void
- type UDPSocketOffCloseCallback = (res: GeneralCallbackResult) => void
- /** 错误事件的回调函数 */
- type UDPSocketOffErrorCallback = (result: GeneralCallbackResult) => void
- type UDPSocketOnCloseCallback = (res: GeneralCallbackResult) => void
- type UDPSocketOnErrorCallback = (result: GeneralCallbackResult) => void
- /** 收到消息的事件的回调函数 */
- type UDPSocketOnMessageCallback = (
- result: UDPSocketOnMessageCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UnlinkCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UnlinkFailCallback = (result: UnlinkFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UnlinkSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UnzipCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UnzipFailCallback = (result: UnzipFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UnzipSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UpdateKeyboardCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UpdateKeyboardFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UpdateKeyboardSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UpdateReadyStatusCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type UpdateReadyStatusFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UpdateReadyStatusSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UpdateShareMenuCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UpdateShareMenuFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UpdateShareMenuSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UpdateVoIPChatMuteConfigCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type UpdateVoIPChatMuteConfigFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type UpdateVoIPChatMuteConfigSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UpdateWeChatAppCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UpdateWeChatAppFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UpdateWeChatAppSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UploadFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UploadFileFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UploadFileSuccessCallback = (
- result: UploadFileSuccessCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type UploadFrameCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type UploadFrameFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type UploadFrameSuccessCallback = (res: GeneralCallbackResult) => void
- /** 上传进度变化事件的回调函数 */
- type UploadTaskOffProgressUpdateCallback = (
- result: UploadTaskOnProgressUpdateCallbackResult
- ) => void
- /** 上传进度变化事件的回调函数 */
- type UploadTaskOnProgressUpdateCallback = (
- result: UploadTaskOnProgressUpdateCallbackResult
- ) => void
- /** 用户信息按钮的点击事件的回调函数 */
- type UserInfoButtonOffTapCallback = (result: OnTapCallbackResult) => void
- /** 用户信息按钮的点击事件的回调函数 */
- type UserInfoButtonOnTapCallback = (result: OnTapCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type VibrateLongCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type VibrateLongFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type VibrateLongSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type VibrateShortCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type VibrateShortFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type VibrateShortSuccessCallback = (res: GeneralCallbackResult) => void
- /** 视频错误事件的回调函数 */
- type VideoOffErrorCallback = (result: VideoOnErrorCallbackResult) => void
- /** 视频播放进度更新事件的回调函数 */
- type VideoOffTimeUpdateCallback = (
- result: OnTimeUpdateCallbackResult
- ) => void
- /** 视频错误事件的回调函数 */
- type VideoOnErrorCallback = (result: VideoOnErrorCallbackResult) => void
- /** 视频播放进度更新事件的回调函数 */
- type VideoOnTimeUpdateCallback = (
- result: OnTimeUpdateCallbackResult
- ) => void
- /** 主线程/Worker 线程向当前线程发送的消息的事件的回调函数 */
- type WorkerOnMessageCallback = (
- result: WorkerOnMessageCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type WriteBLECharacteristicValueCompleteCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用失败的回调函数 */
- type WriteBLECharacteristicValueFailCallback = (res: BluetoothError) => void
- /** 接口调用成功的回调函数 */
- type WriteBLECharacteristicValueSuccessCallback = (
- res: BluetoothError
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type WriteCharacteristicValueCompleteCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用失败的回调函数 */
- type WriteCharacteristicValueFailCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用成功的回调函数 */
- type WriteCharacteristicValueSuccessCallback = (
- res: GeneralCallbackResult
- ) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type WriteCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type WriteFailCallback = (result: WriteFailCallbackResult) => void
- /** 接口调用结束的回调函数(调用成功、失败都会执行) */
- type WriteFileCompleteCallback = (res: GeneralCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type WriteFileFailCallback = (result: WriteFileFailCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type WriteFileSuccessCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type WriteSuccessCallback = (result: WriteSuccessCallbackResult) => void
- /** 接口调用失败的回调函数 */
- type WxGetFileInfoFailCallback = (res: GeneralCallbackResult) => void
- /** 接口调用成功的回调函数 */
- type WxGetFileInfoSuccessCallback = (
- result: WxGetFileInfoSuccessCallbackResult
- ) => void
- /** 全局错误事件的回调函数 */
- type WxOffErrorCallback = (result: WxOnErrorCallbackResult) => void
- /** 全局错误事件的回调函数 */
- type WxOnErrorCallback = (result: WxOnErrorCallbackResult) => void
- }
- /** [cancelAnimationFrame(number requestID)](https://developers.weixin.qq.com/minigame/dev/api/render/frame/cancelAnimationFrame.html)
- *
- * 取消由 requestAnimationFrame 添加到计划中的动画帧请求 */
- declare function cancelAnimationFrame(requestID: number): void
- /** [number requestAnimationFrame(function callback)](https://developers.weixin.qq.com/minigame/dev/api/render/frame/requestAnimationFrame.html)
- *
- * 在下次进行重绘时执行。 */
- declare function requestAnimationFrame(
- /** 执行的 callback */
- callback: (...args: any[]) => any
- ): number
|