mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
ec8629fb63
* Discord ability to attach graph images Must use @signedGraphTag() Needs more work on the graph side of things still: issues with CORs and other. * Fixes * alert data is an array for transports * No need to decode, that was a bug before
58 lines
1.7 KiB
PHP
58 lines
1.7 KiB
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
|
|
* @param array|true $opts The options from the alert_transports transport_config column
|
|
* @return mixed Returns if the call was successful
|
|
*
|
|
* @throws \LibreNMS\Exceptions\AlertTransportDeliveryException
|
|
*/
|
|
public function deliverAlert($alert_data, $opts);
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public static function configTemplate();
|
|
|
|
/**
|
|
* Display the configuration details of this alert transport
|
|
*
|
|
* @return string
|
|
*/
|
|
public function displayDetails(): string;
|
|
}
|