blob: 1888b7606bfc89ce90958a79e0dffc8dc57d9726 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
<?php
declare(strict_types=1);
/**
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @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 <http://www.gnu.org/licenses/>.
*
*/
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;
}
}
|
