Skip to content
Snippets Groups Projects
Unverified Commit fd4330c3 authored by John Molakvoæ's avatar John Molakvoæ
Browse files
parent 16ec9d96
No related branches found
No related tags found
No related merge requests found
...@@ -37,59 +37,59 @@ use OCP\Files\NotFoundException; ...@@ -37,59 +37,59 @@ use OCP\Files\NotFoundException;
*/ */
interface IAvatar { interface IAvatar {
/** /**
* get the users avatar * get the users avatar
* @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image * @param int $size size in px of the avatar, avatars are square, defaults to 64, -1 can be used to not scale the image
* @return boolean|\OCP\IImage containing the avatar or false if there's no image * @return boolean|\OCP\IImage containing the avatar or false if there's no image
* @since 6.0.0 - size of -1 was added in 9.0.0 * @since 6.0.0 - size of -1 was added in 9.0.0
*/ */
public function get($size = 64); public function get($size = 64);
/** /**
* Check if an avatar exists for the user * Check if an avatar exists for the user
* *
* @return bool * @return bool
* @since 8.1.0 * @since 8.1.0
*/ */
public function exists(); public function exists();
/** /**
* sets the users avatar * sets the users avatar
* @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar * @param \OCP\IImage|resource|string $data An image object, imagedata or path to set a new avatar
* @throws \Exception if the provided file is not a jpg or png image * @throws \Exception if the provided file is not a jpg or png image
* @throws \Exception if the provided image is not valid * @throws \Exception if the provided image is not valid
* @throws \OC\NotSquareException if the image is not square * @throws \OC\NotSquareException if the image is not square
* @return void * @return void
* @since 6.0.0 * @since 6.0.0
*/ */
public function set($data); public function set($data);
/** /**
* remove the users avatar * remove the users avatar
* @return void * @return void
* @since 6.0.0 * @since 6.0.0
*/ */
public function remove(); public function remove();
/** /**
* Get the file of the avatar * Get the file of the avatar
* @param int $size -1 can be used to not scale the image * @param int $size -1 can be used to not scale the image
* @return File * @return File
* @throws NotFoundException * @throws NotFoundException
* @since 9.0.0 * @since 9.0.0
*/ */
public function getFile($size); public function getFile($size);
/** /**
* @param string $text * @param string $text
* @return Color Object containting r g b int in the range [0, 255] * @return Color Object containting r g b int in the range [0, 255]
* @since 14.0.0 * @since 14.0.0
*/ */
public function avatarBackgroundColor(string $text); public function avatarBackgroundColor(string $text);
/** /**
* Handle a changed user * Handle a changed user
* @since 13.0.0 * @since 13.0.0
*/ */
public function userChanged($feature, $oldValue, $newValue); public function userChanged($feature, $oldValue, $newValue);
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment