<?php
/*
 * MessageGeneratorInterface.php
 * Copyright (c) 2021 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace FireflyIII\Generator\Webhook;

use FireflyIII\User;
use Illuminate\Support\Collection;

/**
 * Interface MessageGeneratorInterface
 */
interface MessageGeneratorInterface
{
    /**
     *
     */
    public function generateMessages(): void;

    /**
     * @return int
     */
    public function getVersion(): int;

    /**
     * @param  Collection  $objects
     */
    public function setObjects(Collection $objects): void;

    /**
     * @param  int  $trigger
     */
    public function setTrigger(int $trigger): void;

    /**
     * @param  User  $user
     */
    public function setUser(User $user): void;

    /**
     * @param  Collection  $webhooks
     * @return void
     */
    public function setWebhooks(Collection $webhooks): void;
}