ContactInteractedWithEvent extends Event
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.
Tags
Table of Contents
- $actor : IUser
- $email : string|null
- $federatedCloudId : string|null
- $uid : string|null
- __construct() : mixed
- Compatibility constructor
- getActor() : IUser
- getEmail() : string|null
- getFederatedCloudId() : string|null
- getUid() : string|null
- setEmail() : self
- Set the email of the person interacted with, if known
- setFederatedCloudId() : self
- Set the federated cloud of the person interacted with, if known
- setUid() : self
- Set the uid of the person interacted with, if known
Properties
$actor
private
IUser
$actor
private
string|null
$email
$federatedCloudId
private
string|null
$federatedCloudId
$uid
private
string|null
$uid
Methods
__construct()
Compatibility constructor
public
__construct(IUser $actor) : mixed
In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base class that had a constructor (with default arguments). To lower the risk of a breaking change (PHP won't allow parent constructor calls if there is none), this empty constructor's only purpose is to hopefully not break existing sub- classes of this class.
Parameters
- $actor : IUser
-
the user who started the interaction
Tags
Return values
mixed —getActor()
public
getActor() : IUser
Tags
Return values
IUser —getEmail()
public
getEmail() : string|null
Tags
Return values
string|null —getFederatedCloudId()
public
getFederatedCloudId() : string|null
Tags
Return values
string|null —getUid()
public
getUid() : string|null
Tags
Return values
string|null —setEmail()
Set the email of the person interacted with, if known
public
setEmail(string $email) : self
Parameters
- $email : string
Tags
Return values
self —setFederatedCloudId()
Set the federated cloud of the person interacted with, if known
public
setFederatedCloudId(string $federatedCloudId) : self
Parameters
- $federatedCloudId : string
Tags
Return values
self —setUid()
Set the uid of the person interacted with, if known
public
setUid(string $uid) : self
Parameters
- $uid : string