mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-27 17:31:12 +00:00
921 lines
30 KiB
TypeScript
921 lines
30 KiB
TypeScript
/*
|
|
* 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.
|
|
*/
|
|
import { AsyncCallback, Callback } from './basic';
|
|
import { WantAgent } from './@ohos.wantAgent';
|
|
|
|
/**
|
|
* Provides interfaces for initiating location requests, ending the location service,
|
|
* and obtaining the location result cached by the system.
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @import import geolocation from '@ohos.geolocation'
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
declare namespace geolocation {
|
|
/**
|
|
* subscribe location changed
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param request Indicates the location request parameters.
|
|
* @param callback Indicates the callback for reporting the location result.
|
|
*/
|
|
function on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>): void;
|
|
|
|
/**
|
|
* unsubscribe location changed
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location result.
|
|
*/
|
|
function off(type: 'locationChange', callback?: Callback<Location>): void;
|
|
|
|
/**
|
|
* subscribe location switch changed
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location result.
|
|
*/
|
|
function on(type: 'locationServiceState', callback: Callback<boolean>): void;
|
|
|
|
/**
|
|
* unsubscribe location switch changed
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location result.
|
|
*/
|
|
function off(type: 'locationServiceState', callback?: Callback<boolean>): void;
|
|
|
|
/**
|
|
* subscribe to cache GNSS locations update messages
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param request Indicates the cached GNSS locations request parameters.
|
|
* @param callback Indicates the callback for reporting the cached GNSS locations.
|
|
*/
|
|
function on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>): void;
|
|
|
|
/**
|
|
* unsubscribe to cache GNSS locations update messages
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the cached gnss locations.
|
|
*/
|
|
function off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>): void;
|
|
|
|
/**
|
|
* subscribe gnss status changed
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the gnss status change.
|
|
*/
|
|
function on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>): void;
|
|
|
|
/**
|
|
* unsubscribe gnss status changed
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the gnss status change.
|
|
*/
|
|
function off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>): void;
|
|
|
|
/**
|
|
* subscribe nmea message changed
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the nmea message.
|
|
*/
|
|
function on(type: 'nmeaMessageChange', callback: Callback<string>): void;
|
|
|
|
/**
|
|
* unsubscribe nmea message changed
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the nmea message.
|
|
*/
|
|
function off(type: 'nmeaMessageChange', callback?: Callback<string>): void;
|
|
|
|
/**
|
|
* add a geofence and subscribe geo fence status changed
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Geofence
|
|
* @permission ohos.permission.LOCATION
|
|
* @param request Indicates the Geo-fence configuration parameters.
|
|
* @param callback Indicates the callback for reporting the fence status.
|
|
*/
|
|
function on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
|
|
|
|
/**
|
|
* remove a geofence and unsubscribe geo fence status changed
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Geofence
|
|
* @permission ohos.permission.LOCATION
|
|
* @param request Indicates the Geo-fence configuration parameters.
|
|
* @param callback Indicates the callback for reporting the remove fence result.
|
|
*/
|
|
function off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent): void;
|
|
|
|
/**
|
|
* registering the callback function for listening to country code changes.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @param callback Indicates the callback for reporting country code changes.
|
|
*/
|
|
function on(type: 'countryCodeChange', callback: Callback<CountryCode>): void;
|
|
|
|
/**
|
|
* unregistering the callback function for listening to country code changes.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @param callback Indicates the callback for reporting country code changes.
|
|
*/
|
|
function off(type: 'countryCodeChange', callback?: Callback<CountryCode>): void;
|
|
|
|
/**
|
|
* obtain current location
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location result.
|
|
*/
|
|
function getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>): void;
|
|
function getCurrentLocation(callback: AsyncCallback<Location>): void;
|
|
function getCurrentLocation(request?: CurrentLocationRequest): Promise<Location>;
|
|
|
|
/**
|
|
* obtain last known location
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location result.
|
|
*/
|
|
function getLastLocation(callback: AsyncCallback<Location>): void;
|
|
function getLastLocation(): Promise<Location>;
|
|
|
|
/**
|
|
* obtain current location switch status
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location switch result.
|
|
*/
|
|
function isLocationEnabled(callback: AsyncCallback<boolean>): void;
|
|
function isLocationEnabled(): Promise<boolean>;
|
|
|
|
/**
|
|
* request enable location
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the location switch status.
|
|
*/
|
|
function requestEnableLocation(callback: AsyncCallback<boolean>): void;
|
|
function requestEnableLocation(): Promise<boolean>;
|
|
|
|
/**
|
|
* enable location switch
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @permission ohos.permission.MANAGE_SECURE_SETTINGS
|
|
* @param callback Indicates the callback for reporting the location switch result.
|
|
*/
|
|
function enableLocation(callback: AsyncCallback<boolean>): void;
|
|
function enableLocation(): Promise<boolean>;
|
|
|
|
/**
|
|
* disable location switch
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @permission ohos.permission.MANAGE_SECURE_SETTINGS
|
|
* @param callback Indicates the callback for reporting the location switch result.
|
|
*/
|
|
function disableLocation(callback: AsyncCallback<boolean>): void;
|
|
function disableLocation(): Promise<boolean>;
|
|
|
|
/**
|
|
* obtain address info from location
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Geocoder
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the address info.
|
|
*/
|
|
function getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;
|
|
function getAddressesFromLocation(request: ReverseGeoCodeRequest): Promise<Array<GeoAddress>>;
|
|
|
|
/**
|
|
* obtain latitude and longitude info from location address
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Geocoder
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the latitude and longitude result.
|
|
*/
|
|
function getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>): void;
|
|
function getAddressesFromLocationName(request: GeoCodeRequest): Promise<Array<GeoAddress>>;
|
|
|
|
/**
|
|
* obtain geocode service status
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Geocoder
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the geocode service status.
|
|
*/
|
|
function isGeoServiceAvailable(callback: AsyncCallback<boolean>): void;
|
|
function isGeoServiceAvailable(): Promise<boolean>;
|
|
|
|
/**
|
|
* obtain the number of cached GNSS locations reported at a time
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the cached GNSS locations size.
|
|
*/
|
|
function getCachedGnssLocationsSize(callback: AsyncCallback<number>): void;
|
|
function getCachedGnssLocationsSize(): Promise<number>;
|
|
|
|
/**
|
|
* all prepared GNSS locations are returned to the application through the callback function,
|
|
* and the bottom-layer buffer is cleared.
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
* @param callback Indicates the callback for reporting the result.
|
|
*/
|
|
function flushCachedGnssLocations(callback: AsyncCallback<boolean>): void;
|
|
function flushCachedGnssLocations(): Promise<boolean>;
|
|
|
|
/**
|
|
* send extended commands to location subsystem.
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param command Indicates the extended Command Message Body.
|
|
* @param callback Indicates the callback for reporting the send command result.
|
|
*/
|
|
function sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>): void;
|
|
function sendCommand(command: LocationCommand): Promise<boolean>;
|
|
|
|
/**
|
|
* obtain the current country code.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @param callback Indicates the callback for reporting the country code.
|
|
*/
|
|
function getCountryCode(callback: AsyncCallback<CountryCode>): void;
|
|
function getCountryCode(): Promise<CountryCode>;
|
|
|
|
/**
|
|
* enable the geographical location simulation function.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @param scenario Indicates the scenarios where location simulation is required.
|
|
* @param callback Indicates a callback function, which is used to report the result
|
|
* of enabling the location simulation function. If the enabling fails, the error message will
|
|
* be carried in the first parameter err of AsyncCallback, If enabling succeeds, no data will be returned.
|
|
*/
|
|
function enableLocationMock(scenario: LocationRequestScenario, callback: AsyncCallback<void>): void;
|
|
function enableLocationMock(callback: AsyncCallback<void>): void;
|
|
function enableLocationMock(scenario: LocationRequestScenario): Promise<void>;
|
|
function enableLocationMock(): Promise<void>;
|
|
|
|
/**
|
|
* disable the geographical location simulation function.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @param scenario Indicates the scenarios where location simulation is required.
|
|
* @param callback Indicates a callback function, which is used to report the result
|
|
* of disabling the location simulation function. If the disabling fails, the error message will
|
|
* be carried in the first parameter err of AsyncCallback, If disabling succeeds, no data will be returned.
|
|
*/
|
|
function disableLocationMock(scenario: LocationRequestScenario, callback: AsyncCallback<void>): void;
|
|
function disableLocationMock(callback: AsyncCallback<void>): void;
|
|
function disableLocationMock(scenario: LocationRequestScenario): Promise<void>;
|
|
function disableLocationMock(): Promise<void>;
|
|
|
|
/**
|
|
* set the configuration parameters for location simulation.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @param config Indicates the configuration parameters for location simulation.
|
|
* @param callback Indicates a callback function, which is used to report the result of setting
|
|
* the simulation locations. If the setting fails, the error message will be carried in the first
|
|
* parameter err of AsyncCallback. If the setting succeeds, no data will be returned.
|
|
*/
|
|
function setMockedLocations(config: LocationMockConfig, callback: AsyncCallback<void>): void;
|
|
function setMockedLocations(config: LocationMockConfig): Promise<void>;
|
|
|
|
/**
|
|
* enable the reverse geocoding simulation function.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @param callback Indicates a callback function, which is used to report the result
|
|
* of enabling the reverse geocode simulation function. If the enabling fails, the error message will
|
|
* be carried in the first parameter err of AsyncCallback, If enabling succeeds, no data will be returned.
|
|
*/
|
|
function enableReverseGeocodingMock(callback: AsyncCallback<void>): void;
|
|
function enableReverseGeocodingMock(): Promise<void>;
|
|
|
|
/**
|
|
* disable the reverse geocoding simulation function.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @param callback Indicates a callback function, which is used to report the result
|
|
* of disabling the reverse geocode simulation function. If the disabling fails, the error message will
|
|
* be carried in the first parameter err of AsyncCallback, If disabling succeeds, no data will be returned.
|
|
*/
|
|
function disableReverseGeocodingMock(callback: AsyncCallback<void>): void;
|
|
function disableReverseGeocodingMock(): Promise<void>;
|
|
|
|
/**
|
|
* set the configuration parameters for simulating reverse geocoding.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
* @param mockInfos Indicates the set of locations and place names to be simulated.
|
|
* @param callback Indicates a callback function, which is used to report the result of setting
|
|
* the configuration parameters for simulating reverse geocoding. If the setting fails,
|
|
* the error message will be carried in the first parameter err of AsyncCallback.
|
|
* If the setting succeeds, no data will be returned.
|
|
*/
|
|
function setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>, callback: AsyncCallback<void>): void;
|
|
function setReverseGeocodingMockInfo(mockInfos: Array<ReverseGeocodingMockInfo>): Promise<void>;
|
|
|
|
/**
|
|
* configuration parameters for simulating reverse geocoding.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
*/
|
|
export interface ReverseGeocodingMockInfo {
|
|
location: ReverseGeoCodeRequest;
|
|
geoAddress: GeoAddress;
|
|
}
|
|
|
|
/**
|
|
* parameters for configuring the location simulation function.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @systemapi
|
|
*/
|
|
export interface LocationMockConfig {
|
|
timeInterval: number;
|
|
locations: Array<Location>;
|
|
}
|
|
|
|
/**
|
|
* satellite status information
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface SatelliteStatusInfo {
|
|
satellitesNumber: number;
|
|
satelliteIds: Array<number>;
|
|
carrierToNoiseDensitys: Array<number>;
|
|
altitudes: Array<number>;
|
|
azimuths: Array<number>;
|
|
carrierFrequencies: Array<number>;
|
|
}
|
|
|
|
/**
|
|
* parameters for requesting to report cache location information
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Gnss
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface CachedGnssLocationsRequest {
|
|
reportingPeriodSec: number;
|
|
wakeUpCacheQueueFull: boolean;
|
|
}
|
|
|
|
/**
|
|
* configuring parameters in geo fence requests
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Geofence
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface GeofenceRequest {
|
|
priority: LocationRequestPriority;
|
|
scenario: LocationRequestScenario;
|
|
geofence: Geofence;
|
|
}
|
|
|
|
/**
|
|
* configuring parameters in geo fence requests
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Geofence
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface Geofence {
|
|
latitude: number;
|
|
longitude: number;
|
|
radius: number;
|
|
expiration: number;
|
|
}
|
|
|
|
/**
|
|
* querying location privacy protocol confirmation status.
|
|
*
|
|
* @since 8
|
|
* @systemapi
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param type indicates location privacy protocol type.
|
|
* @param callback indicates the callback for reporting the location privacy protocol confirmation status.
|
|
*/
|
|
function isLocationPrivacyConfirmed(type: LocationPrivacyType, callback: AsyncCallback<boolean>): void;
|
|
function isLocationPrivacyConfirmed(type: LocationPrivacyType,): Promise<boolean>;
|
|
|
|
/**
|
|
* set location privacy protocol confirmation status.
|
|
*
|
|
* @since 8
|
|
* @systemapi
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
* @param type indicates location privacy protocol type.
|
|
* @param isConfirmed indicates whether the location privacy protocol has been confirmed.
|
|
* @param callback Indicates the callback for reporting whether the action is set successfully.
|
|
*/
|
|
function setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback<boolean>): void;
|
|
function setLocationPrivacyConfirmStatus(type: LocationPrivacyType, isConfirmed: boolean): Promise<boolean>;
|
|
|
|
/**
|
|
* configuring parameters in reverse geocode requests
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Geocoder
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface ReverseGeoCodeRequest {
|
|
locale?: string;
|
|
latitude: number;
|
|
longitude: number;
|
|
maxItems?: number;
|
|
}
|
|
|
|
/**
|
|
* configuring parameters in geocode requests
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Geocoder
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface GeoCodeRequest {
|
|
locale?: string;
|
|
description: string;
|
|
maxItems?: number;
|
|
minLatitude?: number;
|
|
minLongitude?: number;
|
|
maxLatitude?: number;
|
|
maxLongitude?: number;
|
|
}
|
|
|
|
/**
|
|
* data struct describes geographic locations.
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Geocoder
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface GeoAddress {
|
|
/**
|
|
* Indicates latitude information.
|
|
* A positive value indicates north latitude,
|
|
* and a negative value indicates south latitude.
|
|
* @since 7
|
|
*/
|
|
latitude?: number;
|
|
|
|
/**
|
|
* Indicates longitude information.
|
|
* A positive value indicates east longitude ,
|
|
* and a negative value indicates west longitude .
|
|
* @since 7
|
|
*/
|
|
longitude?: number;
|
|
|
|
/**
|
|
* Indicates language used for the location description.
|
|
* zh indicates Chinese, and en indicates English.
|
|
* @since 7
|
|
*/
|
|
locale?: string;
|
|
|
|
/**
|
|
* Indicates landmark of the location.
|
|
* @since 7
|
|
*/
|
|
placeName?: string;
|
|
|
|
/**
|
|
* Indicates country code.
|
|
* @since 7
|
|
*/
|
|
countryCode?: string;
|
|
|
|
/**
|
|
* Indicates country name.
|
|
* @since 7
|
|
*/
|
|
countryName?: string;
|
|
|
|
/**
|
|
* Indicates administrative region name.
|
|
* @since 7
|
|
*/
|
|
administrativeArea?: string;
|
|
|
|
/**
|
|
* Indicates sub-administrative region name.
|
|
* @since 7
|
|
*/
|
|
subAdministrativeArea?: string;
|
|
|
|
/**
|
|
* Indicates locality information.
|
|
* @since 7
|
|
*/
|
|
locality?: string;
|
|
|
|
/**
|
|
* Indicates sub-locality information.
|
|
* @since 7
|
|
*/
|
|
subLocality?: string;
|
|
|
|
/**
|
|
* Indicates road name.
|
|
* @since 7
|
|
*/
|
|
roadName?: string;
|
|
|
|
/**
|
|
* Indicates auxiliary road information.
|
|
* @since 7
|
|
*/
|
|
subRoadName?: string;
|
|
|
|
/**
|
|
* Indicates house information.
|
|
* @since 7
|
|
*/
|
|
premises?: string;
|
|
|
|
/**
|
|
* Indicates postal code.
|
|
* @since 7
|
|
*/
|
|
postalCode?: string;
|
|
|
|
/**
|
|
* Indicates phone number.
|
|
* @since 7
|
|
*/
|
|
phoneNumber?: string;
|
|
|
|
/**
|
|
* Indicates website URL.
|
|
* @since 7
|
|
*/
|
|
addressUrl?: string;
|
|
|
|
/**
|
|
* Indicates additional information.
|
|
* @since 7
|
|
*/
|
|
descriptions?: Array<string>;
|
|
|
|
/**
|
|
* Indicates the amount of additional descriptive information.
|
|
* @since 7
|
|
*/
|
|
descriptionsSize?: number;
|
|
|
|
/**
|
|
* Indicates whether it is an mock GeoAddress
|
|
* @since 9
|
|
*/
|
|
isFromMock?: Boolean;
|
|
}
|
|
|
|
/**
|
|
* configuring parameters in location requests
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface LocationRequest {
|
|
priority?: LocationRequestPriority;
|
|
scenario?: LocationRequestScenario;
|
|
timeInterval?: number;
|
|
distanceInterval?: number;
|
|
maxAccuracy?: number;
|
|
}
|
|
|
|
/**
|
|
* configuring parameters in current location requests
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface CurrentLocationRequest {
|
|
priority?: LocationRequestPriority;
|
|
scenario?: LocationRequestScenario;
|
|
maxAccuracy?: number;
|
|
timeoutMs?: number;
|
|
}
|
|
|
|
/**
|
|
* provides information about geographic locations
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface Location {
|
|
/**
|
|
* Indicates latitude information.
|
|
* A positive value indicates north latitude,
|
|
* and a negative value indicates south latitude.
|
|
* @since 7
|
|
*/
|
|
latitude: number;
|
|
|
|
/**
|
|
* Indicates Longitude information.
|
|
* A positive value indicates east longitude ,
|
|
* and a negative value indicates west longitude .
|
|
* @since 7
|
|
*/
|
|
longitude: number;
|
|
|
|
/**
|
|
* Indicates location altitude, in meters.
|
|
* @since 7
|
|
*/
|
|
altitude: number;
|
|
|
|
/**
|
|
* Indicates location accuracy, in meters.
|
|
* @since 7
|
|
*/
|
|
accuracy: number;
|
|
|
|
/**
|
|
* Indicates speed, in m/s.
|
|
* @since 7
|
|
*/
|
|
speed: number;
|
|
|
|
/**
|
|
* Indicates location timestamp in the UTC format.
|
|
* @since 7
|
|
*/
|
|
timeStamp: number;
|
|
|
|
/**
|
|
* Indicates direction information.
|
|
* @since 7
|
|
*/
|
|
direction: number;
|
|
|
|
/**
|
|
* Indicates location timestamp since boot.
|
|
* @since 7
|
|
*/
|
|
timeSinceBoot: number;
|
|
|
|
/**
|
|
* Indicates additional information.
|
|
* @since 7
|
|
*/
|
|
additions?: Array<string>;
|
|
|
|
/**
|
|
* Indicates the amount of additional descriptive information.
|
|
* @since 7
|
|
*/
|
|
additionSize?: number;
|
|
|
|
/**
|
|
* Indicates whether it is an mock location.
|
|
* @since 9
|
|
*/
|
|
isFromMock?: Boolean;
|
|
}
|
|
|
|
/**
|
|
* enum for location priority
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export enum LocationRequestPriority {
|
|
UNSET = 0x200,
|
|
ACCURACY,
|
|
LOW_POWER,
|
|
FIRST_FIX,
|
|
}
|
|
|
|
/**
|
|
* enum for location scenario
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export enum LocationRequestScenario {
|
|
UNSET = 0x300,
|
|
NAVIGATION,
|
|
TRAJECTORY_TRACKING,
|
|
CAR_HAILING,
|
|
DAILY_LIFE_SERVICE,
|
|
NO_POWER,
|
|
}
|
|
|
|
/**
|
|
* enum for error code
|
|
*
|
|
* @since 7
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export enum GeoLocationErrorCode {
|
|
/**
|
|
* Indicates function not supported.
|
|
* @since 9
|
|
*/
|
|
NOT_SUPPORTED = 100,
|
|
|
|
/**
|
|
* Indicates input parameter error.
|
|
* @since 7
|
|
*/
|
|
INPUT_PARAMS_ERROR,
|
|
|
|
/**
|
|
* Indicates reverse geocode query failed.
|
|
* @since 7
|
|
*/
|
|
REVERSE_GEOCODE_ERROR,
|
|
|
|
/**
|
|
* Indicates geocode query failed.
|
|
* @since 7
|
|
*/
|
|
GEOCODE_ERROR,
|
|
|
|
/**
|
|
* Indicates positioning failed.
|
|
* @since 7
|
|
*/
|
|
LOCATOR_ERROR,
|
|
|
|
/**
|
|
* Indicates operation failure caused by abnormal location switch.
|
|
* @since 7
|
|
*/
|
|
LOCATION_SWITCH_ERROR,
|
|
|
|
/**
|
|
* Indicates failed to get the last known location.
|
|
* @since 7
|
|
*/
|
|
LAST_KNOWN_LOCATION_ERROR,
|
|
|
|
/**
|
|
* Indicates location request timeout.
|
|
* @since 7
|
|
*/
|
|
LOCATION_REQUEST_TIMEOUT_ERROR,
|
|
|
|
/**
|
|
* Indicates country code query failed.
|
|
* @since 9
|
|
*/
|
|
QUERY_COUNTRY_CODE_ERROR,
|
|
}
|
|
|
|
/**
|
|
* enum for location privacy type
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export enum LocationPrivacyType {
|
|
OTHERS = 0,
|
|
STARTUP,
|
|
CORE_LOCATION,
|
|
}
|
|
|
|
/**
|
|
* Location subsystem command structure
|
|
*
|
|
* @since 8
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
* @permission ohos.permission.LOCATION
|
|
*/
|
|
export interface LocationCommand {
|
|
scenario: LocationRequestScenario;
|
|
command: string;
|
|
}
|
|
|
|
/**
|
|
* country code structure
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
*/
|
|
export interface CountryCode {
|
|
country: string;
|
|
type: CountryCodeType;
|
|
}
|
|
|
|
/**
|
|
* enum for country code type
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Location.Location.Core
|
|
*/
|
|
export enum CountryCodeType {
|
|
COUNTRY_CODE_FROM_LOCALE = 1,
|
|
COUNTRY_CODE_FROM_SIM,
|
|
COUNTRY_CODE_FROM_LOCATION,
|
|
COUNTRY_CODE_FROM_NETWORK,
|
|
}
|
|
}
|
|
|
|
export default geolocation;
|