Current File : /home/ugotscom/kma/vendor/botman/botman/src/Interfaces/DriverInterface.php
<?php
namespace BotMan\BotMan\Interfaces;
use BotMan\BotMan\Messages\Incoming\IncomingMessage;
use Symfony\Component\HttpFoundation\Response;
interface DriverInterface
{
/**
* Determine if the request is for this driver.
*
* @return bool
*/
public function matchesRequest();
/**
* Retrieve the chat message(s).
*
* @return array
*/
public function getMessages();
/**
* @return bool
*/
public function isConfigured();
/**
* Retrieve User information.
* @param IncomingMessage $matchingMessage
* @return UserInterface
*/
public function getUser(IncomingMessage $matchingMessage);
/**
* @param IncomingMessage $message
* @return \BotMan\BotMan\Messages\Incoming\Answer
*/
public function getConversationAnswer(IncomingMessage $message);
/**
* @param string|\BotMan\BotMan\Messages\Outgoing\Question $message
* @param IncomingMessage $matchingMessage
* @param array $additionalParameters
* @return $this
*/
public function buildServicePayload($message, $matchingMessage, $additionalParameters = []);
/**
* @param mixed $payload
* @return Response
*/
public function sendPayload($payload);
/**
* Return the driver name.
*
* @return string
*/
public function getName();
/**
* Does the driver match to an incoming messaging service event.
*
* @return bool|mixed
*/
public function hasMatchingEvent();
/**
* Send a typing indicator.
* @param IncomingMessage $matchingMessage
* @return mixed
*/
public function types(IncomingMessage $matchingMessage);
/**
* Send a typing indicator and wait for the given amount of seconds.
* @param IncomingMessage $matchingMessage
* @param int $seconds
* @param float $seconds
* @return mixed
*/
public function typesAndWaits(IncomingMessage $matchingMessage, float $seconds);
/**
* Tells if the stored conversation callbacks are serialized.
*
* @return bool
*/
public function serializesCallbacks();
}
Mini Shell