当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
46 Star 180 Fork 4.8K

OpenHarmony/interface_sdk-js
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.geoLocationManager.d.ts 152.35 KB
一键复制 编辑 原始数据 按行查看 历史
WangTianhe8 提交于 16天前 . dingding
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163
/*
* Copyright (c) 2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit LocationKit
*/
import { AsyncCallback, Callback } from './@ohos.base';
/*** if arkts 1.1 */
import { WantAgent } from './@ohos.wantAgent';
/*** endif */
/*** if arkts 1.2 */
import { WantAgent } from '@ohos.app.ability.wantAgent';
/*** endif */
import { NotificationRequest } from './notification/notificationRequest';
/**
* Provides interfaces for acquiring location information, managing location switches,
* geocoding, reverse geocoding, country code, fencing and other functions.
*
* @namespace geoLocationManager
* @since 9
*/
/**
* Provides interfaces for acquiring location information, managing location switches,
* geocoding, reverse geocoding, country code, fencing and other functions.
*
* @namespace geoLocationManager
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
declare namespace geoLocationManager {
/**
* Subscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { LocationRequest } request - Indicates the location request parameters.
* @param { Callback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Subscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { LocationRequest } request - Indicates the location request parameters.
* @param { Callback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
/**
* Subscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { LocationRequest | ContinuousLocationRequest } request - Indicates the location request parameters.
* @param { Callback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
/**
* Subscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { LocationRequest | ContinuousLocationRequest } request - Indicates the location request parameters.
* @param { Callback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'locationChange', request: LocationRequest | ContinuousLocationRequest,
callback: Callback<Location>): void;
/**
* Unsubscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<Location> } [callback] - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Unsubscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<Location> } [callback] - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
/**
* Unsubscribe location changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<Location> } [callback] - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'locationChange', callback?: Callback<Location>): void;
/**
* Subscribe continuous location error changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationError' } type - Indicates the location service event to be subscribed to.
* @param { Callback<LocationError> } callback - Indicates the callback for reporting the continuous location error.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationError')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'locationError', callback: Callback<LocationError>): void;
/**
* Unsubscribe continuous location error changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locationError' } type - Indicates the location service event to be subscribed to.
* @param { Callback<LocationError> } [callback] - Indicates the callback for reporting the continuous location error.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationError')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'locationError', callback?: Callback<LocationError>): void;
/**
* Subscribe location switch changed.
*
* @param { 'locationEnabledChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<boolean> } callback - Indicates the callback for reporting the location switch status.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationEnabledChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'locationEnabledChange', callback: Callback<boolean>): void;
/**
* Unsubscribe location switch changed.
*
* @param { 'locationEnabledChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<boolean> } [callback] - Indicates the callback for reporting the location switch status.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationEnabledChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'locationEnabledChange', callback?: Callback<boolean>): void;
/**
* Subscribe to cache GNSS locations update messages.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cachedGnssLocationsChange' } type - Indicates the location service event to be subscribed to.
* @param { CachedGnssLocationsRequest } request - Indicates the cached GNSS locations request parameters.
* @param { Callback<Array<Location>> } callback - Indicates the callback for reporting the cached GNSS locations.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('cachedGnssLocationsChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
/**
* Subscribe to cache GNSS locations update messages.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cachedGnssLocationsChange' } type - Indicates the location service event to be subscribed to.
* @param { CachedGnssLocationsRequest } request - Indicates the cached GNSS locations request parameters.
* @param { Callback<Array<Location>> } callback - Indicates the callback for reporting the cached GNSS locations.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('cachedGnssLocationsChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'cachedGnssLocationsChange', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;
/**
* Unsubscribe to cache GNSS locations update messages.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cachedGnssLocationsChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<Array<Location>> } [callback] - Indicates the callback for reporting the cached gnss locations.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('cachedGnssLocationsChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
/**
* Unsubscribe to cache GNSS locations update messages.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'cachedGnssLocationsChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<Array<Location>> } [callback] - Indicates the callback for reporting the cached gnss locations.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('cachedGnssLocationsChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'cachedGnssLocationsChange', callback?: Callback<Array<Location>>): void;
/**
* Subscribe satellite status changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'satelliteStatusChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<SatelliteStatusInfo> } callback - Indicates the callback for reporting the satellite status.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('satelliteStatusChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'satelliteStatusChange', callback: Callback<SatelliteStatusInfo>): void;
/**
* Unsubscribe satellite status changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'satelliteStatusChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<SatelliteStatusInfo> } [callback] - Indicates the callback for reporting the satellite status.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('satelliteStatusChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'satelliteStatusChange', callback?: Callback<SatelliteStatusInfo>): void;
/**
* Subscribe nmea message changed.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'nmeaMessage' } type - Indicates the location service event to be subscribed to.
* @param { Callback<string> } callback - Indicates the callback for reporting the nmea message.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('nmeaMessage')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'nmeaMessage', callback: Callback<string>): void;
/**
* Unsubscribe nmea message changed.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'nmeaMessage' } type - Indicates the location service event to be subscribed to.
* @param { Callback<string> } [callback] - Indicates the callback for reporting the nmea message.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('nmeaMessage')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'nmeaMessage', callback?: Callback<string>): void;
/**
* Add a geofence and subscribe geofence status changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'gnssFenceStatusChange' } type - Indicates the location service event to be subscribed to.
* @param { GeofenceRequest } request - Indicates the Geofence configuration parameters.
* @param { WantAgent } want - Indicates which ability to start when the geofence event is triggered.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('gnssFenceStatusChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301600 - Failed to operate the geofence.
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
function on(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
/**
* Remove a geofence and unsubscribe geofence status changed.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { 'gnssFenceStatusChange' } type - Indicates the location service event to be subscribed to.
* @param { GeofenceRequest } request - Indicates the Geofence configuration parameters.
* @param { WantAgent } want - Indicates which ability to start when the geofence event is triggered.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('gnssFenceStatusChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301600 - Failed to operate the geofence.
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
function off(type: 'gnssFenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
/**
* Registering the callback function for listening to country code changes.
*
* @param { 'countryCodeChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<CountryCode> } callback - Indicates the callback for reporting country code changes.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('countryCodeChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301500 - Failed to query the area information.
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'countryCodeChange', callback: Callback<CountryCode>): void;
/**
* Unregistering the callback function for listening to country code changes.
*
* @param { 'countryCodeChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<CountryCode> } [callback] - Indicates the callback for reporting country code changes.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('countryCodeChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301500 - Failed to query the area information.
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void;
/**
* Subscribe to changes in WiFi/BT scanning information,
* and use the WiFi/BT scanning information for localization.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locatingRequiredDataChange' } type - Indicates the location service event to be subscribed to.
* @param { LocatingRequiredDataConfig } config - Indicates the locating required data configuration parameters.
* @param { Callback<Array<LocatingRequiredData>> } [callback] - Indicates the callback for reporting WiFi/BT scan info.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locatingRequiredDataChange')} due to limited device capabilities.
* @throws { BusinessError } 3301800 - Failed to start WiFi or Bluetooth scanning.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'locatingRequiredDataChange', config: LocatingRequiredDataConfig, callback: Callback<Array<LocatingRequiredData>>): void;
/**
* Stop WiFi/BT scanning and unsubscribe from WiFi/BT scanning information changes.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'locatingRequiredDataChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<Array<LocatingRequiredData>> } [callback] - Indicates the callback for reporting WiFi/BT scan info.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locatingRequiredDataChange')} due to limited device capabilities.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'locatingRequiredDataChange', callback?: Callback<Array<LocatingRequiredData>>): void;
/**
* Subscribe location icon status changed.
*
* @param { 'locationIconStatusChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<LocationIconStatus> } callback - Indicates the callback for reporting the location icon status.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('locationIconStatusChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'locationIconStatusChange', callback: Callback<LocationIconStatus>): void;
/**
* Unsubscribe location icon status changed.
*
* @param { 'locationIconStatusChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<LocationIconStatus> } [callback] - Indicates the callback for reporting the location icon status.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('locationIconStatusChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'locationIconStatusChange', callback?: Callback<LocationIconStatus>): void;
/**
* Registers and listens to bluetooth scanning results for location services.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'bluetoothScanResultChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<BluetoothScanResult> } callback - Indicates the callback for reporting Bluetooth scan info.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.on('bluetoothScanResultChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
function on(type: 'bluetoothScanResultChange', callback: Callback<BluetoothScanResult>): void;
/**
* Stop bluetooth scanning and unregister to listen to bluetooth scanning result changes.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { 'bluetoothScanResultChange' } type - Indicates the location service event to be subscribed to.
* @param { Callback<BluetoothScanResult> } [callback] - Indicates the callback for reporting Bluetooth scan info.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.off('bluetoothScanResultChange')} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
function off(type: 'bluetoothScanResultChange', callback?: Callback<BluetoothScanResult>): void;
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { CurrentLocationRequest } request - Indicates the location request parameters.
* @param { AsyncCallback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { CurrentLocationRequest } request - Indicates the location request parameters.
* @param { AsyncCallback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { CurrentLocationRequest | SingleLocationRequest } request - Indicates the location request parameters.
* @param { AsyncCallback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
function getCurrentLocation(request: CurrentLocationRequest | SingleLocationRequest,
callback: AsyncCallback<Location>): void;
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { AsyncCallback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { AsyncCallback<Location> } callback - Indicates the callback for reporting the location result.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
function getCurrentLocation(callback: AsyncCallback<Location>): void;
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { CurrentLocationRequest } [request] - Indicates the location request parameters.
* @returns { Promise<Location> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { CurrentLocationRequest } [request] - Indicates the location request parameters.
* @returns { Promise<Location> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
/**
* Obtain current location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { CurrentLocationRequest | SingleLocationRequest } [request] - Indicates the location request parameters.
* @returns { Promise<Location> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
function getCurrentLocation(request?: CurrentLocationRequest | SingleLocationRequest):
Promise<Location>;
/**
* Obtain last known location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @returns { Location } The last known location information.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLastLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Obtain last known location.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @returns { Location } The last known location information.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLastLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
function getLastLocation(): Location;
/**
* Obtain current location switch status.
*
* @returns { boolean } Returns {@code true} if the location switch on, returns {@code false} otherwise.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationEnabled} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Obtain current location switch status.
*
* @returns { boolean } Returns {@code true} if the location switch on, returns {@code false} otherwise.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationEnabled} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
function isLocationEnabled(): boolean;
/**
* Obtaining the location switch status of a specified user.
*
* @param { number } userId - Indicates the ID of a specified user.
* @returns { boolean } Returns {@code true} if the location switch on, returns {@code false} otherwise.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationEnabledByUserId} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 18
*/
function isLocationEnabledByUserId(userId: number): boolean;
/**
* Enable location switch.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS
* @param { AsyncCallback<void> } callback - Indicates the callback for reporting the error message.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Enable location switch.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS and ohos.permission.CONTROL_LOCATION_SWITCH
* @param { AsyncCallback<void> } callback - Indicates the callback for reporting the error message.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'20','1.2':'20'}
* @arkts 1.1&1.2
*/
function enableLocation(callback: AsyncCallback<void>): void;
/**
* Enable location switch.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Enable location switch.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS and ohos.permission.CONTROL_LOCATION_SWITCH
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'20','1.2':'20'}
* @arkts 1.1&1.2
*/
function enableLocation(): Promise<void>;
/**
* Turn on the location switch for a specified user.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS and ohos.permission.CONTROL_LOCATION_SWITCH
* @param { number } userId - Indicates the ID of a specified user.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 18
*/
function enableLocationByUserId(userId: number): Promise<void>;
/**
* Disable location switch.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Disable location switch.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS and ohos.permission.CONTROL_LOCATION_SWITCH
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'20','1.2':'20'}
* @arkts 1.1&1.2
*/
function disableLocation(): void;
/**
* Turn off the location switch for a specified user.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS and ohos.permission.CONTROL_LOCATION_SWITCH
* @param { number } userId - Indicates the ID of a specified user.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 18
*/
function disableLocationByUserId(userId: number): void;
/**
* Set the app locating behavior not controlled by the location switch.
*
* @permission ohos.permission.LOCATION_SWITCH_IGNORED
* @param { boolean } isIgnored - True indicates that the location behavior of the app is not controlled by the location switch.
* Otherwise, it's the opposite.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 18
*/
function setLocationSwitchIgnored(isIgnored: boolean): void;
/**
* Obtain address info from location.
*
* @param { ReverseGeoCodeRequest } request - Indicates the reverse geocode query parameters.
* @param { AsyncCallback<Array<GeoAddress>> } callback - Indicates the callback for reporting the address info.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301300 - Reverse geocoding query failed.
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;
/**
* Obtain address info from location.
*
* @param { ReverseGeoCodeRequest } request - Indicates the reverse geocode query parameters.
* @returns { Promise<Array<GeoAddress>> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocation} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301300 - Reverse geocoding query failed.
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;
/**
* Obtain latitude and longitude info from location address.
*
* @param { GeoCodeRequest } request - Indicates the geocode query parameters.
* @param { AsyncCallback<Array<GeoAddress>> } callback - Indicates the callback for reporting the latitude and longitude result.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocationName} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301400 - Geocoding query failed.
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
function getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;
/**
* Obtain latitude and longitude info from location address.
*
* @param { GeoCodeRequest } request - Indicates the geocode query parameters.
* @returns { Promise<Array<GeoAddress>> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getAddressesFromLocationName} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301400 - Geocoding query failed.
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
function getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>;
/**
* Obtain geocoding service status.
*
* @returns { boolean } Returns {@code true} if geocoding service is available, returns {@code false} otherwise.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isGeocoderAvailable} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
function isGeocoderAvailable(): boolean;
/**
* Obtain the number of cached GNSS locations reported at a time.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { AsyncCallback<number> } callback - Indicates the callback for reporting the cached GNSS locations size.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCachedGnssLocationsSize} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
function getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;
/**
* Obtain the number of cached GNSS locations.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @returns { Promise<number> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCachedGnssLocationsSize} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
function getCachedGnssLocationsSize(): Promise<number>;
/**
* All prepared GNSS locations are returned to the application through the callback function,
* and the bottom-layer buffer is cleared.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @param { AsyncCallback<void> } callback - Indicates the callback for reporting the error message.
* If the function fails to execute, the error message will be carried in the first parameter err of AsyncCallback,
* If the function executes successfully, execute the callback function only, no data will be returned.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.flushCachedGnssLocations} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
function flushCachedGnssLocations(callback: AsyncCallback<void>): void;
/**
* All prepared GNSS locations are returned to the application,
* and the bottom-layer buffer is cleared.
*
* @permission ohos.permission.APPROXIMATELY_LOCATION
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.flushCachedGnssLocations} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301200 - Failed to obtain the geographical location.
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
function flushCachedGnssLocations(): Promise<void>;
/**
* Send extended commands to location subsystem.
*
* @param { LocationCommand } command - Indicates the extended command message body.
* @param { AsyncCallback<void> } callback - Indicates the callback for reporting the error message.
* If the function fails to execute, the error message will be carried in the first parameter err of AsyncCallback,
* If the function executes successfully, execute the callback function only, no data will be returned.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.sendCommand} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
function sendCommand(command: LocationCommand, callback: AsyncCallback<void>): void;
/**
* Send extended commands to location subsystem.
*
* @param { LocationCommand } command - Indicates the extended command message body.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.sendCommand} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
function sendCommand(command: LocationCommand): Promise<void>;
/**
* Obtain the current country code.
*
* @param { AsyncCallback<CountryCode> } callback - Indicates the callback for reporting the country code.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCountryCode} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301500 - Failed to query the area information.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
function getCountryCode(callback: AsyncCallback<CountryCode>): void;
/**
* Obtain the current country code.
*
* @returns { Promise<CountryCode> } The promise returned by the function.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCountryCode} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301500 - Failed to query the area information.
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
function getCountryCode(): Promise<CountryCode>;
/**
* Enable the geographical location simulation function.
*
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocationMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Enable the geographical location simulation function.
*
* @permission ohos.permission.MOCK_LOCATION
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableLocationMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 20
*/
function enableLocationMock(): void;
/**
* Disable the geographical location simulation function.
*
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableLocationMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Disable the geographical location simulation function.
*
* @permission ohos.permission.MOCK_LOCATION
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableLocationMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 20
*/
function disableLocationMock(): void;
/**
* Set the configuration parameters for location simulation.
*
* @param { LocationMockConfig } config - Indicates the configuration parameters for location simulation.
* Contains the array of locations and reporting intervals that need to be simulated.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setMockedLocations} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Set the configuration parameters for location simulation.
*
* @permission ohos.permission.MOCK_LOCATION
* @param { LocationMockConfig } config - Indicates the configuration parameters for location simulation.
* Contains the array of locations and reporting intervals that need to be simulated.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setMockedLocations} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 20
*/
function setMockedLocations(config: LocationMockConfig): void;
/**
* Enable the reverse geocoding simulation function.
*
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableReverseGeocodingMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Enable the reverse geocoding simulation function.
*
* @permission ohos.permission.MOCK_LOCATION
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.enableReverseGeocodingMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 20
*/
function enableReverseGeocodingMock(): void;
/**
* Disable the reverse geocoding simulation function.
*
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableReverseGeocodingMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Disable the reverse geocoding simulation function.
*
* @permission ohos.permission.MOCK_LOCATION
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.disableReverseGeocodingMock} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 20
*/
function disableReverseGeocodingMock(): void;
/**
* Set the configuration parameters for simulating reverse geocoding.
*
* @param { Array<ReverseGeocodingMockInfo> } mockInfos - Indicates the set of locations and place names to be simulated.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setReverseGeocodingMockInfo} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
/**
* Set the configuration parameters for simulating reverse geocoding.
*
* @permission ohos.permission.MOCK_LOCATION
* @param { Array<ReverseGeocodingMockInfo> } mockInfos - Indicates the set of locations and place names to be simulated.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setReverseGeocodingMockInfo} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 20
*/
function setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): void;
/**
* Querying location privacy protocol confirmation status.
*
* @param { LocationPrivacyType } type - Indicates location privacy protocol type.
* @returns { boolean } Returns {@code true} if the location privacy protocol has been confirmed, returns {@code false} otherwise.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.isLocationPrivacyConfirmed} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
function isLocationPrivacyConfirmed(type: LocationPrivacyType): boolean;
/**
* Set location privacy protocol confirmation status.
*
* @permission ohos.permission.MANAGE_SECURE_SETTINGS
* @param { LocationPrivacyType } type - Indicates location privacy protocol type.
* @param { boolean } isConfirmed - Indicates whether the location privacy protocol has been confirmed.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.setLocationPrivacyConfirmStatus} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
function setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): void;
/**
* Get WiFi/BT scanning information, and use the WiFi/BT scanning information for localization.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { LocatingRequiredDataConfig } config - Indicates the request parameters for obtaining the data required for locating.
* @returns { Promise<Array<LocatingRequiredData>> } The promise returned by the function, for reporting WiFi/BT scan info.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLocatingRequiredData} due to limited device capabilities.
* @throws { BusinessError } 3301800 - Failed to start WiFi or Bluetooth scanning.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
function getLocatingRequiredData(config: LocatingRequiredDataConfig): Promise<Array<LocatingRequiredData>>;
/**
* Add a geofence.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { GnssGeofenceRequest } fenceRequest - Indicates the Geofence configuration parameters.
* @returns { Promise<number> } The promise returned by the function, for reporting the ID of geofence.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.addGnssGeofence} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301601 - The number of geofences exceeds the maximum.
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
function addGnssGeofence(fenceRequest: GnssGeofenceRequest): Promise<number>;
/**
* Remove a geofence.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { number } geofenceId - Indicates the ID of geofence.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.removeGnssGeofence} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301602 - Failed to delete a geofence due to an incorrect ID.
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
function removeGnssGeofence(geofenceId: number): Promise<void>;
/**
* Obtains the coordinate system types supported by geofence.
*
* @returns { Array<CoordinateSystemType> } Return the coordinate system types supported by geofence.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getGeofenceSupportedCoordTypes} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
function getGeofenceSupportedCoordTypes(): Array<CoordinateSystemType>;
/**
* Get location icon status.
*
* @returns { LocationIconStatus } The location icon status.
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getLocationIconStatus} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 12
*/
function getLocationIconStatus(): LocationIconStatus;
/**
* Obtains the BSSID of the connected Wi-Fi hotspot.
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @returns {string} Returns the BSSID of the connected Wi-Fi hotspot.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getCurrentWifiBssidForLocating()} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301900 - Failed to obtain the BSSID of the Wi-Fi hotspot. The Wi-Fi network is not connected.
* @syscap SystemCapability.Location.Location.Core
* @crossplatform
* @since 14
*/
function getCurrentWifiBssidForLocating(): string;
/**
* Obtains the distance between two locations.
*
* @param { Location } location1 - Indicates first location.
* @param { Location } location2 - Indicates second location.
* @returns { number } Returns the distance between two locations.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 20
*/
function getDistanceBetweenLocations(location1: Location, location2: Location): number;
/**
* Check whether the POI service is supported.
*
* @returns { boolean } Returns {@code true} if POI service is available, returns {@code false} otherwise.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 20
*/
function isPoiServiceSupported(): boolean;
/**
* Obtaining POI Information.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @returns { Promise<PoiInfo> } The promise returned by the function, for reporting POI info.
*
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.getPoiInfo} due to limited device capabilities.
* @throws { BusinessError } 3301000 - The location service is unavailable.
* @throws { BusinessError } 3301100 - The location switch is off.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 20
*/
function getPoiInfo(): Promise<PoiInfo>;
/**
* Add a beacon fence.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { BeaconFenceRequest } fenceRequest - Indicates the details of the beacon fence.
* @returns { Promise<number> } The promise returned by the function, for reporting the ID of beacon fence.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the
* permission required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.addBeaconFence}
* due to limited device capabilities.
* @throws { BusinessError } 3501100 - Failed to add a beacon fence because the location switch is off.
* @throws { BusinessError } 3501101 - Failed to add a beacon fence because the bluetooth switch is off.
* @throws { BusinessError } 3501601 - The number of beacon fence exceeds the maximum.
* @throws { BusinessError } 3501603 - Duplicate beacon fence information.
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
function addBeaconFence(fenceRequest: BeaconFenceRequest): Promise<number>;
/**
* Remove a beacon fence.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { BeaconFence } [beaconFence] - Indicates the details of the beacon fence.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission
* required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call ${geoLocationManager.removeBeaconFence}
* due to limited device capabilities.
* @throws { BusinessError } 3501602 - Failed to delete the fence due to incorrect beacon fence information.
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
function removeBeaconFence(beaconFence?: BeaconFence): Promise<void>;
/**
* Check whether the BeaconFence service is supported.
*
* @returns { boolean } Returns {@code true} if BeaconFence service is available, returns {@code false} otherwise.
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
function isBeaconFenceSupported(): boolean;
/**
* Check whether the WLAN scan results match the WLAN BSSID list.
*
* @permission ohos.permission.LOCATION and ohos.permission.APPROXIMATELY_LOCATION
* @param { Array<string> } wlanBssidArray - Indicates the list of WLAN BSSIDs that need to be matched.
* @param { int } rssiThreshold - Indicates the WLAN RSSI threshold, only matching WLAN BSSID with
* RSSI greater than this threshold.
* @param { boolean } needStartScan - Indicates whether a WLAN scan needs to be initiated.
* @returns { Promise<boolean> } The promise returned by the function.
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission
* required to call the API.
* @throws { BusinessError } 801 - Capability not supported. Failed to call
* ${geoLocationManager.isWlanBssidMatched} due to limited device capabilities.
* @throws { BusinessError } 3301100 - The location switch is off.
* @throws { BusinessError } 3301800 - Failed to start WiFi scanning.
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 21
* @arkts 1.1&1.2
*/
function isWlanBssidMatched(
wlanBssidArray: Array<string>, rssiThreshold: int, needStartScan: boolean): Promise<boolean>;
/**
* Configuration parameters for simulating reverse geocoding.
*
* @typedef ReverseGeocodingMockInfo
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
export interface ReverseGeocodingMockInfo {
/**
* Location for which reverse geocoding query is required.
*
* @type { ReverseGeoCodeRequest }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
location: ReverseGeoCodeRequest;
/**
* Actual address information corresponding to the location.
*
* @type { GeoAddress }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
geoAddress: GeoAddress;
}
/**
* Parameters for configuring the location simulation function.
*
* @typedef LocationMockConfig
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
export interface LocationMockConfig {
/**
* Interval for reporting simulated locations.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
timeInterval: number;
/**
* Mock location array.
*
* @type { Array<Location> }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
locations: Array<Location>;
}
/**
* Satellite status information.
*
* @typedef SatelliteStatusInfo
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface SatelliteStatusInfo {
/**
* Number of satellites.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
satellitesNumber: number;
/**
* Satellite ID array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
satelliteIds: Array<number>;
/**
* Carrier to noise density array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
carrierToNoiseDensitys: Array<number>;
/**
* Satellite altitude array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
altitudes: Array<number>;
/**
* Satellite azimuth array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
azimuths: Array<number>;
/**
* Satellite carrier frequency array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
carrierFrequencies: Array<number>;
/**
* Satellite constellation type array.
*
* @type { ?Array<SatelliteConstellationCategory> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
satelliteConstellation?: Array<SatelliteConstellationCategory>;
/**
* Satellite additional information array.
*
* @type { ?Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
satelliteAdditionalInfo?: Array<number>;
}
/**
* Parameters for requesting to report cache location information.
*
* @typedef CachedGnssLocationsRequest
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface CachedGnssLocationsRequest {
/**
* GNSS cache location report period.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
reportingPeriodSec: number;
/**
* Indicates whether to wake up the listener when the GNSS cache location queue is full.
*
* @type { boolean }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
wakeUpCacheQueueFull: boolean;
}
/**
* Configuring parameters in GNSS geofence requests.
*
* @typedef GnssGeofenceRequest
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
export interface GnssGeofenceRequest {
/**
* Circular fence information.
*
* @type { Geofence }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
geofence: Geofence;
/**
* Indicates geofence transition status monitored.
*
* @type { Array<GeofenceTransitionEvent> }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
monitorTransitionEvents: Array<GeofenceTransitionEvent>;
/**
* Indicates the geofence notifications to publish.
*
* @type { ?Array<NotificationRequest> }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
notifications?: Array<NotificationRequest>;
/**
* Indicates the callback for reporting the geofence transition status.
*
* @type { AsyncCallback<GeofenceTransition> }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
geofenceTransitionCallback: AsyncCallback<GeofenceTransition>;
}
/**
* Configuring parameters in geofence requests.
*
* @typedef GeofenceRequest
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
export interface GeofenceRequest {
/**
* Indicate the user scenario.
*
* @type { LocationRequestScenario }
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
scenario: LocationRequestScenario;
/**
* Circular fence information.
*
* @type { Geofence }
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
geofence: Geofence;
}
/**
* Circular fence information.
*
* @typedef Geofence
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
export interface Geofence {
/**
* Latitude of the center point of the circular fence.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
latitude: number;
/**
* Longitude of the center point of the circular fence.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
longitude: number;
/**
* Coordinate system type.
*
* @type { ?CoordinateSystemType }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
coordinateSystemType?: CoordinateSystemType;
/**
* Radius of the circular fence.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
radius: number;
/**
* Expiration of the circular fence.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 9
*/
expiration: number;
}
/**
* Configuring parameters in reverse geocode requests.
*
* @typedef ReverseGeoCodeRequest
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ReverseGeoCodeRequest {
/**
* Indicates the language area information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
locale?: string;
/**
* Indicates the country information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
country?: string;
/**
* Latitude for reverse geocoding query.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
latitude: number;
/**
* Longitude for reverse geocoding query.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
longitude: number;
/**
* Indicates the maximum number of addresses returned by reverse geocoding query.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
maxItems?: number;
}
/**
* Configuring parameters in geocode requests.
*
* @typedef GeoCodeRequest
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface GeoCodeRequest {
/**
* Indicates the language area information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
locale?: string;
/**
* Indicates the country information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
country?: string;
/**
* Address information.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
description: string;
/**
* Indicates the maximum number of geocode query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
maxItems?: number;
/**
* Indicates the minimum latitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
minLatitude?: number;
/**
* Indicates the minimum longitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
minLongitude?: number;
/**
* Indicates the maximum latitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
maxLatitude?: number;
/**
* Indicates the maximum longitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
maxLongitude?: number;
}
/**
* Data struct describes geographic locations.
*
* @typedef GeoAddress
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface GeoAddress {
/**
* Indicates latitude information.
* A positive value indicates north latitude,
* and a negative value indicates south latitude.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
latitude?: number;
/**
* Indicates longitude information.
* A positive value indicates east longitude ,
* and a negative value indicates west longitude.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
longitude?: number;
/**
* Indicates language used for the location description.
* zh indicates Chinese, and en indicates English.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
locale?: string;
/**
* Indicates detailed address information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
placeName?: string;
/**
* Indicates country code.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
countryCode?: string;
/**
* Indicates country name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
countryName?: string;
/**
* Indicates administrative region name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
administrativeArea?: string;
/**
* Indicates sub-administrative region name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
subAdministrativeArea?: string;
/**
* Indicates locality information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
locality?: string;
/**
* Indicates sub-locality information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
subLocality?: string;
/**
* Indicates road name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
roadName?: string;
/**
* Indicates auxiliary road information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
subRoadName?: string;
/**
* Indicates house information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
premises?: string;
/**
* Indicates postal code.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
postalCode?: string;
/**
* Indicates phone number.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
phoneNumber?: string;
/**
* Indicates website URL.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
addressUrl?: string;
/**
* Indicates additional information.
*
* @type { ?Array<string> }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
descriptions?: Array<string>;
/**
* Indicates the amount of additional descriptive information.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
descriptionsSize?: number;
/**
* Indicates whether it is an mock GeoAddress
*
* @type { ?Boolean }
* @syscap SystemCapability.Location.Location.Geocoder
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
isFromMock?: Boolean;
}
/**
* Configuring parameters in location requests.
*
* @typedef LocationRequest
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Configuring parameters in location requests.
*
* @typedef LocationRequest
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface LocationRequest {
/**
* Priority of the location request.
*
* @type { ?LocationRequestPriority }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Priority of the location request.
*
* @type { ?LocationRequestPriority }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
priority?: LocationRequestPriority;
/**
* User scenario of the location request.
*
* @type { ?LocationRequestScenario }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* User scenario of the location request.
*
* @type { ?LocationRequestScenario }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
scenario?: LocationRequestScenario;
/**
* Location report interval.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Location report interval.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
timeInterval?: number;
/**
* Location report distance interval.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Location report distance interval.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
distanceInterval?: number;
/**
* Accuracy requirements for reporting locations.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Accuracy requirements for reporting locations.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
maxAccuracy?: number;
}
/**
* Configuring parameters in current location requests.
*
* @typedef CurrentLocationRequest
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Configuring parameters in current location requests.
*
* @typedef CurrentLocationRequest
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface CurrentLocationRequest {
/**
* Priority of the location request.
*
* @type { ?LocationRequestPriority }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Priority of the location request.
*
* @type { ?LocationRequestPriority }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
priority?: LocationRequestPriority;
/**
* User scenario of the location request.
*
* @type { ?LocationRequestScenario }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* User scenario of the location request.
*
* @type { ?LocationRequestScenario }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
scenario?: LocationRequestScenario;
/**
* Accuracy requirements for reporting locations.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Accuracy requirements for reporting locations.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
maxAccuracy?: number;
/**
* Timeout interval of a single location request.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Timeout interval of a single location request.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
timeoutMs?: number;
}
/**
* Geofence transition status.
*
* @typedef GeofenceTransition
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
export interface GeofenceTransition {
/**
* ID of the geofence.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
geofenceId: number;
/**
* Indicates the geofence transition status.
*
* @type { GeofenceTransitionEvent }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
transitionEvent: GeofenceTransitionEvent;
/**
* Indicate the beaconFence which transitionEvent occurs.
*
* @type { ?BeaconFence }
* @syscap SystemCapability.Location.Location.Geofence
* @since 20
*/
beaconFence?: BeaconFence;
}
/**
* Configuring parameters in continuous location requests.
*
* @typedef ContinuousLocationRequest
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface ContinuousLocationRequest {
/**
* Location report interval, in seconds.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
interval: number;
/**
* Location scenario. You can select a user activity scenario or power consumption scenario.
*
* @type { UserActivityScenario | PowerConsumptionScenario }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
locationScenario: UserActivityScenario | PowerConsumptionScenario;
/**
* Indicates the type of sports.
* This parameter is valid only when locationScenario is set to UserActivityScenario.SPORT.
*
* @type { SportsType }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
sportsType?: SportsType;
/**
* Indicates whether to obtain POI information near the current location.
*
* @type { ?boolean }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
needPoi?: boolean;
}
/**
* Configuring parameters in single location requests.
*
* @typedef SingleLocationRequest
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface SingleLocationRequest {
/**
* Priority of the location request.
*
* @type { LocatingPriority }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
locatingPriority: LocatingPriority;
/**
* Timeout of a single location request, in milliseconds.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
locatingTimeoutMs: number;
/**
* Indicates whether to obtain POI information near the current location.
*
* @type { ?boolean }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
needPoi?: boolean;
}
/**
* Provides information about geographic locations.
*
* @typedef Location
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Provides information about geographic locations.
*
* @typedef Location
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface Location {
/**
* Indicates latitude information.
* A positive value indicates north latitude,
* and a negative value indicates south latitude.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates latitude information.
* A positive value indicates north latitude,
* and a negative value indicates south latitude.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
latitude: number;
/**
* Indicates Longitude information.
* A positive value indicates east longitude ,
* and a negative value indicates west longitude.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates Longitude information.
* A positive value indicates east longitude ,
* and a negative value indicates west longitude.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
longitude: number;
/**
* Indicates location altitude, in meters.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates location altitude, in meters.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
altitude: number;
/**
* Indicates location accuracy, in meters.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates location accuracy, in meters.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
accuracy: number;
/**
* Indicates speed, in m/s.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates speed, in m/s.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
speed: number;
/**
* Indicates location timestamp in the UTC format.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates location timestamp in the UTC format.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
timeStamp: number;
/**
* Indicates direction information.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates direction information.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
direction: number;
/**
* Indicates location timestamp since boot.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates location timestamp since boot.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
timeSinceBoot: number;
/**
* Indicates additional information.
*
* @type { ?Array<string> }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates additional information.
*
* @type { ?Array<string> }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
additions?: Array<string>;
/**
* Indicates additional information map.
*
* @type { ?Map<string, string> }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
additionsMap?: Map<string, string>;
/**
* Indicates the amount of additional descriptive information.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Indicates the amount of additional descriptive information.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
additionSize?: number;
/**
* Indicates whether it is an mock location.
*
* @type { ?Boolean }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
isFromMock?: Boolean;
/**
* Indicates vertical position accuracy in meters.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
altitudeAccuracy?: number;
/**
* Indicates speed accuracy in meter per seconds.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
speedAccuracy?: number;
/**
* Indicates direction accuracy in degrees.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
directionAccuracy?: number;
/**
* Time uncertainty Of timeSinceBoot in nanosecond.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
uncertaintyOfTimeSinceBoot?: number;
/**
* Indicates the source of the location.
*
* @type { ?LocationSourceType }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
sourceType?: LocationSourceType;
/**
* Indicates the poi information.
*
* @type { ?PoiInfo }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
poi?: PoiInfo;
}
/**
* Describes the request parameters for obtaining the data required for locating.
* @typedef LocatingRequiredDataConfig
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface LocatingRequiredDataConfig {
/**
* Indicates the type of locating required data.
*
* @type {LocatingRequiredDataType}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
type: LocatingRequiredDataType;
/**
* Indicates whether to start scanning.
*
* @type {boolean}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
needStartScan: boolean;
/**
* Indicates the interval between scans. The unit is millisecond.
* This parameter needs to be set only when scanning information is continuously monitored.
*
* @type {?number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
scanInterval?: number;
/**
* Indicates the timeout period of a single scan. The unit is millisecond. The default value is 10000.
* This parameter needs to be set only when getLocatingRequiredData is used.
*
* @type {?number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
scanTimeout?: number;
}
/**
* Describes the structure of the data required for locating.
* @typedef LocatingRequiredData
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface LocatingRequiredData {
/**
* WiFi scan info.
*
* @type {?WifiScanInfo}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
wifiData?: WifiScanInfo;
/**
* Bluetooth scan info.
*
* @type {?BluetoothScanInfo}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
bluetoothData?: BluetoothScanInfo;
}
/**
* Describes the scanned WiFi information.
* @typedef WifiScanInfo
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface WifiScanInfo {
/**
* WiFi SSID: the maximum length is 32.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
ssid: string;
/**
* WiFi bssid(MAC): the length is 6.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
bssid: string;
/**
* Received signal strength indicator (RSSI).
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
rssi: number;
/**
* Frequency
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
frequency: number;
/**
* Time stamp.
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
timestamp: number;
}
/**
* Describes the contents of the Bluetooth scan results.
*
* @typedef BluetoothScanInfo
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface BluetoothScanInfo {
/**
* The local name of the device.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
deviceName: string;
/**
* Mac address of the scanned device.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
macAddress: string;
/**
* RSSI of the remote device.
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
rssi: number;
/**
* Time stamp.
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
timestamp: number;
}
/**
* Describes the contents of the bluetooth scan results.
*
* @typedef BluetoothScanResult
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface BluetoothScanResult {
/**
* Address of the scanned device
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
deviceId: string;
/**
* RSSI of the scanned device
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
rssi: number;
/**
* The raw data of broadcast packet
*
* @type { ?ArrayBuffer }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
data?: ArrayBuffer;
/**
* The local name of the scanned device
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
deviceName: string;
/**
* Connectable of the scanned device
*
* @type { boolean }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'16','1.2':'20'}
* @arkts 1.1&1.2
*/
connectable: boolean;
}
/**
* Describes the information about a single POI.
*
* @typedef Poi
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
export interface Poi {
/**
* Indicates the ID of a POI.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
id: string;
/**
* Indicates the confidence of POI information.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
confidence: number;
/**
* Indicates the name of the POI.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
name: string;
/**
* Indicates the latitude of POI.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
latitude: number;
/**
* Indicates the longitude of POI.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
longitude: number;
/**
* Indicates administrative region name.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
administrativeArea: string;
/**
* Indicates sub-administrative region name.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
subAdministrativeArea: string;
/**
* Indicates locality information.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
locality: string;
/**
* Indicates sub-locality information.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
subLocality: string;
/**
* Indicates the detailed address of the POI.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
address: string;
}
/**
* Describes the POI information struct.
*
* @typedef PoiInfo
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
export interface PoiInfo {
/**
* Indicates POI information list.
*
* @type { Array<Poi> }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
poiArray: Array<Poi>;
/**
* Indicates the timestamp when the POI information is obtained.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 19
*/
timestamp: number;
}
/**
* Beacon equipment manufacturer data.
*
* @typedef BeaconManufactureData
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
export interface BeaconManufactureData {
/**
* Manufacture id.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
manufactureId: number;
/**
* Manufacture data.
*
* @type { ArrayBuffer }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
manufactureData: ArrayBuffer;
/**
* Manufacture data mask.
*
* @type { ArrayBuffer }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
manufactureDataMask: ArrayBuffer;
}
/**
* Beacon fence details.
*
* @typedef BeaconFence
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
export interface BeaconFence {
/**
* Identifier of the beacon fence.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
identifier: string;
/**
* Beacon fence information type.
*
* @type { BeaconFenceInfoType }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
beaconFenceInfoType: BeaconFenceInfoType;
/**
* Beacon equipment manufacture data.
*
* @type { ?BeaconManufactureData }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
manufactureData?: BeaconManufactureData;
}
/**
* Configuring parameters in BeaconFence request.
*
* @typedef BeaconFenceRequest
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
export interface BeaconFenceRequest {
/**
* Beacon fence information.
*
* @type { BeaconFence }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
beacon: BeaconFence;
/**
* Indicates the callback for reporting the BeaconFence transition status.
*
* @type { ?Callback<GeofenceTransition> }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
transitionCallback?: Callback<GeofenceTransition>;
/**
* Indicates the name of FenceExtensionAbility.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
fenceExtensionAbilityName?: string;
}
/**
* Enum for the source of the location.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocationSourceType {
/**
* The location is obtained from the GNSS.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
GNSS = 1,
/**
* The location comes from the network positioning technology.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
NETWORK = 2,
/**
* The location comes from the indoor positioning technology.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
INDOOR = 3,
/**
* The location comes from the GNSS RTK technology.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
RTK = 4
}
/**
* Enum for coordinate system type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum CoordinateSystemType {
/**
* WGS84 coordinates system.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
WGS84 = 1,
/**
* GCJ-02 coordinates system.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
GCJ02 = 2
}
/**
* Enum for location icon status.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocationIconStatus {
/**
* The locating service is not started.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_NOT_STARTED = 0,
/**
* The normal locating service is started.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_STARTED = 1,
/**
* The HD locating service(RTK) is started.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
HD_LOCATING_STARTED = 2
}
/**
* Enum for location error code.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocationError {
/**
* Default cause for location failure.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_FAILED_DEFAULT = -1,
/**
* Locating failed because the location permission fails to be verified.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_FAILED_LOCATION_PERMISSION_DENIED = -2,
/**
* Locating failed because the app is in the background and the background location permission verification failed.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_FAILED_BACKGROUND_PERMISSION_DENIED = -3,
/**
* Locating failed because the location switch is turned off.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_FAILED_LOCATION_SWITCH_OFF = -4,
/**
* Locating failed because internet access failure.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOCATING_FAILED_INTERNET_ACCESS_FAILURE = -5
}
/**
* Enum for geofence transition status.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
export enum GeofenceTransitionEvent {
/**
* The device is within the geofence.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
GEOFENCE_TRANSITION_EVENT_ENTER = 1,
/**
* The device is out of the geofence.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
GEOFENCE_TRANSITION_EVENT_EXIT = 2,
/**
* The device is in the geographical fence for a period of time.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
GEOFENCE_TRANSITION_EVENT_DWELL = 4
}
/**
* Enum for satellite constellation category.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum SatelliteConstellationCategory {
/**
* Invalid value.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_UNKNOWN = 0,
/**
* GPS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_GPS = 1,
/**
* SBAS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_SBAS = 2,
/**
* GLONASS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_GLONASS = 3,
/**
* QZSS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_QZSS = 4,
/**
* BEIDOU.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_BEIDOU = 5,
/**
* GALILEO.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_GALILEO = 6,
/**
* IRNSS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
CONSTELLATION_CATEGORY_IRNSS = 7
}
/**
* Enum for satellite additional information.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum SatelliteAdditionalInfo {
/**
* Default value.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SATELLITES_ADDITIONAL_INFO_NULL = 0,
/**
* Ephemeris data exist.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SATELLITES_ADDITIONAL_INFO_EPHEMERIS_DATA_EXIST = 1,
/**
* Almanac data exist.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SATELLITES_ADDITIONAL_INFO_ALMANAC_DATA_EXIST = 2,
/**
* This satellite is being used in location fix.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SATELLITES_ADDITIONAL_INFO_USED_IN_FIX = 4,
/**
* Carrier frequency exist.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SATELLITES_ADDITIONAL_INFO_CARRIER_FREQUENCY_EXIST = 8
}
/**
* Enum for user activity scenario.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum UserActivityScenario {
/**
* Navigation scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
NAVIGATION = 0x401,
/**
* Sport scenario. High positioning precision is required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
SPORT = 0x402,
/**
* Transport scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
TRANSPORT = 0x403,
/**
* Daily life scenarios. Low requirements on positioning precision.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
DAILY_LIFE_SERVICE = 0x404
}
/**
* Enum for locating priority.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocatingPriority {
/**
* Preferentially ensure the highest locating accuracy.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
PRIORITY_ACCURACY = 0x501,
/**
* Preferentially ensure the fastest locating speed.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
PRIORITY_LOCATING_SPEED = 0x502
}
/**
* Enum for location priority.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Enum for location priority.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocationRequestPriority {
/**
* Default priority.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Default priority.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
UNSET = 0x200,
/**
* Preferentially ensure the locating accuracy.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Preferentially ensure the locating accuracy.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
ACCURACY,
/**
* Preferentially ensure low power consumption for locating.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Preferentially ensure low power consumption for locating.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
LOW_POWER,
/**
* Preferentially ensure that the first location is time-consuming.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Preferentially ensure that the first location is time-consuming.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
FIRST_FIX
}
/**
* Enum for location scenario.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Enum for location scenario.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocationRequestScenario {
/**
* Default scenario.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Default scenario.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
UNSET = 0x300,
/**
* Navigation scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Navigation scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
NAVIGATION,
/**
* Trajectory tracking scenario. High positioning precision is required.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Trajectory tracking scenario. High positioning precision is required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
TRAJECTORY_TRACKING,
/**
* Car hailing scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Car hailing scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
CAR_HAILING,
/**
* Daily life scenarios. Low requirements on positioning precision and real-time performance.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Daily life scenarios. Low requirements on positioning precision and real-time performance.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
DAILY_LIFE_SERVICE,
/**
* Power saving scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Power saving scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'11','1.2':'20'}
* @arkts 1.1&1.2
*/
NO_POWER
}
/**
* Enum for power consumption scenario.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum PowerConsumptionScenario {
/**
* High power consumption mode.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
HIGH_POWER_CONSUMPTION = 0x601,
/**
* Low power consumption mode.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
LOW_POWER_CONSUMPTION = 0x602,
/**
* Power saving scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'12','1.2':'20'}
* @arkts 1.1&1.2
*/
NO_POWER_CONSUMPTION = 0x603
}
/**
* Enum for location privacy type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocationPrivacyType {
/**
* Other scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
OTHERS = 0,
/**
* Privacy agreement for the startup wizard scenario.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
STARTUP,
/**
* Privacy agreement pop-up when network location is enabled.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
CORE_LOCATION
}
/**
* Enum for sports type
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum SportsType {
/**
* Indicates running.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
RUNNING = 1,
/**
* Indicates walking.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
WALKING,
/**
* Indicates cycling.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since arkts {'1.1':'18','1.2':'20'}
* @arkts 1.1&1.2
*/
CYCLING
}
/**
* Location subsystem command structure.
*
* @typedef LocationCommand
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
export interface LocationCommand {
/**
* Information about the scenario where the command is sent.
*
* @type { LocationRequestScenario }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
scenario: LocationRequestScenario;
/**
* Sent command content.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
command: string;
}
/**
* Country code structure.
*
* @typedef CountryCode
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export interface CountryCode {
/**
* Country code character string.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
country: string;
/**
* Country code source.
*
* @type { CountryCodeType }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
type: CountryCodeType;
}
/**
* Enum for country code type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum CountryCodeType {
/**
* Country code obtained from the locale setting.
*
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
COUNTRY_CODE_FROM_LOCALE = 1,
/**
* Country code obtained from the SIM information.
*
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
COUNTRY_CODE_FROM_SIM,
/**
* Query the country code information from the reverse geocoding result.
*
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
COUNTRY_CODE_FROM_LOCATION,
/**
* Obtain the country code from the cell registration information.
*
* @syscap SystemCapability.Location.Location.Core
* @since arkts {'1.1':'9','1.2':'20'}
* @arkts 1.1&1.2
*/
COUNTRY_CODE_FROM_NETWORK
}
/**
* Enum for locating required data type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
export enum LocatingRequiredDataType {
/**
* Obtains WiFi scanning information for locating.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
WIFI = 1,
/**
* Obtains BT scanning information for locating.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since arkts {'1.1':'10','1.2':'20'}
* @arkts 1.1&1.2
*/
BLUETOOTH
}
/**
* Enum for the beacon fence information type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
export enum BeaconFenceInfoType {
/**
* Identifies a beacon device using beacon device manufacture data.
*
* @syscap SystemCapability.Location.Location.Geofence
* @atomicservice
* @since 20
*/
BEACON_MANUFACTURE_DATA = 1
}
}
export default geoLocationManager;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助