blob: 53cfe76916df4a41c260e3561cb65922f3e8d9a2 (
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?php
/**
* @author Roeland Jago Douma <rullzer@owncloud.com>
*
* @copyright Copyright (c) 2016, ownCloud, Inc.
* @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 OC\Share20;
use OCP\Files\File;
use OCP\Files\Folder;
use OCP\Files\Node;
use OCP\IUser;
use OCP\IGroup;
interface IShare {
/**
* Get the id of the share
*
* @return string
*/
public function getId();
/**
* Set the path of this share
*
* @param Node $path
* @return Share The modified object
*/
public function setPath(Node $path);
/**
* Get the path of this share for the current user
*
* @return File|Folder
*/
public function getPath();
/**
* Set the shareType
*
* @param int $shareType
* @return Share The modified object
*/
public function setShareType($shareType);
/**
* Get the shareType
*
* @return int
*/
public function getShareType();
/**
* Set the receiver of this share
*
* @param IUser|IGroup|string
* @return Share The modified object
*/
public function setSharedWith($sharedWith);
/**
* Get the receiver of this share
*
* @return IUser|IGroup|string
*/
public function getSharedWith();
/**
* Set the permissions
*
* @param int $permissions
* @return Share The modified object
*/
public function setPermissions($permissions);
/**
* Get the share permissions
*
* @return int
*/
public function getPermissions();
/**
* Set the expiration date
*
* @param \DateTime $expireDate
* @return Share The modified object
*/
public function setExpirationDate($expireDate);
/**
* Get the share expiration date
*
* @return \DateTime
*/
public function getExpirationDate();
/**
* Set the sharer of the path
*
* @param IUser|string $sharedBy
* @return Share The modified object
*/
public function setSharedBy($sharedBy);
/**
* Get share sharer
*
* @return IUser|string
*/
public function getSharedBy();
/**
* Set the original share owner (who owns the path)
*
* @param IUser|string
*
* @return Share The modified object
*/
public function setShareOwner($shareOwner);
/**
* Get the original share owner (who owns the path)
*
* @return IUser|string
*/
public function getShareOwner();
/**
* Set the password
*
* @param string $password
*
* @return Share The modified object
*/
public function setPassword($password);
/**
* Is a password set for this share
*
* @return string
*/
public function getPassword();
/**
* Set the token
*
* @param string $token
* @return Share The modified object
*/
public function setToken($token);
/**
* Get the token
*
* @return string
*/
public function getToken();
/**
* Get the parent it
*
* @return int
*/
public function getParent();
/**
* Set the target of this share
*
* @param string $target
* @return Share The modified object
*/
public function setTarget($target);
/**
* Get the target of this share
*
* @return string
*/
public function getTarget();
/**
* Get the timestamp this share was created
*
* @return int
*/
public function getSharetime();
/**
* Get mailSend
*
* @return bool
*/
public function getMailSend();
}
|
