Notification¶

class OC\Notification\Notification¶

Source:	lib/private/Notification/Notification.php#35
Implements:	`OCP\Notification\INotification`

Properties¶

protected static property OC\Notification\Notification::$richValidator¶

Source:	lib/private/Notification/Notification.php#38
Type:	`\OCP\RichObjectStrings\IValidator`

protected static property OC\Notification\Notification::$app¶

Source:	lib/private/Notification/Notification.php#41
Type:	string

protected static property OC\Notification\Notification::$user¶

Source:	lib/private/Notification/Notification.php#44
Type:	string

protected static property OC\Notification\Notification::$dateTime¶

Source:	lib/private/Notification/Notification.php#47
Type:	`\DateTime`

protected static property OC\Notification\Notification::$objectType¶

Source:	lib/private/Notification/Notification.php#50
Type:	string

protected static property OC\Notification\Notification::$objectId¶

Source:	lib/private/Notification/Notification.php#53
Type:	string

protected static property OC\Notification\Notification::$subject¶

Source:	lib/private/Notification/Notification.php#56
Type:	string

protected static property OC\Notification\Notification::$subjectParameters¶

Source:	lib/private/Notification/Notification.php#59
Type:	array

protected static property OC\Notification\Notification::$subjectParsed¶

Source:	lib/private/Notification/Notification.php#62
Type:	string

protected static property OC\Notification\Notification::$subjectRich¶

Source:	lib/private/Notification/Notification.php#65
Type:	string

protected static property OC\Notification\Notification::$subjectRichParameters¶

Source:	lib/private/Notification/Notification.php#68
Type:	array

protected static property OC\Notification\Notification::$message¶

Source:	lib/private/Notification/Notification.php#71
Type:	string

protected static property OC\Notification\Notification::$messageParameters¶

Source:	lib/private/Notification/Notification.php#74
Type:	array

protected static property OC\Notification\Notification::$messageParsed¶

Source:	lib/private/Notification/Notification.php#77
Type:	string

protected static property OC\Notification\Notification::$messageRich¶

Source:	lib/private/Notification/Notification.php#80
Type:	string

protected static property OC\Notification\Notification::$messageRichParameters¶

Source:	lib/private/Notification/Notification.php#83
Type:	array

protected static property OC\Notification\Notification::$link¶

Source:	lib/private/Notification/Notification.php#86
Type:	string

protected static property OC\Notification\Notification::$icon¶

Source:	lib/private/Notification/Notification.php#89
Type:	string

protected static property OC\Notification\Notification::$actions¶

Source:	lib/private/Notification/Notification.php#92
Type:	array

protected static property OC\Notification\Notification::$actionsParsed¶

Source:	lib/private/Notification/Notification.php#95
Type:	array

protected static property OC\Notification\Notification::$hasPrimaryAction¶

Source:	lib/private/Notification/Notification.php#98
Type:	bool

protected static property OC\Notification\Notification::$hasPrimaryParsedAction¶

Source:	lib/private/Notification/Notification.php#101
Type:	bool

Methods¶

public OC\Notification\Notification::__construct($richValidator)¶

Source:	lib/private/Notification/Notification.php#103

public OC\Notification\Notification::setApp($app)¶

Source:	lib/private/Notification/Notification.php#133
Parameters:	$app (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the app id is invalid
Since:	8.2.0

public OC\Notification\Notification::getApp()¶

Source:	lib/private/Notification/Notification.php#145
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::setUser($user)¶

Source:	lib/private/Notification/Notification.php#155
Parameters:	$user (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the user id is invalid
Since:	8.2.0

public OC\Notification\Notification::getUser()¶

Source:	lib/private/Notification/Notification.php#167
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::setDateTime($dateTime)¶

Source:	lib/private/Notification/Notification.php#177
Parameters:	$dateTime (`DateTime`)
Returns:	$this
Throws:	`\InvalidArgumentException` if the $dateTime is invalid
Since:	9.0.0

public OC\Notification\Notification::getDateTime()¶

Source:	lib/private/Notification/Notification.php#189
Returns:	`\DateTime`
Since:	9.0.0

public OC\Notification\Notification::setObject($type, $id)¶

Source:	lib/private/Notification/Notification.php#200
Parameters:	$type (string) $id (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the object type or id is invalid
Since:	8.2.0 - 9.0.0: Type of $id changed to string

public OC\Notification\Notification::getObjectType()¶

Source:	lib/private/Notification/Notification.php#217
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::getObjectId()¶

Source:	lib/private/Notification/Notification.php#225
Returns:	string
Since:	8.2.0 - 9.0.0: Return type changed to string

public OC\Notification\Notification::setSubject($subject, $parameters=[])¶

Source:	lib/private/Notification/Notification.php#236
Parameters:	$subject (string) $parameters (array)
Returns:	$this
Throws:	`\InvalidArgumentException` if the subject or parameters are invalid
Since:	8.2.0

public OC\Notification\Notification::getSubject()¶

Source:	lib/private/Notification/Notification.php#251
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::getSubjectParameters()¶

Source:	lib/private/Notification/Notification.php#259
Returns:	array
Since:	8.2.0

public OC\Notification\Notification::setParsedSubject($subject)¶

Source:	lib/private/Notification/Notification.php#269
Parameters:	$subject (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the subject is invalid
Since:	8.2.0

public OC\Notification\Notification::getParsedSubject()¶

Source:	lib/private/Notification/Notification.php#281
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::setRichSubject($subject, $parameters=[])¶

Source:	lib/private/Notification/Notification.php#292
Parameters:	$subject (string) $parameters (array)
Returns:	$this
Throws:	`\InvalidArgumentException` if the subject or parameters are invalid
Since:	11.0.0

public OC\Notification\Notification::getRichSubject()¶

Source:	lib/private/Notification/Notification.php#307
Returns:	string
Since:	11.0.0

public OC\Notification\Notification::getRichSubjectParameters()¶

Source:	lib/private/Notification/Notification.php#315
Returns:	array[]
Since:	11.0.0

public OC\Notification\Notification::setMessage($message, $parameters=[])¶

Source:	lib/private/Notification/Notification.php#326
Parameters:	$message (string) $parameters (array)
Returns:	$this
Throws:	`\InvalidArgumentException` if the message or parameters are invalid
Since:	8.2.0

public OC\Notification\Notification::getMessage()¶

Source:	lib/private/Notification/Notification.php#341
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::getMessageParameters()¶

Source:	lib/private/Notification/Notification.php#349
Returns:	array
Since:	8.2.0

public OC\Notification\Notification::setParsedMessage($message)¶

Source:	lib/private/Notification/Notification.php#359
Parameters:	$message (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the message is invalid
Since:	8.2.0

public OC\Notification\Notification::getParsedMessage()¶

Source:	lib/private/Notification/Notification.php#371
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::setRichMessage($message, $parameters=[])¶

Source:	lib/private/Notification/Notification.php#382
Parameters:	$message (string) $parameters (array)
Returns:	$this
Throws:	`\InvalidArgumentException` if the message or parameters are invalid
Since:	11.0.0

public OC\Notification\Notification::getRichMessage()¶

Source:	lib/private/Notification/Notification.php#397
Returns:	string
Since:	11.0.0

public OC\Notification\Notification::getRichMessageParameters()¶

Source:	lib/private/Notification/Notification.php#405
Returns:	array[]
Since:	11.0.0

public OC\Notification\Notification::setLink($link)¶

Source:	lib/private/Notification/Notification.php#415
Parameters:	$link (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the link is invalid
Since:	8.2.0

public OC\Notification\Notification::getLink()¶

Source:	lib/private/Notification/Notification.php#427
Returns:	string
Since:	8.2.0

public OC\Notification\Notification::setIcon($icon)¶

Source:	lib/private/Notification/Notification.php#437
Parameters:	$icon (string)
Returns:	$this
Throws:	`\InvalidArgumentException` if the icon is invalid
Since:	11.0.0

public OC\Notification\Notification::getIcon()¶

Source:	lib/private/Notification/Notification.php#449
Returns:	string
Since:	11.0.0

public OC\Notification\Notification::createAction()¶

Source:	lib/private/Notification/Notification.php#457
Returns:	`\OCP\Notification\IAction`
Since:	8.2.0

public OC\Notification\Notification::addAction($action)¶

Source:	lib/private/Notification/Notification.php#467
Parameters:	$action (`OCP\Notification\IAction`)
Returns:	$this
Throws:	`\InvalidArgumentException` if the action is invalid
Since:	8.2.0

public OC\Notification\Notification::getActions()¶

Source:	lib/private/Notification/Notification.php#488
Returns:	`\OCP\Notification\IAction[]`
Since:	8.2.0

public OC\Notification\Notification::addParsedAction($action)¶

Source:	lib/private/Notification/Notification.php#498
Parameters:	$action (`OCP\Notification\IAction`)
Returns:	$this
Throws:	`\InvalidArgumentException` if the action is invalid
Since:	8.2.0

public OC\Notification\Notification::getParsedActions()¶

Source:	lib/private/Notification/Notification.php#523
Returns:	`\OCP\Notification\IAction[]`
Since:	8.2.0

public OC\Notification\Notification::isValid()¶

Source:	lib/private/Notification/Notification.php#531
Returns:	bool
Since:	8.2.0

public OC\Notification\Notification::isValidParsed()¶

Source:	lib/private/Notification/Notification.php#543
Returns:	bool
Since:	8.2.0

protected OC\Notification\Notification::isValidCommon()¶

Source:	lib/private/Notification/Notification.php#567