Skip to content
Snippets Groups Projects
Commit f94a6eb1 authored by Arthur Schiwon's avatar Arthur Schiwon
Browse files

Add missing Avatar Interface

parent 00071401
No related branches found
No related tags found
No related merge requests found
<?php
/**
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OCP;
/**
* This class provides avatar functionality
*/
interface IAvatar {
/**
* @brief get the users avatar
* @param $size integer size in px of the avatar, avatars are square, defaults to 64
* @return boolean|\OC_Image containing the avatar or false if there's no image
*/
function get($size = 64);
/**
* @brief sets the users avatar
* @param $data mixed 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 image is not valid
* @throws \OCP\NotSquareException if the image is not square
* @return void
*/
function set($data);
/**
* @brief remove the users avatar
* @return void
*/
function remove();
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment