aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/User/Events/UserLoggedOutEvent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/User/Events/UserLoggedOutEvent.php')
-rw-r--r--lib/public/User/Events/UserLoggedOutEvent.php37
1 files changed, 37 insertions, 0 deletions
diff --git a/lib/public/User/Events/UserLoggedOutEvent.php b/lib/public/User/Events/UserLoggedOutEvent.php
new file mode 100644
index 00000000000..dbdd6d78703
--- /dev/null
+++ b/lib/public/User/Events/UserLoggedOutEvent.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\User\Events;
+
+use OCP\EventDispatcher\Event;
+use OCP\IUser;
+
+/**
+ * Emitted when a user has been logged out successfully.
+ *
+ * @since 18.0.0
+ */
+class UserLoggedOutEvent extends Event {
+ /** @var IUser|null */
+ private $user;
+
+ /**
+ * @since 18.0.0
+ */
+ public function __construct(?IUser $user = null) {
+ parent::__construct();
+ $this->user = $user;
+ }
+
+ /**
+ * @since 18.0.0
+ */
+ public function getUser(): ?IUser {
+ return $this->user;
+ }
+}