ContactInteractedWithEvent
extends Event
in package
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
Properties
- $actor : IUser
- $email : string|null
- $federatedCloudId : string|null
- $propagationStopped : bool
- $uid : string|null
Methods
- __construct() : mixed
- Compatibility constructor
- getActor() : IUser
- getEmail() : string|null
- getFederatedCloudId() : string|null
- getUid() : string|null
- isPropagationStopped() : bool
- {@inheritDoc}
- 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
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$actor
private
IUser
$actor
private
string|null
$email
$federatedCloudId
private
string|null
$federatedCloudId
$propagationStopped
private
bool
$propagationStopped
= false
Tags
$uid
private
string|null
$uid
Methods
__construct()
Compatibility constructor
public
__construct(IUser $actor) : mixed
Parameters
- $actor : IUser
-
the user who started the interaction
Tags
getActor()
public
getActor() : IUser
Tags
Return values
IUsergetEmail()
public
getEmail() : string|null
Tags
Return values
string|nullgetFederatedCloudId()
public
getFederatedCloudId() : string|null
Tags
Return values
string|nullgetUid()
public
getUid() : string|null
Tags
Return values
string|nullisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolsetEmail()
Set the email of the person interacted with, if known
public
setEmail(string $email) : self
Parameters
- $email : string
Tags
Return values
selfsetFederatedCloudId()
Set the federated cloud of the person interacted with, if known
public
setFederatedCloudId(string $federatedCloudId) : self
Parameters
- $federatedCloudId : string
Tags
Return values
selfsetUid()
Set the uid of the person interacted with, if known
public
setUid(string $uid) : self
Parameters
- $uid : string
Tags
Return values
selfstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void