IEvent
in
Interface IEvent
Tags
Table of Contents
- getAffectedUser() : string
- getApp() : string
- getAuthor() : string
- getChildEvent() : IEvent|null
- getGenerateNotification() : bool
- whether or not a notification should be automatically generated for this activity.
- getIcon() : string
- getLink() : string
- getMessage() : string
- getMessageParameters() : array<string|int, mixed>
- getObjectId() : int
- getObjectName() : string
- getObjectType() : string
- getParsedMessage() : string
- getParsedSubject() : string
- getRichMessage() : string
- getRichMessageParameters() : array<string|int, array<string|int, mixed>>
- getRichSubject() : string
- getRichSubjectParameters() : array<string|int, array<string|int, mixed>>
- getSubject() : string
- getSubjectParameters() : array<string|int, mixed>
- getTimestamp() : int
- getType() : string
- isValid() : bool
- isValidParsed() : bool
- setAffectedUser() : IEvent
- Set the affected user of the activity
- setApp() : IEvent
- Set the app of the activity
- setAuthor() : IEvent
- Set the author of the activity
- setChildEvent() : $this
- setGenerateNotification() : IEvent
- Set whether or not a notification should be automatically generated for this activity.
- setIcon() : $this
- setLink() : IEvent
- Set the link of the activity
- setMessage() : IEvent
- Set the message of the activity
- setObject() : IEvent
- Set the object of the activity
- setParsedMessage() : $this
- Set a parsed message
- setParsedSubject() : $this
- Set a parsed subject
- setRichMessage() : $this
- Set a RichObjectString message
- setRichSubject() : $this
- Set a RichObjectString subject
- setSubject() : IEvent
- Set the subject of the activity
- setTimestamp() : IEvent
- Set the author of the activity
- setType() : IEvent
- Set the type of the activity
Methods
getAffectedUser()
public
getAffectedUser() : string
Tags
Return values
string —getApp()
public
getApp() : string
Tags
Return values
string —getAuthor()
public
getAuthor() : string
Tags
Return values
string —getChildEvent()
public
getChildEvent() : IEvent|null
Tags
Return values
IEvent|null —getGenerateNotification()
whether or not a notification should be automatically generated for this activity.
public
getGenerateNotification() : bool
Tags
Return values
bool —getIcon()
public
getIcon() : string
Tags
Return values
string —getLink()
public
getLink() : string
Tags
Return values
string —getMessage()
public
getMessage() : string
Tags
Return values
string —getMessageParameters()
public
getMessageParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getObjectId()
public
getObjectId() : int
Tags
Return values
int —getObjectName()
public
getObjectName() : string
Tags
Return values
string —getObjectType()
public
getObjectType() : string
Tags
Return values
string —getParsedMessage()
public
getParsedMessage() : string
Tags
Return values
string —getParsedSubject()
public
getParsedSubject() : string
Tags
Return values
string —getRichMessage()
public
getRichMessage() : string
Tags
Return values
string —getRichMessageParameters()
public
getRichMessageParameters() : array<string|int, array<string|int, mixed>>
Tags
Return values
array<string|int, array<string|int, mixed>> —getRichSubject()
public
getRichSubject() : string
Tags
Return values
string —getRichSubjectParameters()
public
getRichSubjectParameters() : array<string|int, array<string|int, mixed>>
Tags
Return values
array<string|int, array<string|int, mixed>> —getSubject()
public
getSubject() : string
Tags
Return values
string —getSubjectParameters()
public
getSubjectParameters() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getTimestamp()
public
getTimestamp() : int
Tags
Return values
int —getType()
public
getType() : string
Tags
Return values
string —isValid()
public
isValid() : bool
Tags
Return values
bool —isValidParsed()
public
isValidParsed() : bool
Tags
Return values
bool —setAffectedUser()
Set the affected user of the activity
public
setAffectedUser(string $user) : IEvent
Parameters
- $user : string
Tags
Return values
IEvent —setApp()
Set the app of the activity
public
setApp(string $app) : IEvent
Parameters
- $app : string
Tags
Return values
IEvent —setAuthor()
Set the author of the activity
public
setAuthor(string $author) : IEvent
Parameters
- $author : string
Tags
Return values
IEvent —setChildEvent()
public
setChildEvent(IEvent $child) : $this
Parameters
- $child : IEvent
Tags
Return values
$this —setGenerateNotification()
Set whether or not a notification should be automatically generated for this activity.
public
setGenerateNotification(bool $generate) : IEvent
Set this to false if the app already generates a notification for the event.
Parameters
- $generate : bool
Tags
Return values
IEvent —setIcon()
public
setIcon(string $icon) : $this
Parameters
- $icon : string
Tags
Return values
$this —setLink()
Set the link of the activity
public
setLink(string $link) : IEvent
Parameters
- $link : string
Tags
Return values
IEvent —setMessage()
Set the message of the activity
public
setMessage(string $message[, array<string|int, mixed> $parameters = [] ]) : IEvent
Parameters
- $message : string
- $parameters : array<string|int, mixed> = []
Tags
Return values
IEvent —setObject()
Set the object of the activity
public
setObject(string $objectType, int $objectId[, string $objectName = '' ]) : IEvent
Parameters
- $objectType : string
- $objectId : int
- $objectName : string = ''
Tags
Return values
IEvent —setParsedMessage()
Set a parsed message
public
setParsedMessage(string $message) : $this
HTML is not allowed in the parsed message and will be escaped automatically by the clients. You can use the RichObjectString system provided by the Nextcloud server to highlight important parameters via the setRichMessage method.
See https://github.com/nextcloud/server/issues/1706 for more information.
Parameters
- $message : string
Tags
Return values
$this —setParsedSubject()
Set a parsed subject
public
setParsedSubject(string $subject) : $this
HTML is not allowed in the parsed subject and will be escaped automatically by the clients. You can use the RichObjectString system provided by the Nextcloud server to highlight important parameters via the setRichSubject method.
See https://github.com/nextcloud/server/issues/1706 for more information.
Parameters
- $subject : string
Tags
Return values
$this —setRichMessage()
Set a RichObjectString message
public
setRichMessage(string $message[, array<string|int, mixed> $parameters = [] ]) : $this
HTML is not allowed in the rich message and will be escaped automatically by the clients, but you can use the RichObjectString system provided by the Nextcloud server to highlight important parameters.
See https://github.com/nextcloud/server/issues/1706 for more information.
Parameters
- $message : string
- $parameters : array<string|int, mixed> = []
Tags
Return values
$this —setRichSubject()
Set a RichObjectString subject
public
setRichSubject(string $subject[, array<string|int, mixed> $parameters = [] ]) : $this
HTML is not allowed in the rich subject and will be escaped automatically by the clients, but you can use the RichObjectString system provided by the Nextcloud server to highlight important parameters.
See https://github.com/nextcloud/server/issues/1706 for more information.
Parameters
- $subject : string
- $parameters : array<string|int, mixed> = []
Tags
Return values
$this —setSubject()
Set the subject of the activity
public
setSubject(string $subject[, array<string|int, mixed> $parameters = [] ]) : IEvent
Parameters
- $subject : string
- $parameters : array<string|int, mixed> = []
Tags
Return values
IEvent —setTimestamp()
Set the author of the activity
public
setTimestamp(int $timestamp) : IEvent
Parameters
- $timestamp : int
Tags
Return values
IEvent —setType()
Set the type of the activity
public
setType(string $type) : IEvent
Parameters
- $type : string