blob: da467c51e56df0dc2cf18d0b6c0f1a33f40ae610 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
<?php
declare(strict_types=1);
/**
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* Nextcloud - Two-factor Gateway
*
* 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/>
*
*/
namespace OCA\TwoFactorGateway\Service\Gateway;
use OCA\TwoFactorGateway\Exception\SmsTransmissionException;
use OCP\IUser;
interface IGateway {
/**
* Get a short description of this gateway's name so that users know how
* their messages are delivered, e.g. "Telegram"
*
* @return string
*/
public function getShortName(): string;
/**
* Get the gateway-specific configuration
*
* @return IGatewayConfig
*/
public function getConfig(): IGatewayConfig;
/**
* @param IUser $user
* @param string $identifier
* @param string $message
*
* @throws SmsTransmissionException
*/
public function send(IUser $user, string $identifier, string $message);
}
|
