diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php index 94addec59c..388c7906eb 100644 --- a/lib/composer/composer/autoload_classmap.php +++ b/lib/composer/composer/autoload_classmap.php @@ -147,6 +147,7 @@ return array( 'OCP\\Contacts\\ContactsMenu\\IEntry' => $baseDir . '/lib/public/Contacts/ContactsMenu/IEntry.php', 'OCP\\Contacts\\ContactsMenu\\ILinkAction' => $baseDir . '/lib/public/Contacts/ContactsMenu/ILinkAction.php', 'OCP\\Contacts\\ContactsMenu\\IProvider' => $baseDir . '/lib/public/Contacts/ContactsMenu/IProvider.php', + 'OCP\\Contacts\\Events\\ContactInteractedWithEvent' => $baseDir . '/lib/public/Contacts/Events/ContactInteractedWithEvent.php', 'OCP\\Contacts\\IManager' => $baseDir . '/lib/public/Contacts/IManager.php', 'OCP\\DB\\ISchemaWrapper' => $baseDir . '/lib/public/DB/ISchemaWrapper.php', 'OCP\\DB\\QueryBuilder\\ICompositeExpression' => $baseDir . '/lib/public/DB/QueryBuilder/ICompositeExpression.php', diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php index d8f68ccd5e..cfc6d9842d 100644 --- a/lib/composer/composer/autoload_static.php +++ b/lib/composer/composer/autoload_static.php @@ -176,6 +176,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c 'OCP\\Contacts\\ContactsMenu\\IEntry' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IEntry.php', 'OCP\\Contacts\\ContactsMenu\\ILinkAction' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/ILinkAction.php', 'OCP\\Contacts\\ContactsMenu\\IProvider' => __DIR__ . '/../../..' . '/lib/public/Contacts/ContactsMenu/IProvider.php', + 'OCP\\Contacts\\Events\\ContactInteractedWithEvent' => __DIR__ . '/../../..' . '/lib/public/Contacts/Events/ContactInteractedWithEvent.php', 'OCP\\Contacts\\IManager' => __DIR__ . '/../../..' . '/lib/public/Contacts/IManager.php', 'OCP\\DB\\ISchemaWrapper' => __DIR__ . '/../../..' . '/lib/public/DB/ISchemaWrapper.php', 'OCP\\DB\\QueryBuilder\\ICompositeExpression' => __DIR__ . '/../../..' . '/lib/public/DB/QueryBuilder/ICompositeExpression.php', diff --git a/lib/public/Contacts/Events/ContactInteractedWithEvent.php b/lib/public/Contacts/Events/ContactInteractedWithEvent.php new file mode 100644 index 0000000000..a21e17124c --- /dev/null +++ b/lib/public/Contacts/Events/ContactInteractedWithEvent.php @@ -0,0 +1,136 @@ + + * + * @author 2020 Christoph Wurst + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +namespace OCP\Contacts\Events; + +use OCP\EventDispatcher\Event; +use OCP\IUser; + +/** + * An event that allows apps to notify other components about an interaction + * between two users. This can be used to build better recommendations and + * suggestions in user interfaces. + * + * Emitters should add at least one identifier (uid, email, federated cloud ID) + * of the recipient of the interaction. + * + * @since 19.0.0 + */ +class ContactInteractedWithEvent extends Event { + + /** @var IUser */ + private $actor; + + /** @var string|null */ + private $uid; + + /** @var string|null */ + private $email; + + /** @var string|null */ + private $federatedCloudId; + + /** + * @param IUser $actor the user who started the interaction + * + * @since 19.0.0 + */ + public function __construct(IUser $actor) { + parent::__construct(); + $this->actor = $actor; + } + + /** + * @return IUser + * @since 19.0.0 + */ + public function getActor(): IUser { + return $this->actor; + } + + /** + * @return string|null + * @since 19.0.0 + */ + public function getUid(): ?string { + return $this->uid; + } + + /** + * Set the uid of the person interacted with, if known + * + * @param string $uid + * + * @return self + * @since 19.0.0 + */ + public function setUid(string $uid): self { + $this->uid = $uid; + return $this; + } + + /** + * @return string|null + * @since 19.0.0 + */ + public function getEmail(): ?string { + return $this->email; + } + + /** + * Set the email of the person interacted with, if known + * + * @param string $email + * + * @return self + * @since 19.0.0 + */ + public function setEmail(string $email): self { + $this->email = $email; + return $this; + } + + /** + * @return string|null + * @since 19.0.0 + */ + public function getFederatedCloudId(): ?string { + return $this->federatedCloudId; + } + + /** + * Set the federated cloud of the person interacted with, if known + * + * @param string $federatedCloudId + * + * @return self + * @since 19.0.0 + */ + public function setFederatedCloudId(string $federatedCloudId): self { + $this->federatedCloudId = $federatedCloudId; + return $this; + } + +}