jeyroik/extas-alice

<?php
namespace extas\interfaces\yandex\skills\scenarios;

use extas\interfaces\IHasDescription;
use extas\interfaces\IHasName;
use extas\interfaces\IItem;
use extas\interfaces\yandex\calls\IAliceCall;
use extas\interfaces\yandex\responses\IAliceResponse;
use extas\interfaces\yandex\skills\IAliceSkill;

/**
 * Interface IScenario
 *
 * @package extas\interfaces\yandex\skills\scenarios
 * @author jeyroik@gmail.com
 */
interface IScenario extends IItem, IHasName, IHasDescription
{
    public const SUBJECT = 'alice.skill.scenario';

    public const FIELD__SCHEMA = 'schema';
    public const FIELD__SKILL_NAME = 'skill_name';

    public const REACTION_X = 'message_x';

    /**
     * @param $messageId
     * @param IAliceCall $call
     * @param IAliceResponse $response
     *
     * @return void
     */
    public function play($messageId, IAliceCall $call, IAliceResponse &$response): void;

    /**
     * @return array
     */
    public function getSchema(): array;

    /**
     * @return string
     */
    public function getSkillName(): string;

    /**
     * @return IAliceSkill|null
     */
    public function getSkill(): ?IAliceSkill;

    /**
     * @param array $schema
     *
     * @return $this
     */
    public function setSchema(array $schema): IScenario;

    /**
     * @param string $skillName
     *
     * @return $this
     */
    public function setSkillName(string $skillName): IScenario;
}