Nextcloud PHP API (master)

UserLiveStatusEvent extends Event
in package

Base event class for the event dispatcher service

Tags
since
20.0.0

Table of Contents

Constants

STATUS_AWAY  = 'away'
STATUS_OFFLINE  = 'offline'
STATUS_ONLINE  = 'online'

Properties

$propagationStopped  : bool
$status  : string
$timestamp  : int
$user  : IUser
$userStatus  : IUserStatus|null

Methods

__construct()  : mixed
Compatibility constructor
getStatus()  : string
getTimestamp()  : int
getUser()  : IUser
getUserStatus()  : IUserStatus|null
Get the user status that might be available after processing the event
isPropagationStopped()  : bool
{@inheritDoc}
setUserStatus()  : mixed
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Constants

Properties

$propagationStopped

private bool $propagationStopped = false
Tags
since
22.0.0

Methods

__construct()

Compatibility constructor

public __construct(IUser $user, string $status, int $timestamp) : mixed
Parameters
$user : IUser
$status : string
$timestamp : int
Tags
since
20.0.0

isPropagationStopped()

{@inheritDoc}

public isPropagationStopped() : bool
Tags
since
22.0.0
see
StoppableEventInterface
Return values
bool

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results