server/lib/public/OCM/IOCMDiscoveryService.php

49 lines
1.4 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\OCM;
use OCP\OCM\Exceptions\OCMProviderException;
/**
* Discover remote OCM services
*
* @since 28.0.0
*/
interface IOCMDiscoveryService {
/**
* Discover remote OCM services
*
* @param string $remote address of the remote provider
* @param bool $skipCache ignore cache, refresh data
*
* @return IOCMProvider
* @throws OCMProviderException if no valid discovery data can be returned
* @since 28.0.0
*/
public function discover(string $remote, bool $skipCache = false): IOCMProvider;
}