IUserStatus
in
Interface IUserStatus
Tags
Table of Contents
Constants
- AWAY = 'away'
- BUSY = 'busy'
- DND = 'dnd'
- INVISIBLE = 'invisible'
- MESSAGE_AVAILABILITY = 'availability'
- MESSAGE_CALENDAR_BUSY = 'meeting'
- MESSAGE_CALENDAR_BUSY_TENTATIVE = 'busy-tentative'
- MESSAGE_CALL = 'call'
- MESSAGE_OUT_OF_OFFICE = 'out-of-office'
- MESSAGE_VACATION = 'vacationing'
- OFFLINE = 'offline'
- ONLINE = 'online'
Methods
- getClearAt() : DateTimeImmutable|null
- Gets the time that the custom status will be cleared at
- getIcon() : string|null
- Get a custom icon provided by the user
- getMessage() : string|null
- Get a custom message provided by the user
- getStatus() : string
- Get the status
- getUserId() : string
- Get the user this status is connected to
Constants
AWAY
public
string
AWAY
= 'away'
Tags
BUSY
public
string
BUSY
= 'busy'
Tags
DND
public
string
DND
= 'dnd'
Tags
INVISIBLE
public
string
INVISIBLE
= 'invisible'
Tags
MESSAGE_AVAILABILITY
public
string
MESSAGE_AVAILABILITY
= 'availability'
Tags
MESSAGE_CALENDAR_BUSY
public
string
MESSAGE_CALENDAR_BUSY
= 'meeting'
Tags
MESSAGE_CALENDAR_BUSY_TENTATIVE
public
string
MESSAGE_CALENDAR_BUSY_TENTATIVE
= 'busy-tentative'
Tags
MESSAGE_CALL
public
string
MESSAGE_CALL
= 'call'
Tags
MESSAGE_OUT_OF_OFFICE
public
string
MESSAGE_OUT_OF_OFFICE
= 'out-of-office'
Tags
MESSAGE_VACATION
public
string
MESSAGE_VACATION
= 'vacationing'
Tags
OFFLINE
public
string
OFFLINE
= 'offline'
Tags
ONLINE
public
string
ONLINE
= 'online'
Tags
Methods
getClearAt()
Gets the time that the custom status will be cleared at
public
getClearAt() : DateTimeImmutable|null
Tags
Return values
DateTimeImmutable|nullgetIcon()
Get a custom icon provided by the user
public
getIcon() : string|null
Tags
Return values
string|nullgetMessage()
Get a custom message provided by the user
public
getMessage() : string|null
Tags
Return values
string|nullgetStatus()
Get the status
public
getStatus() : string
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.
Tags
Return values
string —See IUserStatus constants
getUserId()
Get the user this status is connected to
public
getUserId() : string