mirror of
https://github.com/nextcloud/server.git
synced 2024-11-14 12:26:49 +00:00
637 lines
12 KiB
PHP
637 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
namespace OCP\Share;
|
|
|
|
use OCP\Files\Cache\ICacheEntry;
|
|
use OCP\Files\File;
|
|
use OCP\Files\Folder;
|
|
use OCP\Files\Node;
|
|
use OCP\Files\NotFoundException;
|
|
use OCP\Share\Exceptions\IllegalIDChangeException;
|
|
|
|
/**
|
|
* This interface allows to represent a share object.
|
|
*
|
|
* This interface must not be implemented in your application.
|
|
*
|
|
* @since 9.0.0
|
|
*/
|
|
interface IShare {
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_USER = 0;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_GROUP = 1;
|
|
|
|
/**
|
|
* @internal
|
|
* @since 18.0.0
|
|
*/
|
|
public const TYPE_USERGROUP = 2;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_LINK = 3;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_EMAIL = 4;
|
|
|
|
/**
|
|
* ToDo Check if it is still in use otherwise remove it
|
|
* @since 17.0.0
|
|
*/
|
|
// public const TYPE_CONTACT = 5;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_REMOTE = 6;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_CIRCLE = 7;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_GUEST = 8;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_REMOTE_GROUP = 9;
|
|
|
|
/**
|
|
* @since 17.0.0
|
|
*/
|
|
public const TYPE_ROOM = 10;
|
|
|
|
/**
|
|
* Internal type used by RoomShareProvider
|
|
* @since 17.0.0
|
|
*/
|
|
// const TYPE_USERROOM = 11;
|
|
|
|
/**
|
|
* @since 21.0.0
|
|
*/
|
|
public const TYPE_DECK = 12;
|
|
|
|
/**
|
|
* @internal
|
|
* @since 21.0.0
|
|
*/
|
|
public const TYPE_DECK_USER = 13;
|
|
|
|
/**
|
|
* @since 26.0.0
|
|
*/
|
|
public const TYPE_SCIENCEMESH = 15;
|
|
|
|
/**
|
|
* @since 18.0.0
|
|
*/
|
|
public const STATUS_PENDING = 0;
|
|
|
|
/**
|
|
* @since 18.0.0
|
|
*/
|
|
public const STATUS_ACCEPTED = 1;
|
|
|
|
/**
|
|
* @since 18.0.0
|
|
*/
|
|
public const STATUS_REJECTED = 2;
|
|
|
|
/**
|
|
* Set the internal id of the share
|
|
* It is only allowed to set the internal id of a share once.
|
|
* Attempts to override the internal id will result in an IllegalIDChangeException
|
|
*
|
|
* @param string $id
|
|
* @return \OCP\Share\IShare
|
|
* @throws IllegalIDChangeException
|
|
* @throws \InvalidArgumentException
|
|
* @since 9.1.0
|
|
*/
|
|
public function setId($id);
|
|
|
|
/**
|
|
* 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
|
|
* @throws \UnexpectedValueException If the fullId could not be constructed
|
|
*/
|
|
public function getFullId();
|
|
|
|
/**
|
|
* Set the provider id of the share
|
|
* It is only allowed to set the provider id of a share once.
|
|
* Attempts to override the provider id will result in an IllegalIDChangeException
|
|
*
|
|
* @param string $id
|
|
* @return \OCP\Share\IShare
|
|
* @throws IllegalIDChangeException
|
|
* @throws \InvalidArgumentException
|
|
* @since 9.1.0
|
|
*/
|
|
public function setProviderId($id);
|
|
|
|
/**
|
|
* Set the node of the file/folder that is shared
|
|
*
|
|
* @param Node $node
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 9.0.0
|
|
*/
|
|
public function setNode(Node $node);
|
|
|
|
/**
|
|
* Get the node of the file/folder that is shared
|
|
*
|
|
* @return File|Folder
|
|
* @since 9.0.0
|
|
* @throws NotFoundException
|
|
*/
|
|
public function getNode();
|
|
|
|
/**
|
|
* Set file id for lazy evaluation of the node
|
|
* @param int $fileId
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 9.0.0
|
|
*/
|
|
public function setNodeId($fileId);
|
|
|
|
/**
|
|
* Get the fileid of the node of this share
|
|
* @return int
|
|
* @since 9.0.0
|
|
* @throws NotFoundException
|
|
*/
|
|
public function getNodeId(): int;
|
|
|
|
/**
|
|
* Set the type of node (file/folder)
|
|
*
|
|
* @param string $type
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 9.0.0
|
|
*/
|
|
public function setNodeType($type);
|
|
|
|
/**
|
|
* Get the type of node (file/folder)
|
|
*
|
|
* @return string
|
|
* @since 9.0.0
|
|
* @throws NotFoundException
|
|
*/
|
|
public function getNodeType();
|
|
|
|
/**
|
|
* 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 string $sharedWith
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 9.0.0
|
|
*/
|
|
public function setSharedWith($sharedWith);
|
|
|
|
/**
|
|
* Get the receiver of this share.
|
|
*
|
|
* @return string
|
|
* @since 9.0.0
|
|
*/
|
|
public function getSharedWith();
|
|
|
|
/**
|
|
* Set the display name of the receiver of this share.
|
|
*
|
|
* @param string $displayName
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 14.0.0
|
|
*/
|
|
public function setSharedWithDisplayName($displayName);
|
|
|
|
/**
|
|
* Get the display name of the receiver of this share.
|
|
*
|
|
* @return string
|
|
* @since 14.0.0
|
|
*/
|
|
public function getSharedWithDisplayName();
|
|
|
|
/**
|
|
* Set the avatar of the receiver of this share.
|
|
*
|
|
* @param string $src
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 14.0.0
|
|
*/
|
|
public function setSharedWithAvatar($src);
|
|
|
|
/**
|
|
* Get the avatar of the receiver of this share.
|
|
*
|
|
* @return string
|
|
* @since 14.0.0
|
|
*/
|
|
public function getSharedWithAvatar();
|
|
|
|
/**
|
|
* Set the permissions.
|
|
* See \OCP\Constants::PERMISSION_*
|
|
*
|
|
* @param int $permissions
|
|
* @return 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();
|
|
|
|
/**
|
|
* Create share attributes object
|
|
*
|
|
* @since 25.0.0
|
|
* @return IAttributes
|
|
*/
|
|
public function newAttributes(): IAttributes;
|
|
|
|
/**
|
|
* Set share attributes
|
|
*
|
|
* @param ?IAttributes $attributes
|
|
* @since 25.0.0
|
|
* @return IShare The modified object
|
|
*/
|
|
public function setAttributes(?IAttributes $attributes);
|
|
|
|
/**
|
|
* Get share attributes
|
|
*
|
|
* @since 25.0.0
|
|
* @return ?IAttributes
|
|
*/
|
|
public function getAttributes(): ?IAttributes;
|
|
|
|
/**
|
|
* Set the accepted status
|
|
* See self::STATUS_*
|
|
*
|
|
* @param int $status
|
|
* @return IShare The modified object
|
|
* @since 18.0.0
|
|
*/
|
|
public function setStatus(int $status): IShare;
|
|
|
|
/**
|
|
* Get the accepted status
|
|
* See self::STATUS_*
|
|
*
|
|
* @return int
|
|
* @since 18.0.0
|
|
*/
|
|
public function getStatus(): int;
|
|
|
|
/**
|
|
* Attach a note to a share
|
|
*
|
|
* @param string $note
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 14.0.0
|
|
*/
|
|
public function setNote($note);
|
|
|
|
/**
|
|
* Get note attached to a share
|
|
*
|
|
* @return string
|
|
* @since 14.0.0
|
|
*/
|
|
public function getNote();
|
|
|
|
|
|
/**
|
|
* Set the expiration date
|
|
*
|
|
* @param \DateTime|null $expireDate
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 9.0.0
|
|
*/
|
|
public function setExpirationDate(?\DateTime $expireDate);
|
|
|
|
/**
|
|
* Get the expiration date
|
|
*
|
|
* @return \DateTime|null
|
|
* @since 9.0.0
|
|
*/
|
|
public function getExpirationDate();
|
|
|
|
/**
|
|
* Set overwrite flag for falsy expiry date vavlues
|
|
*
|
|
* @param bool $noExpirationDate
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 30.0.0
|
|
*/
|
|
public function setNoExpirationDate(bool $noExpirationDate);
|
|
|
|
|
|
/**
|
|
* Get value of overwrite falsy expiry date flag
|
|
*
|
|
* @return bool
|
|
* @since 30.0.0
|
|
*/
|
|
public function getNoExpirationDate();
|
|
|
|
/**
|
|
* Is the share expired ?
|
|
*
|
|
* @return boolean
|
|
* @since 18.0.0
|
|
*/
|
|
public function isExpired();
|
|
|
|
/**
|
|
* set a label for a share, some shares, e.g. public links can have a label
|
|
*
|
|
* @param string $label
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 15.0.0
|
|
*/
|
|
public function setLabel($label);
|
|
|
|
/**
|
|
* get label for the share, some shares, e.g. public links can have a label
|
|
*
|
|
* @return string
|
|
* @since 15.0.0
|
|
*/
|
|
public function getLabel();
|
|
|
|
/**
|
|
* Set the sharer of the path.
|
|
*
|
|
* @param string $sharedBy
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 9.0.0
|
|
*/
|
|
public function setSharedBy($sharedBy);
|
|
|
|
/**
|
|
* Get share sharer
|
|
*
|
|
* @return string
|
|
* @since 9.0.0
|
|
*/
|
|
public function getSharedBy();
|
|
|
|
/**
|
|
* Set the original share owner (who owns the path that is shared)
|
|
*
|
|
* @param string $shareOwner
|
|
* @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 string
|
|
* @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|null $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|null
|
|
* @since 9.0.0
|
|
*/
|
|
public function getPassword();
|
|
|
|
/**
|
|
* Set the password's expiration time of this share.
|
|
*
|
|
* @return self The modified object
|
|
* @since 24.0.0
|
|
*/
|
|
public function setPasswordExpirationTime(?\DateTimeInterface $passwordExpirationTime = null): IShare;
|
|
|
|
/**
|
|
* Get the password's expiration time of this share.
|
|
* @since 24.0.0
|
|
*/
|
|
public function getPasswordExpirationTime(): ?\DateTimeInterface;
|
|
|
|
/**
|
|
* Set if the recipient can start a conversation with the owner to get the
|
|
* password using Nextcloud Talk.
|
|
*
|
|
* @param bool $sendPasswordByTalk
|
|
* @return \OCP\Share\IShare The modified object
|
|
* @since 14.0.0
|
|
*/
|
|
public function setSendPasswordByTalk(bool $sendPasswordByTalk);
|
|
|
|
/**
|
|
* Get if the recipient can start a conversation with the owner to get the
|
|
* password using Nextcloud Talk.
|
|
* The returned value does not take into account other factors, like Talk
|
|
* being enabled for the owner of the share or not; it just cover whether
|
|
* the option is enabled for the share itself or not.
|
|
*
|
|
* @return bool
|
|
* @since 14.0.0
|
|
*/
|
|
public function getSendPasswordByTalk(): bool;
|
|
|
|
/**
|
|
* 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 should be 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 should be informed by mail about the share.
|
|
*
|
|
* @return bool
|
|
* @since 9.0.0
|
|
*/
|
|
public function getMailSend();
|
|
|
|
/**
|
|
* Set the cache entry for the shared node
|
|
*
|
|
* @param ICacheEntry $entry
|
|
* @return void
|
|
* @since 11.0.0
|
|
*/
|
|
public function setNodeCacheEntry(ICacheEntry $entry);
|
|
|
|
/**
|
|
* Get the cache entry for the shared node
|
|
*
|
|
* @return null|ICacheEntry
|
|
* @since 11.0.0
|
|
*/
|
|
public function getNodeCacheEntry();
|
|
|
|
/**
|
|
* Sets a shares hide download state
|
|
* This is mainly for public shares. It will signal that the share page should
|
|
* hide download buttons etc.
|
|
*
|
|
* @param bool $hide
|
|
* @return IShare
|
|
* @since 15.0.0
|
|
*/
|
|
public function setHideDownload(bool $hide): IShare;
|
|
|
|
/**
|
|
* Gets a shares hide download state
|
|
* This is mainly for public shares. It will signal that the share page should
|
|
* hide download buttons etc.
|
|
*
|
|
* @return bool
|
|
* @since 15.0.0
|
|
*/
|
|
public function getHideDownload(): bool;
|
|
|
|
/**
|
|
* Sets a flag that stores whether a reminder via email has been sent
|
|
*
|
|
* @return self The modified object
|
|
* @since 31.0.0
|
|
*/
|
|
public function setReminderSent(bool $reminderSent): IShare;
|
|
|
|
/**
|
|
* Gets a flag that stores whether a reminder via email has been sent
|
|
*
|
|
* @return bool
|
|
* @since 31.0.0
|
|
*/
|
|
public function getReminderSent(): bool;
|
|
}
|