nextcloud/lib/public/Location/ILocationAddress.php
Thomas Citharel cbbca98078
feat(location): introduce a public API for location providers
Currently each app does location search & geocoding itself, and it's limited to OpenStreetMap's
public Nominatim service. This will allow people to install other app providers, such as Google
Maps, Pelias, OpenCage, Photon, etc. This will also allow some providers to provide autocomplete
support.

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2023-11-03 09:44:10 +01:00

43 lines
1.3 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023, Thomas Citharel <nextcloud@tcit.fr>.
*
* @author Thomas Citharel <nextcloud@tcit.fr>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP\Location;
/**
* This interface represents a location address
*
* @since 28.0.0
*/
interface ILocationAddress {
public function getCountry(): ?string;
public function getLocality(): ?string;
public function getRegion(): ?string;
public function getDescription(): ?string;
public function getGeometry(): ?string;
public function getPostalCode(): ?string;
public function getStreetName(): ?string;
public function getType(): ?string;
public function getOriginId(): ?string;
public function getTimezone(): ?string;
}