1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.geoLocationManager.d.ts 109.66 KB
一键复制 编辑 原始数据 按行查看 历史
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127
/*
* 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';
import { WantAgent } from './@ohos.wantAgent';
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 11
*/
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
*/
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
*/
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 12
*/
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 12
*/
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 9
*/
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 9
*/
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
*/
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
*/
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 9
*/
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 9
*/
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 9
*/
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 9
*/
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 9
*/
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 9
*/
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 10
*/
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 10
*/
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 12
*/
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 12
*/
function off(type: 'locationIconStatusChange', callback?: Callback<LocationIconStatus>): 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 12
*/
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 11
*/
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 12
*/
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 11
*/
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 11
*/
function isLocationEnabled(): 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
*/
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
*/
function enableLocation(): 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
*/
function disableLocation(): 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 9
*/
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 9
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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 9
*/
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;
/**
* 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 9
*/
export interface SatelliteStatusInfo {
/**
* Number of satellites.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
satellitesNumber: number;
/**
* Satellite ID array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
satelliteIds: Array<number>;
/**
* Carrier to noise density array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
carrierToNoiseDensitys: Array<number>;
/**
* Satellite altitude array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
altitudes: Array<number>;
/**
* Satellite azimuth array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
azimuths: Array<number>;
/**
* Satellite carrier frequency array.
*
* @type { Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
carrierFrequencies: Array<number>;
/**
* Satellite constellation type array.
*
* @type { ?Array<SatelliteConstellationCategory> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
satelliteConstellation?: Array<SatelliteConstellationCategory>;
/**
* Satellite additional information array.
*
* @type { ?Array<number> }
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
satelliteAdditionalInfo?: Array<number>;
}
/**
* Parameters for requesting to report cache location information.
*
* @typedef CachedGnssLocationsRequest
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
export interface CachedGnssLocationsRequest {
/**
* GNSS cache location report period.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since 9
*/
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 9
*/
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 9
*/
export interface ReverseGeoCodeRequest {
/**
* Indicates the language area information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
locale?: string;
/**
* Indicates the country information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 12
*/
country?: string;
/**
* Latitude for reverse geocoding query.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
latitude: number;
/**
* Longitude for reverse geocoding query.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
longitude: number;
/**
* Indicates the maximum number of addresses returned by reverse geocoding query.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
maxItems?: number;
}
/**
* Configuring parameters in geocode requests.
*
* @typedef GeoCodeRequest
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
export interface GeoCodeRequest {
/**
* Indicates the language area information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
locale?: string;
/**
* Indicates the country information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 12
*/
country?: string;
/**
* Address information.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
description: string;
/**
* Indicates the maximum number of geocode query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
maxItems?: number;
/**
* Indicates the minimum latitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
minLatitude?: number;
/**
* Indicates the minimum longitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
minLongitude?: number;
/**
* Indicates the maximum latitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
maxLatitude?: number;
/**
* Indicates the maximum longitude for geocoding query results.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
maxLongitude?: number;
}
/**
* Data struct describes geographic locations.
*
* @typedef GeoAddress
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
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 9
*/
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 9
*/
longitude?: number;
/**
* Indicates language used for the location description.
* zh indicates Chinese, and en indicates English.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
locale?: string;
/**
* Indicates detailed address information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
placeName?: string;
/**
* Indicates country code.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
countryCode?: string;
/**
* Indicates country name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
countryName?: string;
/**
* Indicates administrative region name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
administrativeArea?: string;
/**
* Indicates sub-administrative region name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
subAdministrativeArea?: string;
/**
* Indicates locality information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
locality?: string;
/**
* Indicates sub-locality information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
subLocality?: string;
/**
* Indicates road name.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
roadName?: string;
/**
* Indicates auxiliary road information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
subRoadName?: string;
/**
* Indicates house information.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
premises?: string;
/**
* Indicates postal code.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
postalCode?: string;
/**
* Indicates phone number.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
phoneNumber?: string;
/**
* Indicates website URL.
*
* @type { ?string }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
addressUrl?: string;
/**
* Indicates additional information.
*
* @type { ?Array<string> }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
descriptions?: Array<string>;
/**
* Indicates the amount of additional descriptive information.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Geocoder
* @since 9
*/
descriptionsSize?: number;
/**
* Indicates whether it is an mock GeoAddress
*
* @type { ?Boolean }
* @syscap SystemCapability.Location.Location.Geocoder
* @systemapi
* @since 9
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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;
}
/**
* Configuring parameters in continuous location requests.
*
* @typedef ContinuousLocationRequest
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export interface ContinuousLocationRequest {
/**
* Location report interval, in seconds.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
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 12
*/
locationScenario: UserActivityScenario | PowerConsumptionScenario;
}
/**
* Configuring parameters in single location requests.
*
* @typedef SingleLocationRequest
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export interface SingleLocationRequest {
/**
* Priority of the location request.
*
* @type { LocatingPriority }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
locatingPriority: LocatingPriority;
/**
* Timeout of a single location request, in milliseconds.
*
* @type { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
locatingTimeoutMs: number;
}
/**
* 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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
additions?: Array<string>;
/**
* Indicates additional information map.
*
* @type { ?Map<string, string> }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
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 11
*/
additionSize?: number;
/**
* Indicates whether it is an mock location.
*
* @type { ?Boolean }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
isFromMock?: Boolean;
/**
* Indicates vertical position accuracy in meters.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
altitudeAccuracy?: number;
/**
* Indicates speed accuracy in meter per seconds.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
speedAccuracy?: number;
/**
* Indicates direction accuracy in degrees.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
directionAccuracy?: number;
/**
* Time uncertainty Of timeSinceBoot in nanosecond.
*
* @type { ?number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
uncertaintyOfTimeSinceBoot?: number;
/**
* Indicates the source of the location.
*
* @type { ?LocationSourceType }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
sourceType?: LocationSourceType;
}
/**
* Describes the request parameters for obtaining the data required for locating.
* @typedef LocatingRequiredDataConfig
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
export interface LocatingRequiredDataConfig {
/**
* Indicates the type of locating required data.
*
* @type {LocatingRequiredDataType}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
type: LocatingRequiredDataType;
/**
* Indicates whether to start scanning.
*
* @type {boolean}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
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 10
*/
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 10
*/
scanTimeout?: number;
}
/**
* Describes the structure of the data required for locating.
* @typedef LocatingRequiredData
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
export interface LocatingRequiredData {
/**
* WiFi scan info.
*
* @type {?WifiScanInfo}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
wifiData?: WifiScanInfo;
/**
* Bluetooth scan info.
*
* @type {?BluetoothScanInfo}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
bluetoothData?: BluetoothScanInfo;
}
/**
* Describes the scanned WiFi information.
* @typedef WifiScanInfo
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
export interface WifiScanInfo {
/**
* WiFi SSID: the maximum length is 32.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
ssid: string;
/**
* WiFi bssid(MAC): the length is 6.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
bssid: string;
/**
* Received signal strength indicator (RSSI).
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
rssi: number;
/**
* Frequency
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
frequency: number;
/**
* Time stamp.
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
timestamp: number;
}
/**
* Describes the contents of the Bluetooth scan results.
*
* @typedef BluetoothScanInfo
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
export interface BluetoothScanInfo {
/**
* The local name of the device.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
deviceName: string;
/**
* Mac address of the scanned device.
*
* @type {string}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
macAddress: string;
/**
* RSSI of the remote device.
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
rssi: number;
/**
* Time stamp.
*
* @type {number}
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
timestamp: number;
}
/**
* Enum for the source of the location.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export enum LocationSourceType {
/**
* The location is obtained from the GNSS.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
GNSS = 1,
/**
* The location comes from the network positioning technology.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
NETWORK = 2,
/**
* The location comes from the indoor positioning technology.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
INDOOR = 3,
/**
* The location comes from the GNSS RTK technology.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
RTK = 4
}
/**
* Enum for coordinate system type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
export enum CoordinateSystemType {
/**
* WGS84 coordinates system.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
WGS84 = 1,
/**
* GCJ-02 coordinates system.
*
* @syscap SystemCapability.Location.Location.Geofence
* @since 12
*/
GCJ02 = 2
}
/**
* Enum for location icon status.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 12
*/
export enum LocationIconStatus {
/**
* The locating service is not started.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 12
*/
LOCATING_NOT_STARTED = 0,
/**
* The normal locating service is started.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 12
*/
LOCATING_STARTED = 1,
/**
* The HD locating service(RTK) is started.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 12
*/
HD_LOCATING_STARTED = 2
}
/**
* Enum for location error code.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export enum LocationError {
/**
* Default cause for location failure.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
LOCATING_FAILED_DEFAULT = -1,
/**
* Locating failed because the location permission fails to be verified.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
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 12
*/
LOCATING_FAILED_BACKGROUND_PERMISSION_DENIED = -3,
/**
* Locating failed because the location switch is turned off.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
LOCATING_FAILED_LOCATION_SWITCH_OFF = -4,
/**
* Locating failed because internet access failure.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
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 12
*/
export enum SatelliteConstellationCategory {
/**
* Invalid value.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_UNKNOWN = 0,
/**
* GPS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_GPS = 1,
/**
* SBAS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_SBAS = 2,
/**
* GLONASS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_GLONASS = 3,
/**
* QZSS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_QZSS = 4,
/**
* BEIDOU.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_BEIDOU = 5,
/**
* GALILEO.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_GALILEO = 6,
/**
* IRNSS.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
CONSTELLATION_CATEGORY_IRNSS = 7
}
/**
* Enum for satellite additional information.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
export enum SatelliteAdditionalInfo {
/**
* Default value.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
SATELLITES_ADDITIONAL_INFO_NULL = 0,
/**
* Ephemeris data exist.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
SATELLITES_ADDITIONAL_INFO_EPHEMERIS_DATA_EXIST = 1,
/**
* Almanac data exist.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
SATELLITES_ADDITIONAL_INFO_ALMANAC_DATA_EXIST = 2,
/**
* This satellite is being used in location fix.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
SATELLITES_ADDITIONAL_INFO_USED_IN_FIX = 4,
/**
* Carrier frequency exist.
*
* @syscap SystemCapability.Location.Location.Gnss
* @since 12
*/
SATELLITES_ADDITIONAL_INFO_CARRIER_FREQUENCY_EXIST = 8
}
/**
* Enum for user activity scenario.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export enum UserActivityScenario {
/**
* Navigation scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
NAVIGATION = 0x401,
/**
* Sport scenario. High positioning precision is required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
SPORT = 0x402,
/**
* Transport scenario. High positioning precision and real-time performance are required.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
TRANSPORT = 0x403,
/**
* Daily life scenarios. Low requirements on positioning precision.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
DAILY_LIFE_SERVICE = 0x404
}
/**
* Enum for locating priority.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export enum LocatingPriority {
/**
* Preferentially ensure the highest locating accuracy.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
PRIORITY_ACCURACY = 0x501,
/**
* Preferentially ensure the fastest locating speed.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
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 11
*/
export enum LocationRequestPriority {
/**
* Default priority.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Default priority.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
export enum LocationRequestScenario {
/**
* Default scenario.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Default scenario.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
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 11
*/
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 11
*/
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 11
*/
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 11
*/
DAILY_LIFE_SERVICE,
/**
* Power saving scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
/**
* Power saving scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 11
*/
NO_POWER
}
/**
* Enum for power consumption scenario.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
export enum PowerConsumptionScenario {
/**
* High power consumption mode.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
HIGH_POWER_CONSUMPTION = 0x601,
/**
* Low power consumption mode.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
LOW_POWER_CONSUMPTION = 0x602,
/**
* Power saving scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @atomicservice
* @since 12
*/
NO_POWER_CONSUMPTION = 0x603
}
/**
* Enum for location privacy type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
export enum LocationPrivacyType {
/**
* Other scenarios.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
OTHERS = 0,
/**
* Privacy agreement for the startup wizard scenario.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
STARTUP,
/**
* Privacy agreement pop-up when network location is enabled.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 9
*/
CORE_LOCATION
}
/**
* 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 9
*/
export interface CountryCode {
/**
* Country code character string.
*
* @type { string }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
country: string;
/**
* Country code source.
*
* @type { CountryCodeType }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
type: CountryCodeType;
}
/**
* Enum for country code type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
export enum CountryCodeType {
/**
* Country code obtained from the locale setting.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
COUNTRY_CODE_FROM_LOCALE = 1,
/**
* Country code obtained from the SIM information.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
COUNTRY_CODE_FROM_SIM,
/**
* Query the country code information from the reverse geocoding result.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
COUNTRY_CODE_FROM_LOCATION,
/**
* Obtain the country code from the cell registration information.
*
* @syscap SystemCapability.Location.Location.Core
* @since 9
*/
COUNTRY_CODE_FROM_NETWORK
}
/**
* Enum for locating required data type.
*
* @enum { number }
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
export enum LocatingRequiredDataType {
/**
* Obtains WiFi scanning information for locating.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
WIFI = 1,
/**
* Obtains BT scanning information for locating.
*
* @syscap SystemCapability.Location.Location.Core
* @systemapi
* @since 10
*/
BLUETOOTH
}
}
export default geoLocationManager;
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助