Methods

getUID()

getUID() : string

get the user id

Returns

string

getDisplayName()

getDisplayName() : string

get the display name for the user, if no specific display name is set it will fallback to the user id

Returns

string

setDisplayName()

setDisplayName(string  $displayName) : boolean

set the display name for the user

Parameters

string $displayName

Returns

boolean

getLastLogin()

getLastLogin() : integer

returns the timestamp of the user's last login or 0 if the user did never login

Returns

integer

updateLastLoginTimestamp()

updateLastLoginTimestamp() 

updates the timestamp of the most recent login of this user

delete()

delete() : boolean

Delete the user

Returns

boolean

setPassword()

setPassword(string  $password, string  $recoveryPassword = null) : boolean

Set the password of the user

Parameters

string $password
string $recoveryPassword

for the encryption app to reset encryption keys

Returns

boolean

getHome()

getHome() : string

get the users home folder to mount

Returns

string

getBackendClassName()

getBackendClassName() : string

Get the name of the backend class the user is connected with

Returns

string

canChangeAvatar()

canChangeAvatar() : boolean

check if the backend allows the user to change his avatar on Personal page

Returns

boolean

canChangePassword()

canChangePassword() : boolean

check if the backend supports changing passwords

Returns

boolean

canChangeDisplayName()

canChangeDisplayName() : boolean

check if the backend supports changing display names

Returns

boolean

isEnabled()

isEnabled() : boolean

check if the user is enabled

Returns

boolean

setEnabled()

setEnabled(boolean  $enabled) 

set the enabled status for the user

Parameters

boolean $enabled

getEMailAddress()

getEMailAddress() : string|null

get the users email address

Returns

string|null

getAvatarImage()

getAvatarImage(integer  $size) : \OCP\IImage|null

get the avatar image if it exists

Parameters

integer $size

Returns

\OCP\IImage|null

getCloudId()

getCloudId() : string

get the federation cloud id

Returns

string

setEMailAddress()

setEMailAddress(string|null  $mailAddress) : void

set the email address of the user

Parameters

string|null $mailAddress

getQuota()

getQuota() : string

get the users' quota in human readable form. If a specific quota is not set for the user, the default value is returned. If a default setting was not set otherwise, it is return as 'none', i.e. quota is not limited.

Returns

string

setQuota()

setQuota(string  $quota) : void

set the users' quota

Parameters

string $quota

setSearchTerms()

setSearchTerms(array  $terms) : void

set the users' search terms

Parameters

array $terms

getSearchTerms()

getSearchTerms() : array

get the users' search terms

Returns

array