nextcloud/lib/public/Notification/INotification.php

327 lines
7.8 KiB
PHP
Raw Normal View History

2015-08-31 13:24:37 +03:00
<?php
declare(strict_types=1);
2015-08-31 13:24:37 +03:00
/**
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2016-07-21 18:07:57 +03:00
*
* @author Joas Schilling <coding@schilljs.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2016-07-21 18:07:57 +03:00
*
2015-08-31 13:24:37 +03:00
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2015-08-31 13:24:37 +03:00
*
*/
namespace OCP\Notification;
2015-08-31 13:24:37 +03:00
/**
* Interface INotification
*
* @package OCP\Notification
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
interface INotification {
/**
* @param string $app
* @return $this
* @throws \InvalidArgumentException if the app id is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setApp(string $app): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getApp(): string;
2015-08-31 13:24:37 +03:00
/**
* @param string $user
* @return $this
* @throws \InvalidArgumentException if the user id is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setUser(string $user): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getUser(): string;
2015-08-31 13:24:37 +03:00
/**
* @param \DateTime $dateTime
2015-08-31 13:24:37 +03:00
* @return $this
* @throws \InvalidArgumentException if the $dateTime is invalid
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setDateTime(\DateTime $dateTime): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return \DateTime
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getDateTime(): \DateTime;
2015-08-31 13:24:37 +03:00
/**
* @param string $type
* @param string $id
2015-08-31 13:24:37 +03:00
* @return $this
* @throws \InvalidArgumentException if the object type or id is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setObject(string $type, string $id): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getObjectType(): string;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getObjectId(): string;
2015-08-31 13:24:37 +03:00
/**
* @param string $subject
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setSubject(string $subject, array $parameters = []): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getSubject(): string;
2015-08-31 13:24:37 +03:00
/**
* @return array
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getSubjectParameters(): array;
2015-08-31 13:24:37 +03:00
/**
* 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, 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.
*
2015-08-31 13:24:37 +03:00
* @param string $subject
* @return $this
* @throws \InvalidArgumentException if the subject is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setParsedSubject(string $subject): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getParsedSubject(): string;
2015-08-31 13:24:37 +03:00
/**
* 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.
* 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.
*
* @param string $subject
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the subject or parameters are invalid
* @since 11.0.0
*/
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;
2015-08-31 13:24:37 +03:00
/**
* @param string $message
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setMessage(string $message, array $parameters = []): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getMessage(): string;
2015-08-31 13:24:37 +03:00
/**
* @return array
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getMessageParameters(): array;
2015-08-31 13:24:37 +03:00
/**
* 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, 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.
*
2015-08-31 13:24:37 +03:00
* @param string $message
* @return $this
* @throws \InvalidArgumentException if the message is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setParsedMessage(string $message): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getParsedMessage(): string;
2015-08-31 13:24:37 +03:00
/**
* 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.
* 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.
*
* @param string $message
* @param array $parameters
* @return $this
* @throws \InvalidArgumentException if the message or parameters are invalid
* @since 11.0.0
*/
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;
2015-08-31 13:24:37 +03:00
/**
* @param string $link
* @return $this
* @throws \InvalidArgumentException if the link is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setLink(string $link): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getLink(): string;
2015-08-31 13:24:37 +03:00
/**
* @param string $icon
* @return $this
* @throws \InvalidArgumentException if the icon is invalid
* @since 11.0.0
*/
public function setIcon(string $icon): INotification;
/**
* @return string
* @since 11.0.0
*/
public function getIcon(): string;
2015-08-31 13:24:37 +03:00
/**
* @return IAction
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function createAction(): IAction;
2015-08-31 13:24:37 +03:00
/**
* @param IAction $action
* @return $this
* @throws \InvalidArgumentException if the action is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function addAction(IAction $action): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return IAction[]
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getActions(): array;
2015-08-31 13:24:37 +03:00
/**
* @param IAction $action
* @return $this
* @throws \InvalidArgumentException if the action is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function addParsedAction(IAction $action): INotification;
2015-08-31 13:24:37 +03:00
/**
* @return IAction[]
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getParsedActions(): array;
2015-08-31 13:24:37 +03:00
/**
* @return bool
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function isValid(): bool;
2015-08-31 13:24:37 +03:00
/**
* @return bool
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function isValidParsed(): bool;
2015-08-31 13:24:37 +03:00
}