Nextcloud PHP API (stable18)

IEvent

Interface IEvent

Tags
since
8.2.0

Table of Contents

getAffectedUser()  : string
getApp()  : string
getAuthor()  : string
getChildEvent()  : IEvent|null
getIcon()  : string
getLink()  : string
getMessage()  : string
getMessageParameters()  : array
getObjectId()  : int
getObjectName()  : string
getObjectType()  : string
getParsedMessage()  : string
getParsedSubject()  : string
getRichMessage()  : string
getRichMessageParameters()  : array[]
getRichSubject()  : string
getRichSubjectParameters()  : array[]
getSubject()  : string
getSubjectParameters()  : array
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
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
since
8.2.0
Return values
string

getApp()

public getApp() : string
Tags
since
8.2.0
Return values
string

getAuthor()

public getAuthor() : string
Tags
since
8.2.0
Return values
string

getChildEvent()

public getChildEvent() : IEvent|null
Tags
since
11.0.0
Return values
IEvent|null

getIcon()

public getIcon() : string
Tags
since
11.0.0
Return values
string
public getLink() : string
Tags
since
8.2.0
Return values
string

getMessage()

public getMessage() : string
Tags
since
8.2.0
Return values
string

getMessageParameters()

public getMessageParameters() : array
Tags
since
8.2.0
Return values
array

getObjectId()

public getObjectId() : int
Tags
since
8.2.0
Return values
int

getObjectName()

public getObjectName() : string
Tags
since
8.2.0
Return values
string

getObjectType()

public getObjectType() : string
Tags
since
8.2.0
Return values
string

getParsedMessage()

public getParsedMessage() : string
Tags
since
11.0.0
Return values
string

getParsedSubject()

public getParsedSubject() : string
Tags
since
11.0.0
Return values
string

getRichMessage()

public getRichMessage() : string
Tags
since
11.0.0
Return values
string

getRichMessageParameters()

public getRichMessageParameters() : array[]
Tags
since
11.0.0
Return values
array[]

getRichSubject()

public getRichSubject() : string
Tags
since
11.0.0
Return values
string

getRichSubjectParameters()

public getRichSubjectParameters() : array[]
Tags
since
11.0.0
Return values
array[]

getSubject()

public getSubject() : string
Tags
since
8.2.0
Return values
string

getSubjectParameters()

public getSubjectParameters() : array
Tags
since
8.2.0
Return values
array

getTimestamp()

public getTimestamp() : int
Tags
since
8.2.0
Return values
int

getType()

public getType() : string
Tags
since
8.2.0
Return values
string

isValid()

public isValid() : bool
Tags
since
11.0.0
Return values
bool

isValidParsed()

public isValidParsed() : bool
Tags
since
11.0.0
Return values
bool

setAffectedUser()

Set the affected user of the activity

public setAffectedUser(string $user) : IEvent
Parameters
$user : string
Tags
throws
InvalidArgumentException

if the affected user is invalid

since
8.2.0
Return values
IEvent

setApp()

Set the app of the activity

public setApp(string $app) : IEvent
Parameters
$app : string
Tags
throws
InvalidArgumentException

if the app id is invalid

since
8.2.0
Return values
IEvent

setAuthor()

Set the author of the activity

public setAuthor(string $author) : IEvent
Parameters
$author : string
Tags
throws
InvalidArgumentException

if the author is invalid

since
8.2.0
Return values
IEvent

setChildEvent()

public setChildEvent(IEvent $child) : $this
Parameters
$child : IEvent
Tags
since
11.0.0
  • Since 15.0.0 returns $this
Return values
$this

setIcon()

public setIcon(string $icon) : $this
Parameters
$icon : string
Tags
throws
InvalidArgumentException

if the icon is invalid

since
11.0.0
Return values
$this

Set the link of the activity

public setLink(string $link) : IEvent
Parameters
$link : string
Tags
throws
InvalidArgumentException

if the link is invalid

since
8.2.0
Return values
IEvent

setMessage()

Set the message of the activity

public setMessage(string $message[, array $parameters = [] ]) : IEvent
Parameters
$message : string
$parameters : array = []
Tags
throws
InvalidArgumentException

if the message or parameters are invalid

since
8.2.0
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
throws
InvalidArgumentException

if the object is invalid

since
8.2.0
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, but make sure, that a plain text message is always set via setParsedMessage, to support clients which can not handle rich strings.

See https://github.com/nextcloud/server/issues/1706 for more information.

Parameters
$message : string
Tags
throws
InvalidArgumentException

if the message is invalid

since
11.0.0
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, but make sure, that a plain text message is always set via setParsedSubject, to support clients which can not handle rich strings.

See https://github.com/nextcloud/server/issues/1706 for more information.

Parameters
$subject : string
Tags
throws
InvalidArgumentException

if the subject is invalid

since
11.0.0
Return values
$this

setRichMessage()

Set a RichObjectString message

public setRichMessage(string $message[, array $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. Also make sure, that a plain text message is always set via setParsedMessage, to support clients which can not handle rich strings.

See https://github.com/nextcloud/server/issues/1706 for more information.

Parameters
$message : string
$parameters : array = []
Tags
throws
InvalidArgumentException

if the message or parameters are invalid

since
11.0.0
Return values
$this

setRichSubject()

Set a RichObjectString subject

public setRichSubject(string $subject[, array $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. Also make sure, that a plain text subject is always set via setParsedSubject, to support clients which can not handle rich strings.

See https://github.com/nextcloud/server/issues/1706 for more information.

Parameters
$subject : string
$parameters : array = []
Tags
throws
InvalidArgumentException

if the subject or parameters are invalid

since
11.0.0
Return values
$this

setSubject()

Set the subject of the activity

public setSubject(string $subject[, array $parameters = [] ]) : IEvent
Parameters
$subject : string
$parameters : array = []
Tags
throws
InvalidArgumentException

if the subject or parameters are invalid

since
8.2.0
Return values
IEvent

setTimestamp()

Set the author of the activity

public setTimestamp(int $timestamp) : IEvent
Parameters
$timestamp : int
Tags
throws
InvalidArgumentException

if the timestamp is invalid

since
8.2.0
Return values
IEvent

setType()

Set the type of the activity

public setType(string $type) : IEvent
Parameters
$type : string
Tags
throws
InvalidArgumentException

if the type is invalid

since
8.2.0
Return values
IEvent

Search results