鴻蒙開發設備管理：【@ohos.geolocation (位置服務)】

位置服務

說明： 本模塊首批接口從API version 7開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

import geolocation from '@ohos.geolocation';

geolocation.on(‘locationChange’)

on(type: ‘locationChange’, request: LocationRequest, callback: Callback) : void

開啟位置變化訂閱，并發起定位請求。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“locationChange”，表示位置變化。
request	LocationRequest	是	設置位置請求參數。
callback	Callback<[Location]>	是	接收位置變化狀態變化監聽。

示例：

var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {console.log('locationChanger: data: ' + JSON.stringify(location));
};
geolocation.on('locationChange', requestInfo, locationChange);

geolocation.off(‘locationChange’)

off(type: ‘locationChange’, callback?: Callback) : void

關閉位置變化訂閱，并刪除對應的定位請求。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
type string 是設置事件類型。type為“locationChange”，表示位置變化。
callback Callback<[Location]> 否接收位置變化狀態變化監聽。

示例：

var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0};
var locationChange = (location) => {console.log('locationChanger: data: ' + JSON.stringify(location));
};
geolocation.on('locationChange', requestInfo, locationChange);
geolocation.off('locationChange', locationChange);

geolocation.on(‘locationServiceState’)

on(type: ‘locationServiceState’, callback: Callback) : void

訂閱位置服務狀態變化。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
type string 是設置事件類型。type為“locationServiceState”，表示位置服務狀態。
callback Callback 是接收位置服務狀態變化監聽。

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“locationServiceState”，表示位置服務狀態。
callback	Callback	是	接收位置服務狀態變化監聽。

示例：

var locationServiceState = (state) => {console.log('locationServiceState: ' + state);
}
geolocation.on('locationServiceState', locationServiceState);

geolocation.off(‘locationServiceState’)

off(type: ‘locationServiceState’, callback?: Callback) : void;

取消訂閱位置服務狀態變化。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
type string 是設置事件類型。type為“locationServiceState”，表示位置服務狀態。
callback Callback 否接收位置服務狀態變化監聽。

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“locationServiceState”，表示位置服務狀態。
callback	Callback	否	接收位置服務狀態變化監聽。

示例：

var locationServiceState = (state) => {console.log('locationServiceState: state: ' + state);
}
geolocation.on('locationServiceState', locationServiceState);
geolocation.off('locationServiceState', locationServiceState);

geolocation.on(‘cachedGnssLocationsReporting’)8+

on(type: ‘cachedGnssLocationsReporting’, request: CachedGnssLocationsRequest, callback: Callback<Array>) : void;

訂閱緩存GNSS定位結果上報事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“cachedGnssLocationsReporting”，表示GNSS緩存定位結果上報。
request	CachedGnssLocationsRequest	是	GNSS緩存功能配置參數
callback	Callback	是	接收GNSS緩存位置上報。

示例：

var cachedLocationsCb = (locations) => {console.log('cachedGnssLocationsReporting: locations: ' + locations);
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);

geolocation.off(‘cachedGnssLocationsReporting’)8+

off(type: ‘cachedGnssLocationsReporting’, callback?: Callback<Array>) : void;

取消訂閱緩存GNSS定位結果上報事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
type string 是設置事件類型。type為“cachedGnssLocationsReporting”，表示GNSS緩存定位結果上報。
callback Callback 否接收GNSS緩存位置上報。

示例：

var cachedLocationsCb = (locations) => {console.log('cachedGnssLocationsReporting: locations: ' + locations);
}
var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true};
geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb);
geolocation.off('cachedGnssLocationsReporting');

geolocation.on(‘gnssStatusChange’)8+

on(type: ‘gnssStatusChange’, callback: Callback) : void;

訂閱GNSS衛星狀態信息上報事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
type string 是設置事件類型。type為“gnssStatusChange”，表示訂閱GNSS衛星狀態信息上報。
callback Callback 是接收GNSS衛星狀態信息上報。

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“gnssStatusChange”，表示訂閱GNSS衛星狀態信息上報。
callback	Callback	是	接收GNSS衛星狀態信息上報。

示例：

var gnssStatusCb = (satelliteStatusInfo) => {console.log('gnssStatusChange: ' + satelliteStatusInfo);
}
geolocation.on('gnssStatusChange', gnssStatusCb);

geolocation.off(‘gnssStatusChange’)8+

off(type: ‘gnssStatusChange’, callback?: Callback) : void;

取消訂閱GNSS衛星狀態信息上報事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
type string 是設置事件類型。type為“gnssStatusChange”，表示訂閱GNSS衛星狀態信息上報。
callback Callback 否接收GNSS衛星狀態信息上報。

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“gnssStatusChange”，表示訂閱GNSS衛星狀態信息上報。
callback	Callback	否	接收GNSS衛星狀態信息上報。

示例：

var gnssStatusCb = (satelliteStatusInfo) => {console.log('gnssStatusChange: ' + satelliteStatusInfo);
}
geolocation.on('gnssStatusChange', gnssStatusCb);
geolocation.off('gnssStatusChange', gnssStatusCb);

geolocation.on(‘nmeaMessageChange’)8+

on(type: ‘nmeaMessageChange’, callback: Callback) : void;

訂閱GNSS NMEA信息上報事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
type string 是設置事件類型。type為“nmeaMessageChange”，表示訂閱GNSS NMEA信息上報。
callback Callback 是接收GNSS NMEA信息上報。

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“nmeaMessageChange”，表示訂閱GNSS NMEA信息上報。
callback	Callback	是	接收GNSS NMEA信息上報。

示例：

var nmeaCb = (str) => {console.log('nmeaMessageChange: ' + str);
}
geolocation.on('nmeaMessageChange', nmeaCb );

geolocation.off(‘nmeaMessageChange’)8+

off(type: ‘nmeaMessageChange’, callback?: Callback) : void;

取消訂閱GNSS NMEA信息上報事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
type string 是設置事件類型。type為“nmeaMessageChange”，表示訂閱GNSS NMEA信息上報。
callback Callback 否接收GNSS NMEA信息上報。

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“nmeaMessageChange”，表示訂閱GNSS NMEA信息上報。
callback	Callback	否	接收GNSS NMEA信息上報。

示例：

var nmeaCb = (str) => {console.log('nmeaMessageChange: ' + str);
}
geolocation.on('nmeaMessageChange', nmeaCb);
geolocation.off('nmeaMessageChange', nmeaCb);

geolocation.on(‘fenceStatusChange’)8+

on(type: ‘fenceStatusChange’, request: GeofenceRequest, want: WantAgent) : void;

添加一個圍欄，并訂閱地理圍欄事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geofence

參數：

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“fenceStatusChange”，表示訂閱圍欄事件上報。
request	GeofenceRequest	是	圍欄的配置參數。
want	WantAgent	是	用于接收地理圍欄事件上報（進出圍欄）。

示例：

import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent對象
var wantAgent;
//getWantAgent回調
function getWantAgentCallback(err, data) {console.info("==========================>getWantAgentCallback=======================>");if (err.code == 0) {wantAgent = data;} else {console.info('----getWantAgent failed!----');}
}
//WantAgentInfo對象
var wantAgentInfo = {wants: [{deviceId: "deviceId",bundleName: "com.neu.setResultOnAbilityResultTest1",abilityName: "com.example.test.MainAbility",action: "action1",entities: ["entity1"],type: "MIMETYPE",uri: "key={true,true,false}",parameters:{mykey0: 2222,mykey1: [1, 2, 3],mykey2: "[1, 2, 3]",mykey3: "ssssssssssssssssssssssssss",mykey4: [false, true, false],mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],mykey6: true,}}],operationType: OperationType.START_ABILITIES,requestCode: 0,wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
geolocation.on('fenceStatusChange', requestInfo, wantAgent);

geolocation.off(‘fenceStatusChange’)8+

off(type: ‘fenceStatusChange’, request: GeofenceRequest, want: WantAgent) : void;

刪除一個圍欄，并取消訂閱該圍欄事件。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geofence

參數：

參數名	類型	必填	說明
type	string	是	設置事件類型。type為“fenceStatusChange”，表示訂閱圍欄事件上報。
request	GeofenceRequest	是	圍欄的配置參數。
want	WantAgent	是	用于接收地理圍欄事件上報（進出圍欄）。

示例：

import WantAgent from '@ohos.wantAgent';
import { OperationType, WantAgentFlags } from '@ohos.wantagent';
//wantAgent對象
var wantAgent;
//getWantAgent回調
function getWantAgentCallback(err, data) {console.info("==========================>getWantAgentCallback=======================>");if (err.code == 0) {wantAgent = data;} else {console.info('----getWantAgent failed!----');}
}
//WantAgentInfo對象
var wantAgentInfo = {wants: [{deviceId: "deviceId",bundleName: "com.neu.setResultOnAbilityResultTest1",abilityName: "com.example.test.MainAbility",action: "action1",entities: ["entity1"],type: "MIMETYPE",uri: "key={true,true,false}",parameters:{mykey0: 2222,mykey1: [1, 2, 3],mykey2: "[1, 2, 3]",mykey3: "ssssssssssssssssssssssssss",mykey4: [false, true, false],mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],mykey6: true,}}],operationType: OperationType.START_ABILITIES,requestCode: 0,wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG]
}
WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback)
var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}};
geolocation.on('fenceStatusChange', requestInfo, wantAgent);
geolocation.off('fenceStatusChange', requestInfo, wantAgent);

geolocation.getCurrentLocation

getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback) : void

獲取當前位置，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
request [CurrentLocationRequest] 否設置位置請求參數。
callback AsyncCallback<[Location]> 是用來接收位置信息的回調。

參數名	類型	必填	說明
request	[CurrentLocationRequest]	否	設置位置請求參數。
callback	AsyncCallback<[Location]>	是	用來接收位置信息的回調。

示例：

var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
var locationChange = (err, location) => {console.log('locationChanger: ' + err + 'data: ' + location);
};
geolocation.getCurrentLocation(requestInfo, locationChange);
geolocation.getCurrentLocation(locationChange);

geolocation.getCurrentLocation

getCurrentLocation(request?: CurrentLocationRequest) : Promise

獲取當前位置，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
request [CurrentLocationRequest] 否設置位置請求參數。
返回值：

參數名說明
Promise<[Location]> 返回位置信息。

參數名	類型	必填	說明
request	[CurrentLocationRequest]	否	設置位置請求參數。

參數名	說明
Promise<[Location]>	返回位置信息。

示例：

var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0};
locationEventListener.getCurrentLocation(requestInfo).then((result) => {console.log('current location: ' + JSON.stringify(result));
});

geolocation.getLastLocation

getLastLocation(callback: AsyncCallback) : void

獲取上一次位置，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
callback AsyncCallback<[Location]> 是用來接收上次位置的回調。

參數名	類型	必填	說明
callback	AsyncCallback<[Location]>	是	用來接收上次位置的回調。

示例：

geolocation.getLastLocation((err, data) => {console.log('getLastLocation: ' + err + " data: " + JSON.stringify(data));
});

geolocation.getLastLocation

getLastLocation() : Promise

獲取上一次位置，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

返回值：

參數名說明
Promise<[Location]> 返回上次位置信息。

參數名	說明
Promise<[Location]>	返回上次位置信息。

示例：

geolocation.getLastLocation().then((result) => {console.log('getLastLocation: result: ' + JSON.stringify(result));
});

geolocation.isLocationEnabled

isLocationEnabled(callback: AsyncCallback) : void

判斷位置服務是否已經打開，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收位置服務狀態的回調。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收位置服務狀態的回調。

示例：

geolocation.isLocationEnabled((err, data) => {console.log('isLocationEnabled: ' + err + " data: " + data);
});

geolocation.isLocationEnabled

isLocationEnabled() : Promise

判斷位置服務是否已經開啟，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

返回值：

參數名說明
Promise 返回位置服務是否可用的狀態。

參數名	說明
Promise	返回位置服務是否可用的狀態。

示例：

geolocation.isLocationEnabled().then((result) => {console.log('promise, isLocationEnabled: ' + result);
});

geolocation.requestEnableLocation

requestEnableLocation(callback: AsyncCallback) : void

請求打開位置服務，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收位置服務狀態的回調。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收位置服務狀態的回調。

示例：

geolocation.requestEnableLocation((err, data) => {console.log('requestEnableLocation: ' + err + " data: " + data);
});

geolocation.requestEnableLocation

requestEnableLocation() : Promise

請求打開位置服務，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

返回值：

參數名說明
Promise 返回位置服務是否可用。

參數名	說明
Promise	返回位置服務是否可用。

示例：

geolocation.requestEnableLocation().then((result) => {console.log('promise, requestEnableLocation: ' + result);
});

geolocation.enableLocation

enableLocation(callback: AsyncCallback) : void;

打開位置服務，使用callback回調異步返回結果。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收位置服務狀態的回調。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收位置服務狀態的回調。

示例：

geolocation.enableLocation((err, data) => {console.log('enableLocation: ' + err + " data: " + data);
});

geolocation.enableLocation

enableLocation() : Promise

打開位置服務，使用Promise方式異步返回結果。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

返回值：

參數名說明
Promise 返回位置服務是否可用。

參數名	說明
Promise	返回位置服務是否可用。

示例：

geolocation.enableLocation().then((result) => {console.log('promise, enableLocation: ' + result);
});

geolocation.disableLocation

disableLocation(callback: AsyncCallback) : void;

打開位置服務，使用callback回調異步返回結果。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收位置服務狀態的回調。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收位置服務狀態的回調。

示例：

geolocation.disableLocation((err, data) => {console.log('disableLocation: ' + err + " data: " + data);
});

geolocation.disableLocation

disableLocation() : Promise

打開位置服務，使用Promise方式異步返回結果。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

返回值：

參數名說明
Promise 返回位置服務是否可用。

參數名	說明
Promise	返回位置服務是否可用。

示例：

geolocation.disableLocation().then((result) => {console.log('promise, disableLocation: ' + result);
});

geolocation.isGeoServiceAvailable

isGeoServiceAvailable(callback: AsyncCallback) : void

判斷（逆）地理編碼服務狀態，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收地理編碼服務狀態的回調。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收地理編碼服務狀態的回調。

示例：

geolocation.isGeoServiceAvailable((err, data) => {console.log('isGeoServiceAvailable: ' + err + " data: " + data);
});

geolocation.isGeoServiceAvailable

isGeoServiceAvailable() : Promise

判斷（逆）地理編碼服務狀態，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

返回值：

參數名說明
Promise 返回地理編碼服務是否可用的狀態。

參數名	說明
Promise	返回地理編碼服務是否可用的狀態。

示例：

geolocation.isGeoServiceAvailable().then((result) => {console.log('promise, isGeoServiceAvailable: ' + result);
});

geolocation.getAddressesFromLocation

getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array>) : void

調用逆地理編碼服務，將坐標轉換為地理描述，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

參數：

參數名	類型	必填	說明
request	[ReverseGeoCodeRequest]	是	設置逆地理編碼請求的相關參數。
callback	AsyncCallback<Array<[GeoAddress]>>	是	設置接收逆地理編碼請求的回調參數。

示例：

var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => {console.log('getAddressesFromLocation: ' + err + " data: " + JSON.stringify(data));
});

geolocation.getAddressesFromLocation

getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array>;

調用逆地理編碼服務，將坐標轉換為地理描述，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

參數：

參數名類型必填說明
request [ReverseGeoCodeRequest] 是設置逆地理編碼請求的相關參數。
返回值：

參數名說明
Promise<Array<[GeoAddress]>> 返回地理描述信息。

參數名	說明
Promise<Array<[GeoAddress]>>	返回地理描述信息。

示例：

var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1};
geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => {console.log('getAddressesFromLocation: ' + JSON.stringify(data));
});

geolocation.getAddressesFromLocationName

getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array>) : void

調用地理編碼服務，將地理描述轉換為具體坐標，使用callback回調異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

參數：

參數名類型必填說明
request [GeoCodeRequest] 是設置地理編碼請求的相關參數。
callback AsyncCallback<Array<[GeoAddress])>> 是設置接收地理編碼請求的回調參數。

參數名	類型	必填	說明
request	[GeoCodeRequest]	是	設置地理編碼請求的相關參數。
callback	AsyncCallback<Array<[GeoAddress])>>	是	設置接收地理編碼請求的回調參數。

示例：

var geocodeRequest = {"description": "上海市浦東新區xx路xx號", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => {console.log('getAddressesFromLocationName: ' + err + " data: " + JSON.stringify(data));
});

geolocation.getAddressesFromLocationName

getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array>

調用地理編碼服務，將地理描述轉換為具體坐標，使用Promise方式異步返回結果。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

參數：

參數名類型必填說明
request [GeoCodeRequest] 是設置地理編碼請求的相關參數。
返回值：

參數名說明
Promise<Array<[GeoAddress]>> 設置接收地理編碼請求的回調參數。

參數名	類型	必填	說明
request	[GeoCodeRequest]	是	設置地理編碼請求的相關參數。

參數名	說明
Promise<Array<[GeoAddress]>>	設置接收地理編碼請求的回調參數。

示例：

var geocodeRequest = {"description": "上海市浦東新區xx路xx號", "maxItems": 1};
geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => {console.log('getAddressesFromLocationName: ' + JSON.stringify(result));
});

geolocation.getCachedGnssLocationsSize8+

getCachedGnssLocationsSize(callback: AsyncCallback) : void;

獲取GNSS芯片緩存位置的個數。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收GNSS芯片緩存位置個數的回調。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收GNSS芯片緩存位置個數的回調。

示例：

geolocation.getCachedGnssLocationsSize((err, size) => {console.log('getCachedGnssLocationsSize: err:' + err + " size: " + size);
});

geolocation.getCachedGnssLocationsSize8+

getCachedGnssLocationsSize() : Promise;

獲取GNSS芯片緩存位置的個數。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

返回值：

參數名說明
Promise 返回GNSS緩存位置的個數。

參數名	說明
Promise	返回GNSS緩存位置的個數。

示例：

geolocation.getCachedGnssLocationsSize().then((result) => {console.log('promise, getCachedGnssLocationsSize: ' + result);
});

geolocation.flushCachedGnssLocations8+

flushCachedGnssLocations(callback: AsyncCallback) : void;

讀取并清空GNSS芯片所有緩存位置。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

參數：

參數名類型必填說明
callback AsyncCallback 是用來接收清空GNSS芯片緩存位置操作的結果。

參數名	類型	必填	說明
callback	AsyncCallback	是	用來接收清空GNSS芯片緩存位置操作的結果。

示例：

geolocation.flushCachedGnssLocations((err, result) => {console.log('flushCachedGnssLocations: err:' + err + " result: " + result);
});

geolocation.flushCachedGnssLocations8+

flushCachedGnssLocations() : Promise;

讀取并清空GNSS芯片所有緩存位置。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

返回值：

參數名說明
Promise 清空所有GNSS緩存位置是否成功。

參數名	說明
Promise	清空所有GNSS緩存位置是否成功。

示例：

geolocation.flushCachedGnssLocations().then((result) => {console.log('promise, flushCachedGnssLocations: ' + result);
});

geolocation.sendCommand8+

sendCommand(command: LocationCommand, callback: AsyncCallback) : void;

給位置服務子系統的各個部件發送擴展命令。只有系統應用才能調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
command LocationCommand 是指定目標場景，和將要發送的命令（字符串）。
callback AsyncCallback 是用來接收命令發送的結果。

參數名	類型	必填	說明
command	LocationCommand	是	指定目標場景，和將要發送的命令（字符串）。
callback	AsyncCallback	是	用來接收命令發送的結果。

示例：

var requestInfo = {'scenario': 0x301, 'command': "command_1"};
geolocation.sendCommand(requestInfo, (err, result) => {console.log('sendCommand: err:' + err + " result: " + result);
});

geolocation.sendCommand8+

sendCommand(command: LocationCommand) : Promise;

給位置服務子系統的各個部件發送擴展命令。只有系統應用才能調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
command LocationCommand 是指定目標場景，和將要發送的命令（字符串）。
返回值：

參數名說明
Promise 表示命令發送成功或失敗。

參數名	類型	必填	說明
command	LocationCommand	是	指定目標場景，和將要發送的命令（字符串）。

參數名	說明
Promise	表示命令發送成功或失敗。

示例：

var requestInfo = {'scenario': 0x301, 'command': "command_1"};
geolocation.sendCommand(requestInfo).then((result) => {console.log('promise, sendCommand: ' + result);
});

geolocation.isLocationPrivacyConfirmed8+

isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback) : void;

查詢用戶是否同意定位服務隱私申明，是否同意啟用定位服務。只有系統應用才能調用。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名	類型	必填	說明
type	LocationPrivacyType	是	指定隱私申明場景，例如開機向導中的隱私申明、開啟網絡定位功能時彈出的隱私申明等。
callback	AsyncCallback	是	表示用戶是否同意定位服務隱私申明。

示例：

geolocation.isLocationPrivacyConfirmed(1, (err, result) => {console.log('isLocationPrivacyConfirmed: err:' + err + " result: " + result);
});

geolocation.isLocationPrivacyConfirmed8+

isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise;

查詢用戶是否同意定位服務隱私申明，是否同意啟用定位服務。只有系統應用才能調用。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名類型必填說明
type LocationPrivacyType 是指定隱私申明場景，例如開機向導中的隱私申明、開啟網絡定位功能時彈出的隱私申明等。
返回值：

參數名說明
Promise 表示用戶是否同意定位服務隱私申明。

參數名	說明
Promise	表示用戶是否同意定位服務隱私申明。

示例：

geolocation.isLocationPrivacyConfirmed(1).then((result) => {console.log('promise, isLocationPrivacyConfirmed: ' + result);
});

geolocation.setLocationPrivacyConfirmStatus8+

setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback) : void;

設置用戶勾選定位服務隱私申明的狀態，記錄用戶是否同意啟用定位服務。只有系統應用才能調用。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名	類型	必填	說明
type	LocationPrivacyType	是	指定隱私申明場景，例如開機向導中的隱私申明、開啟網絡定位功能時彈出的隱私申明等。
isConfirmed	boolean	是	表示用戶是否同意定位服務隱私申明。
callback	AsyncCallback	是	表示操作是否成功。

示例：

geolocation.setLocationPrivacyConfirmStatus(1, true, (err, result) => {console.log('isLocationPrivacyConfirmed: err:' + err + " result: " + result);
});

geolocation.setLocationPrivacyConfirmStatus8+

setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise;

設置用戶勾選定位服務隱私申明的狀態，記錄用戶是否同意啟用定位服務。只有系統應用才能調用。

系統API：此接口為系統接口，三方應用不支持調用。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

參數：

參數名	類型	必填	說明
type	LocationPrivacyType	是	指定隱私申明場景，例如開機向導中的隱私申明、開啟網絡定位功能時彈出的隱私申明等。
isConfirmed	boolean	是	表示用戶是否同意定位服務隱私申明。

返回值：

參數名說明
Promise 表示操作是否成功。

參數名	說明
Promise	表示操作是否成功。

示例：

geolocation.setLocationPrivacyConfirmStatus(1, true).then((result) => {console.log('promise, setLocationPrivacyConfirmStatus: ' + result);
});

LocationRequestPriority

位置請求中位置信息優先級設置。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	默認值	說明
UNSET	0x200	表示未設置優先級。
ACCURACY	0x201	表示精度優先。
LOW_POWER	0x202	表示低功耗優先。
FIRST_FIX	0x203	表示快速獲取位置優先，如果應用希望快速拿到1個位置，可以將優先級設置為該字段。

LocationRequestScenario

位置請求中定位場景設置。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	默認值	說明
UNSET	0x300	表示未設置場景信息。
NAVIGATION	0x301	表示導航場景。
TRAJECTORY_TRACKING	0x302	表示運動軌跡記錄場景。
CAR_HAILING	0x303	表示打車場景。
DAILY_LIFE_SERVICE	0x304	表示日常服務使用場景。
NO_POWER	0x305	表示無功耗功場景，這種場景下不會主動觸發定位，會在其他應用定位時，才給當前應用返回位置。

GeoLocationErrorCode

位置服務中的錯誤碼信息。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	默認值	說明
INPUT_PARAMS_ERROR	101	表示輸入參數錯誤。
REVERSE_GEOCODE_ERROR	102	表示逆地理編碼接口調用失敗。
GEOCODE_ERROR	103	表示地理編碼接口調用失敗。
LOCATOR_ERROR	104	表示定位失敗。
LOCATION_SWITCH_ERROR	105	表示定位開關。
LAST_KNOWN_LOCATION_ERROR	106	表示獲取上次位置失敗。
LOCATION_REQUEST_TIMEOUT_ERROR	107	表示單次定位，沒有在指定時間內返回位置。

ReverseGeoCodeRequest

逆地理編碼請求接口。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

名稱	參數類型	必填	說明
locale	string	否	指定位置描述信息的語言，“zh”代表中文，“en”代表英文。
latitude	number	是	表示緯度信息，正值表示北緯，負值表示南緯。
longitude	number	是	表示經度信息，正值表示東經，負值表示西經。
maxItems	number	否	指定返回位置信息的最大個數。

GeoCodeRequest

地理編碼請求接口。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

名稱	參數類型	必填	說明
locale	string	否	表示位置描述信息的語言，“zh”代表中文，“en”代表英文。
description	number	是	表示位置信息描述，如“上海市浦東新區xx路xx號”。
maxItems	number	否	表示返回位置信息的最大個數。
minLatitude	number	否	表示最小緯度信息，與下面三個參數一起，表示一個經緯度范圍。
minLongitude	number	否	表示最小經度信息。
maxLatitude	number	否	表示最大緯度信息。
maxLongitude	number	否	表示最大經度信息。

GeoAddress

地理編碼類型。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geocoder

名稱	參數類型	必填	說明
latitude	number	否	表示緯度信息，正值表示北緯，負值表示南緯。
longitude	number	否	表示經度信息，正值表示東經，負值表是西經。
locale	string	否	表示位置描述信息的語言，“zh”代表中文，“en”代表英文。
placeName	string	否	表示地區信息。
countryCode	string	否	表示國家碼信息。
countryName	string	否	表示國家信息。
administrativeArea	string	否	表示省份區域信息。
subAdministrativeArea	string	否	表示表示子區域信息。
locality	string	否	表示城市信息。
subLocality	string	否	表示子城市信息。
roadName	string	否	表示路名信息。
subRoadName	string	否	表示子路名信息。
premises	string	否	表示門牌號信息。
postalCode	string	否	表示郵政編碼信息。
phoneNumber	string	否	表示聯系方式信息。
addressUrl	string	否	表示位置信息附件的網址信息。
descriptions	Array	否	表示附加的描述信息。
descriptionsSize	number	否	表示附加的描述信息數量。

LocationRequest

位置信息請求類型。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	參數類型	必填	說明
priority	[LocationRequestPriority]	否	表示優先級信息。
scenario	[LocationRequestScenario]	是	表示場景信息。
timeInterval	number	否	表示上報位置信息的時間間隔。
distanceInterval	number	否	表示上報位置信息的距離間隔。
maxAccuracy	number	否	表示精度信息。

CurrentLocationRequest

當前位置信息請求類型。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	參數類型	必填	說明
priority	[LocationRequestPriority]	否	表示優先級信息。
scenario	[LocationRequestScenario]	否	表示場景信息。
maxAccuracy	number	否	表示精度信息，單位是米。
timeoutMs	number	否	表示超時時間，單位是毫秒，最小為1000毫秒。

SatelliteStatusInfo8+

衛星狀態信息。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

名稱	參數類型	必填	說明
satellitesNumber	number	是	表示衛星個數。
satelliteIds	Array	是	表示每個衛星的ID，數組類型。
carrierToNoiseDensitys	Array	是	表示載波噪聲功率譜密度比，即cn0。
altitudes	Array	是	表示高程信息。
azimuths	Array	是	表示方位角。
carrierFrequencies	Array	是	表示載波頻率。

CachedGnssLocationsRequest8+

請求訂閱GNSS緩存位置上報功能接口的配置參數。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Gnss

名稱	參數類型	必填	說明
reportingPeriodSec	number	是	表示GNSS緩存位置上報的周期，單位是毫秒。
wakeUpCacheQueueFull	boolean	是	true表示GNSS芯片底層緩存隊列滿之后會主動喚醒AP芯片，并把緩存位置上報給應用。 false表示GNSS芯片底層緩存隊列滿之后不會主動喚醒AP芯片，會把緩存位置直接丟棄。

Geofence8+

GNSS圍欄的配置參數。目前只支持圓形圍欄。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geofence

名稱	參數類型	必填	說明
latitude	number	是	表示緯度。
longitude	number	是	表示經度。
radius	number	是	表示圓形圍欄的半徑。
expiration	number	是	圍欄存活的時間，單位是毫秒。

GeofenceRequest8+

請求添加GNSS圍欄消息中攜帶的參數，包括定位優先級、定位場景和圍欄信息。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Geofence

名稱	參數類型	必填	說明
priority	LocationRequestPriority	是	表示位置信息優先級。
scenario	LocationRequestScenario	是	表示定位場景。
geofence	Geofence	是	表示圍欄信息。

LocationPrivacyType8+

定位服務隱私協議類型。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	默認值	說明
OTHERS	0	其他場景。
STARTUP	1	開機向導場景下的隱私協議。
CORE_LOCATION	2	開啟網絡定位時彈出的隱私協議。

LocationCommand8+

擴展命令結構體。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	參數類型	必填	說明
scenario	LocationRequestScenario	是	表示定位場景。
command	string	是	擴展命令字符串。

Location

在這里插入圖片描述

位置信息類型。

需要權限：ohos.permission.LOCATION

系統能力：SystemCapability.Location.Location.Core

名稱	參數類型	必填	說明
latitude	number	是	表示緯度信息，正值表示北緯，負值表示南緯。
longitude	number	是	表示經度信息，正值表示東經，負值表是西經。
altitude	number	是	表示高度信息，單位米。
accuracy	number	是	表示精度信息，單位米。
speed	number	是	表示速度信息，單位米每秒。
timeStamp	number	是	表示位置時間戳，UTC格式。
direction	number	是	表示航向信息。
timeSinceBoot	number	是	表示位置時間戳，開機時間格式。
additions	Array	否	附加信息。
additionSize	number	否	附加信息數量。