2017-12-10 21:20:28 +01:00
|
|
|
<?php
|
|
|
|
|
/**
|
|
|
|
|
* Transport.php
|
|
|
|
|
*
|
|
|
|
|
* An interface for the transport of alerts.
|
|
|
|
|
*
|
2014-12-15 11:10:26 +00:00
|
|
|
* 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.
|
2015-07-13 20:10:26 +02:00
|
|
|
*
|
2014-12-15 11:10:26 +00:00
|
|
|
* 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.
|
2015-07-13 20:10:26 +02:00
|
|
|
*
|
2014-12-15 11:10:26 +00:00
|
|
|
* You should have received a copy of the GNU General Public License
|
2017-12-10 21:20:28 +01:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
*
|
|
|
|
|
* @link http://librenms.org
|
|
|
|
|
* @copyright 2017 Robrecht Plaisier
|
|
|
|
|
* @author Robbrecht Plaisier <librenms@mcq8.be>
|
2014-12-15 11:10:26 +00:00
|
|
|
*/
|
|
|
|
|
|
2017-12-10 21:20:28 +01:00
|
|
|
namespace LibreNMS\Interfaces\Alert;
|
|
|
|
|
|
|
|
|
|
interface Transport
|
|
|
|
|
{
|
|
|
|
|
/**
|
|
|
|
|
* Gets called when an alert is sent
|
|
|
|
|
*
|
|
|
|
|
* @param $alert_data array An array created by DescribeAlert
|
2019-02-15 13:58:59 +00:00
|
|
|
* @param $opts array|true The options from the alert_transports transport_config column
|
2018-07-29 22:52:53 +01:00
|
|
|
* @return mixed Returns if the call was successful
|
2017-12-10 21:20:28 +01:00
|
|
|
*/
|
|
|
|
|
public function deliverAlert($alert_data, $opts);
|
2018-08-17 22:38:00 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @return array
|
|
|
|
|
*/
|
|
|
|
|
public static function configTemplate();
|
2015-03-15 13:00:25 +00:00
|
|
|
}
|