LibreNMS/Interfaces/Alert/Transport.php
<?php
/**
* Transport.php
*
* An interface for the transport of alerts.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* @link https://www.librenms.org
*
* @copyright 2017 Robrecht Plaisier
* @author Robbrecht Plaisier <librenms@mcq8.be>
*/
namespace LibreNMS\Interfaces\Alert;
interface Transport
{
/**
* @return string The display name of this transport.
*/
public function name(): string;
/**
* Gets called when an alert is sent
*
* @param array $alert_data An array created by DescribeAlert
* @return bool Returns true if the call was successful.
*
* @throws \LibreNMS\Exceptions\AlertTransportDeliveryException
*/
public function deliverAlert(array $alert_data): bool;
/**
* @return array
*/
public static function configTemplate(): array;
/**
* Display the configuration details of this alert transport
*
* @return string
*/
public function displayDetails(): string;
}