blob: 4c11fc20397bf26b5a0c651ce5d2b2e2b0c48a96 (
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
|
<?php
/**
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
*
* @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\Federation;
use OCP\Federation\Exceptions\ShareNotFoundException;
/**
* Interface ICloudFederationProvider
*
* Enable apps to create their own cloud federation provider
*
* @since 14.0.0
*
* @package OCP\Federation
*/
interface ICloudFederationProvider {
/**
* ICloudFederationProvider constructor.
*
* @param $shareType define the share type, handled by this provider
*/
public function __construct($shareType);
/**
* get the name of the share type, handled by this provider
*
* @return string
*/
public function getShareType();
/**
* send new share to another server
*
* @since 14.0.0
*/
public function sendShare();
/**
* share received from another server
*
* @param ICloudFederationShare $share
* @return string provider specific unique ID of the share
*
* @since 14.0.0
*/
public function shareReceived(ICloudFederationShare $share);
/**
* notification received from another server
*
* @param string $id unique ID of a already existing share
* @param array $notification provider specific notification
*
* @throws ShareNotFoundException
*
* @since 14.0.0
*/
public function notificationReceived($id, $notification);
}
|
