blob: f45af4828375dde26ad78f17127a44371ed3cb2b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP;
use OCP\Files\NotFoundException;
use OCP\Files\SimpleFS\ISimpleFile;
/**
* This class provides avatar functionality
* @since 6.0.0
*/
interface IAvatar {
/**
* 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 bool $darkTheme Should the generated avatar be dark themed
* @return false|\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
*/
public function get(int $size = 64, bool $darkTheme = false);
/**
* Check if an avatar exists for the user
*
* @since 8.1.0
*/
public function exists(): bool;
/**
* Check if the avatar of a user is a custom uploaded one
*
* @since 14.0.0
*/
public function isCustomAvatar(): bool;
/**
* Sets the users 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 image is not valid
* @throws \OC\NotSquareException if the image is not square
* @since 6.0.0
*/
public function set($data): void;
/**
* Remove the user's avatar
*
* @param bool $silent Whether removing the avatar should trigger a change
* @since 6.0.0
*/
public function remove(bool $silent = false): void;
/**
* Get the file of the avatar
*
* @param int $size The desired image size. -1 can be used to not scale the image
* @param bool $darkTheme Should the generated avatar be dark themed
* @throws NotFoundException
* @since 9.0.0
*/
public function getFile(int $size, bool $darkTheme = false): ISimpleFile;
/**
* Get the avatar background color
*
* @since 14.0.0
*/
public function avatarBackgroundColor(string $hash): Color;
/**
* Updates the display name if changed.
*
* @param string $feature The changed feature
* @param mixed $oldValue The previous value
* @param mixed $newValue The new value
* @since 13.0.0
*/
public function userChanged(string $feature, $oldValue, $newValue): void;
}
|
