IUserStatus

interface OCP\UserStatus\IUserStatus
Interface IUserStatus
Source:lib/public/UserStatus/IUserStatus.php#36

Constants

ONLINE = online
Source:lib/public/UserStatus/IUserStatus.php#42
Type:string
Since:20.0.0
AWAY = away
Source:lib/public/UserStatus/IUserStatus.php#48
Type:string
Since:20.0.0
DND = dnd
Source:lib/public/UserStatus/IUserStatus.php#54
Type:string
Since:20.0.0
OFFLINE = offline
Source:lib/public/UserStatus/IUserStatus.php#60
Type:string
Since:20.0.0
INVISIBLE = invisible
Source:lib/public/UserStatus/IUserStatus.php#66
Type:string
Since:20.0.0

Methods

public OCP\UserStatus\IUserStatus::getUserId()
Get the user this status is connected to
Source:lib/public/UserStatus/IUserStatus.php#74
Returns:string
Since:20.0.0
public OCP\UserStatus\IUserStatus::getStatus()
Get the status
It will return one of the constants defined above.
It will never return invisible. In case a user marked
themselves as invisible, it will return offline.
Source:lib/public/UserStatus/IUserStatus.php#86
Returns:string See IUserStatus constants
Since:20.0.0
public OCP\UserStatus\IUserStatus::getMessage()
Get a custom message provided by the user
Source:lib/public/UserStatus/IUserStatus.php#94
Returns:string | null
Since:20.0.0
public OCP\UserStatus\IUserStatus::getIcon()
Get a custom icon provided by the user
Source:lib/public/UserStatus/IUserStatus.php#102
Returns:string | null
Since:20.0.0
public OCP\UserStatus\IUserStatus::getClearAt()
Gets the time that the custom status will be cleared at
Source:lib/public/UserStatus/IUserStatus.php#110
Returns:\DateTimeImmutable | null
Since:20.0.0