summaryrefslogtreecommitdiffstats
path: root/lib/public/share_backend.php
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-04-16 17:00:08 +0200
commit7644950b48b094bfe5675348aefb7cf5747d325b (patch)
treea1792e21239a86f471da99b454134a5d8533ef77 /lib/public/share_backend.php
parent8653da6c16597959c7bd0f0b202747ff96204575 (diff)
downloadnextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.tar.gz
nextcloud-server-7644950b48b094bfe5675348aefb7cf5747d325b.zip
Add @since tags to all methods in public namespace
* enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions
Diffstat (limited to 'lib/public/share_backend.php')
-rw-r--r--lib/public/share_backend.php5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/public/share_backend.php b/lib/public/share_backend.php
index b82f265b383..35ed650b173 100644
--- a/lib/public/share_backend.php
+++ b/lib/public/share_backend.php
@@ -28,6 +28,7 @@ namespace OCP;
/**
* Interface that apps must implement to share content.
+ * @since 5.0.0
*/
interface Share_Backend {
@@ -38,6 +39,7 @@ interface Share_Backend {
* @return boolean|null Source
*
* Return false if the item does not exist for the user
+ * @since 5.0.0
*/
public function isValidSource($itemSource, $uidOwner);
@@ -50,6 +52,7 @@ interface Share_Backend {
*
* This function needs to verify that the user does not already have an item with this name.
* If it does generate a new name e.g. name_#
+ * @since 5.0.0
*/
public function generateTarget($itemSource, $shareWith, $exclude = null);
@@ -73,6 +76,7 @@ interface Share_Backend {
*
* This function allows the backend to control the output of shared items with custom formats.
* It is only called through calls to the public getItem(s)Shared(With) functions.
+ * @since 5.0.0
*/
public function formatItems($items, $format, $parameters = null);
@@ -85,6 +89,7 @@ interface Share_Backend {
* The back-end can enable/disable specific share types. Just return true if
* the back-end doesn't provide any specific settings for it and want to allow
* all share types defined by the share API
+ * @since 8.0.0
*/
public function isShareTypeAllowed($shareType);