Current File : /www/varak.net/nextcloud.varak.net/lib/public/Notification/INotification.php
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\Notification;
/**
* Interface INotification
*
* @since 9.0.0
*/
interface INotification {
/**
* @param string $app
* @return $this
* @throws InvalidValueException if the app id is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setApp(string $app): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getApp(): string;
/**
* @param string $user
* @return $this
* @throws InvalidValueException if the user id is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setUser(string $user): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getUser(): string;
/**
* @param \DateTime $dateTime
* @return $this
* @throws InvalidValueException if the $dateTime is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setDateTime(\DateTime $dateTime): INotification;
/**
* @return \DateTime
* @since 9.0.0
*/
public function getDateTime(): \DateTime;
/**
* @param string $type
* @param string $id
* @return $this
* @throws InvalidValueException if the object type or id is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setObject(string $type, string $id): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getObjectType(): string;
/**
* @return string
* @since 9.0.0
*/
public function getObjectId(): string;
/**
* @param string $subject
* @param array $parameters
* @return $this
* @throws InvalidValueException if the subject or parameters are invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setSubject(string $subject, array $parameters = []): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getSubject(): string;
/**
* @return array
* @since 9.0.0
*/
public function getSubjectParameters(): array;
/**
* Set a parsed subject
*
* 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.
*
* @param string $subject
* @return $this
* @throws InvalidValueException if the subject is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setParsedSubject(string $subject): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getParsedSubject(): string;
/**
* Set a RichObjectString subject
*
* 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.
*
* @param string $subject
* @param array $parameters
* @return $this
* @throws InvalidValueException if the subject or parameters are invalid
* @since 11.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setRichSubject(string $subject, array $parameters = []): INotification;
/**
* @return string
* @since 11.0.0
*/
public function getRichSubject(): string;
/**
* @return array[]
* @since 11.0.0
*/
public function getRichSubjectParameters(): array;
/**
* @param string $message
* @param array $parameters
* @return $this
* @throws InvalidValueException if the message or parameters are invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setMessage(string $message, array $parameters = []): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getMessage(): string;
/**
* @return array
* @since 9.0.0
*/
public function getMessageParameters(): array;
/**
* Set a parsed message
*
* 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.
*
* @param string $message
* @return $this
* @throws InvalidValueException if the message is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setParsedMessage(string $message): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getParsedMessage(): string;
/**
* Set a RichObjectString message
*
* 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.
*
* @param string $message
* @param array $parameters
* @return $this
* @throws InvalidValueException if the message or parameters are invalid
* @since 11.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setRichMessage(string $message, array $parameters = []): INotification;
/**
* @return string
* @since 11.0.0
*/
public function getRichMessage(): string;
/**
* @return array[]
* @since 11.0.0
*/
public function getRichMessageParameters(): array;
/**
* @param string $link
* @return $this
* @throws InvalidValueException if the link is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setLink(string $link): INotification;
/**
* @return string
* @since 9.0.0
*/
public function getLink(): string;
/**
* Set the absolute url for the icon (should be colored black or not have a color)
*
* It's automatically color inverted by clients when needed
*
* @param string $icon
* @return $this
* @throws InvalidValueException if the icon is invalid
* @since 11.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function setIcon(string $icon): INotification;
/**
* Get the absolute url for the icon (should be colored black or not have a color)
*
* It's automatically color inverted by clients when needed
*
* @return string
* @since 11.0.0
*/
public function getIcon(): string;
/**
* @return IAction
* @since 9.0.0
*/
public function createAction(): IAction;
/**
* @param IAction $action
* @return $this
* @throws InvalidValueException if the action is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function addAction(IAction $action): INotification;
/**
* @return IAction[]
* @since 9.0.0
*/
public function getActions(): array;
/**
* @param IAction $action
* @return $this
* @throws InvalidValueException if the action is invalid
* @since 9.0.0
* @since 30.0.0 throws {@see InvalidValueException} instead of \InvalidArgumentException
*/
public function addParsedAction(IAction $action): INotification;
/**
* @return IAction[]
* @since 9.0.0
*/
public function getParsedActions(): array;
/**
* @return bool
* @since 9.0.0
*/
public function isValid(): bool;
/**
* @return bool
* @since 9.0.0
*/
public function isValidParsed(): bool;
}
Mini Shell