summaryrefslogtreecommitdiffstats
path: root/lib/public/IAvatarManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/IAvatarManager.php')
-rw-r--r--lib/public/IAvatarManager.php45
1 files changed, 45 insertions, 0 deletions
diff --git a/lib/public/IAvatarManager.php b/lib/public/IAvatarManager.php
new file mode 100644
index 00000000000..ef6b00ffd13
--- /dev/null
+++ b/lib/public/IAvatarManager.php
@@ -0,0 +1,45 @@
+<?php
+/**
+ * @author Arthur Schiwon <blizzz@owncloud.com>
+ * @author Christopher Schäpers <kondou@ts.unde.re>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ * @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;
+
+/**
+ * This class provides avatar functionality
+ * @since 6.0.0
+ */
+
+interface IAvatarManager {
+
+ /**
+ * return a user specific instance of \OCP\IAvatar
+ * @see \OCP\IAvatar
+ * @param string $user the ownCloud user id
+ * @return \OCP\IAvatar
+ * @throws \Exception In case the username is potentially dangerous
+ * @throws \OCP\Files\NotFoundException In case there is no user folder yet
+ * @since 6.0.0
+ */
+ public function getAvatar($user);
+}