123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109 |
- <?php
- /**
- * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
- namespace OCP\Federation;
- use OCP\Http\Client\IResponse;
- use OCP\OCM\Exceptions\OCMProviderException;
- /**
- * Class ICloudFederationProviderManager
- *
- * Manage cloud federation providers
- *
- * @since 14.0.0
- *
- */
- interface ICloudFederationProviderManager {
- /**
- * Registers an callback function which must return an cloud federation provider
- *
- * @param string $resourceType which resource type does the provider handles
- * @param string $displayName user facing name of the federated share provider
- * @param callable $callback
- * @throws Exceptions\ProviderAlreadyExistsException
- *
- * @since 14.0.0
- */
- public function addCloudFederationProvider($resourceType, $displayName, callable $callback);
- /**
- * remove cloud federation provider
- *
- * @param string $resourceType
- *
- * @since 14.0.0
- */
- public function removeCloudFederationProvider($resourceType);
- /**
- * get a list of all cloudFederationProviders
- *
- * @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
- *
- * @since 14.0.0
- */
- public function getAllCloudFederationProviders();
- /**
- * get a specific cloud federation provider
- *
- * @param string $resourceType
- * @return ICloudFederationProvider
- * @throws Exceptions\ProviderDoesNotExistsException
- *
- * @since 14.0.0
- */
- public function getCloudFederationProvider($resourceType);
- /**
- * send federated share
- *
- * @param ICloudFederationShare $share
- * @return mixed
- *
- * @since 14.0.0
- * @deprecated 29.0.0 - Use {@see sendCloudShare()} instead and handle errors manually
- */
- public function sendShare(ICloudFederationShare $share);
- /**
- * @param ICloudFederationShare $share
- * @return IResponse
- * @throws OCMProviderException
- * @since 29.0.0
- */
- public function sendCloudShare(ICloudFederationShare $share): IResponse;
- /**
- * send notification about existing share
- *
- * @param string $url
- * @param ICloudFederationNotification $notification
- * @return array|false
- *
- * @since 14.0.0
- * @deprecated 29.0.0 - Use {@see sendCloudNotification()} instead and handle errors manually
- */
- public function sendNotification($url, ICloudFederationNotification $notification);
- /**
- * @param string $url
- * @param ICloudFederationNotification $notification
- * @return IResponse
- * @throws OCMProviderException
- * @since 29.0.0
- */
- public function sendCloudNotification(string $url, ICloudFederationNotification $notification): IResponse;
- /**
- * check if the new cloud federation API is ready to be used
- *
- * @return bool
- *
- * @since 14.0.0
- */
- public function isReady();
- }
|