IAvailabilityCoordinator
in
Coordinator for availability and out-of-office messages
Tags
Table of Contents
Methods
- clearCache() : void
- Reset the absence cache to null
- getCurrentOutOfOfficeData() : IOutOfOfficeData|null
- Get the user's out-of-office message, if any
- isEnabled() : bool
- Check if the feature is enabled on this instance
- isInEffect() : bool
- Is the absence in effect at this moment
Methods
clearCache()
Reset the absence cache to null
public
clearCache(string $userId) : void
Parameters
- $userId : string
Tags
getCurrentOutOfOfficeData()
Get the user's out-of-office message, if any
public
getCurrentOutOfOfficeData(IUser $user) : IOutOfOfficeData|null
Parameters
- $user : IUser
Tags
Return values
IOutOfOfficeData|nullisEnabled()
Check if the feature is enabled on this instance
public
isEnabled() : bool
Tags
Return values
boolisInEffect()
Is the absence in effect at this moment
public
isInEffect(IOutOfOfficeData $data) : bool
Parameters
- $data : IOutOfOfficeData