blob: 9f5258721ab21e66ed46ec6cd77b9cb0d85004ba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<?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();
}
|
