ContactInteractedWithEvent¶
-
class
OCP\Contacts\Events\
ContactInteractedWithEvent
¶ - An event that allows apps to notify other components about an interactionbetween two users. This can be used to build better recommendations andsuggestions in user interfaces.Emitters should add at least one identifier (uid, email, federated cloud ID)of the recipient of the interaction.
Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#42 Parent: OCP\EventDispatcher\Event
Properties¶
Methods¶
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
__construct
($actor)¶ Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#61
Parameters: - $actor (
OCP\IUser
) the user who started the interaction
Since: 19.0.0
- $actor (
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
getActor
()¶ Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#70 Returns: \OCP\IUser
Since: 19.0.0
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
getUid
()¶ Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#78 Returns: string | null Since: 19.0.0
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
setUid
($uid)¶ - Set the uid of the person interacted with, if known
Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#90
Parameters: - $uid (string)
Returns: self
Since: 19.0.0
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
getEmail
()¶ Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#99 Returns: string | null Since: 19.0.0
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
setEmail
($email)¶ - Set the email of the person interacted with, if known
Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#111
Parameters: - $email (string)
Returns: self
Since: 19.0.0
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
getFederatedCloudId
()¶ Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#120 Returns: string | null Since: 19.0.0
-
public
OCP\Contacts\Events\ContactInteractedWithEvent::
setFederatedCloudId
($federatedCloudId)¶ - Set the federated cloud of the person interacted with, if known
Source: lib/public/Contacts/Events/ContactInteractedWithEvent.php#132
Parameters: - $federatedCloudId (string)
Returns: self
Since: 19.0.0