123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264 |
- <?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 OCP\Share;
-
- use OCP\Files\File;
- use OCP\Files\Folder;
- use OCP\Files\Node;
- use OCP\IUser;
- use OCP\IGroup;
-
- /**
- * Interface IShare
- *
- * @package OCP\Share
- * @since 9.0.0
- */
- interface IShare {
-
- /**
- * Get the internal id of the share.
- *
- * @return string
- * @since 9.0.0
- */
- public function getId();
-
- /**
- * Get the full share id. This is the <providerid>:<internalid>.
- * The full id is unique in the system.
- *
- * @return string
- * @since 9.0.0
- */
- public function getFullId();
-
- /**
- * Set the node of the file/folder that is shared
- *
- * @param File|Folder $path
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setNode(Node $path);
-
- /**
- * Get the node of the file/folder that is shared
- *
- * @return File|Folder
- * @since 9.0.0
- */
- public function getNode();
-
- /**
- * Set the shareType
- *
- * @param int $shareType
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setShareType($shareType);
-
- /**
- * Get the shareType
- *
- * @return int
- * @since 9.0.0
- */
- public function getShareType();
-
- /**
- * Set the receiver of this share.
- *
- * @param IUser|IGroup
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setSharedWith($sharedWith);
-
- /**
- * Get the receiver of this share.
- *
- * @return IUser|IGroup
- * @since 9.0.0
- */
- public function getSharedWith();
-
- /**
- * Set the permissions.
- * See \OCP\Constants::PERMISSION_*
- *
- * @param int $permissions
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setPermissions($permissions);
-
- /**
- * Get the share permissions
- * See \OCP\Constants::PERMISSION_*
- *
- * @return int
- * @since 9.0.0
- */
- public function getPermissions();
-
- /**
- * Set the expiration date
- *
- * @param \DateTime $expireDate
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setExpirationDate($expireDate);
-
- /**
- * Get the expiration date
- *
- * @return \DateTime
- * @since 9.0.0
- */
- public function getExpirationDate();
-
- /**
- * Set the sharer of the path.
- *
- * @param IUser $sharedBy
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setSharedBy($sharedBy);
-
- /**
- * Get share sharer
- *
- * @return IUser
- * @since 9.0.0
- */
- public function getSharedBy();
-
- /**
- * Set the original share owner (who owns the path that is shared)
- *
- * @param IUser
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setShareOwner($shareOwner);
-
- /**
- * Get the original share owner (who owns the path that is shared)
- *
- * @return IUser
- * @since 9.0.0
- */
- public function getShareOwner();
-
- /**
- * Set the password for this share.
- * When the share is passed to the share manager to be created
- * or updated the password will be hashed.
- *
- * @param string $password
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setPassword($password);
-
- /**
- * Get the password of this share.
- * If this share is obtained via a shareprovider the password is
- * hashed.
- *
- * @return string
- * @since 9.0.0
- */
- public function getPassword();
-
- /**
- * Set the public link token.
- *
- * @param string $token
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setToken($token);
-
- /**
- * Get the public link token.
- *
- * @return string
- * @since 9.0.0
- */
- public function getToken();
-
- /**
- * Set the target path of this share relative to the recipients user folder.
- *
- * @param string $target
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setTarget($target);
-
- /**
- * Get the target path of this share relative to the recipients user folder.
- *
- * @return string
- * @since 9.0.0
- */
- public function getTarget();
-
- /**
- * Set the time this share was created
- *
- * @param \DateTime $shareTime
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setShareTime(\DateTime $shareTime);
-
- /**
- * Get the timestamp this share was created
- *
- * @return \DateTime
- * @since 9.0.0
- */
- public function getShareTime();
-
- /**
- * Set if the recipient is informed by mail about the share.
- *
- * @param bool $mailSend
- * @return \OCP\Share\IShare The modified object
- * @since 9.0.0
- */
- public function setMailSend($mailSend);
-
- /**
- * Get if the recipient informed by mail about the share.
- *
- * @return bool
- * @since 9.0.0
- */
- public function getMailSend();
- }
|