# ServerScheduleEvent events

> 5 FeatherPanel plugin events on ServerScheduleEvent (3 emitted by the core): the event names, the arguments each listener gets, where they fire and a PHP listener for each.

Source: https://featherpanel.com/docs/plugins/events/server-schedule/

Part of the [plugin events reference](https://featherpanel.com/docs/plugins/events/). Listeners get the payload values as positional arguments in the order shown, cannot cancel the action, and must catch their own exceptions. 2 of these events are declared but no code emits them yet; they are marked not emitted.

## Setup

Import `ServerScheduleEvent` in your entry class and register listeners in `processEvents()`:

```php
<?php

namespace App\Addons\myplugin;

use App\App;
use App\Plugins\AppPlugin;
use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\ServerScheduleEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(ServerScheduleEvent::onServerScheduleUpdated(), function ($userUuid, $serverUuid, $scheduleId): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:schedule:updated ' . json_encode(['user_uuid' => $userUuid, 'server_uuid' => $serverUuid, 'schedule_id' => $scheduleId]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}
```

## `ServerScheduleEvent::onServerScheduleCreated()`

- Name: `featherpanel:user:server:schedule:created`
- emitted at 3 sites
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerScheduleEvent.php#L28)

Docblock: string server uuid, array schedule data. (the emitter passes 3 values, see the table)

Same event name as `ServerEvent::onServerScheduleCreated()`. A listener on either method receives the emits of both.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `user_uuid` | `$userUuid` | not declared |
| 2 | `server_uuid` | `$serverUuid` | not declared |
| 3 | `schedule_id` | `$scheduleId` | not declared |

When it fires (3 sites)

-   [`CreateScheduleTool::execute`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Services/Chatbot/Tools/CreateScheduleTool.php#L330)
-   [`ServerScheduleController::createSchedule`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerScheduleController.php#L422)[`POST /api/user/servers/{uuidShort}/schedules`](https://featherpanel.com/docs/api/reference/user/server/schedules/#post-user-servers-uuidShort-schedules)
-   [`ServerScheduleController::importSchedule`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerScheduleController.php#L1332)[`POST /api/user/servers/{uuidShort}/schedules/import`](https://featherpanel.com/docs/api/reference/user/server/schedules/#post-user-servers-uuidShort-schedules-import)

```php
$event->on(ServerScheduleEvent::onServerScheduleCreated(), function ($userUuid, $serverUuid, $scheduleId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:schedule:created');
});
```

## `ServerScheduleEvent::onServerScheduleDeleted()`

- Name: `featherpanel:user:server:schedule:deleted`
- emitted at 2 sites
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerScheduleEvent.php#L44)

Docblock: string server uuid, int schedule id. (the emitter passes 3 values, see the table)

Same event name as `ServerEvent::onServerScheduleDeleted()`. A listener on either method receives the emits of both.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `user_uuid` | `$userUuid` | not declared |
| 2 | `server_uuid` | `$serverUuid` | not declared |
| 3 | `schedule_id` | `$scheduleId` | `int` |

When it fires (2 sites)

-   [`DeleteScheduleTool::execute`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Services/Chatbot/Tools/DeleteScheduleTool.php#L168)
-   [`ServerScheduleController::deleteSchedule`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerScheduleController.php#L786)[`DELETE /api/user/servers/{uuidShort}/schedules/{scheduleId}`](https://featherpanel.com/docs/api/reference/user/server/schedules/#delete-user-servers-uuidShort-schedules-scheduleId)

```php
$event->on(ServerScheduleEvent::onServerScheduleDeleted(), function ($userUuid, $serverUuid, $scheduleId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:schedule:deleted ' . json_encode(['schedule_id' => $scheduleId]));
});
```

## `ServerScheduleEvent::onServerScheduleError()`

- Name: `featherpanel:user:server:schedule:error`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerScheduleEvent.php#L61)

Docblock: string error message, array context.

```php
$event->on(ServerScheduleEvent::onServerScheduleError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:schedule:error ' . json_encode($args));
});
```

No code emits this event yet, so the arguments are unknown. The listener accepts any.

## `ServerScheduleEvent::onServerScheduleTriggered()`

- Name: `featherpanel:user:server:schedule:triggered`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerScheduleEvent.php#L52)

Docblock: string server uuid, int schedule id.

```php
$event->on(ServerScheduleEvent::onServerScheduleTriggered(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:schedule:triggered ' . json_encode($args));
});
```

No code emits this event yet, so the arguments are unknown. The listener accepts any.

## `ServerScheduleEvent::onServerScheduleUpdated()`

- Name: `featherpanel:user:server:schedule:updated`
- emitted at 3 sites
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerScheduleEvent.php#L36)

Docblock: string server uuid, int schedule id, array updated data.

Same event name as `ServerEvent::onServerScheduleUpdated()`. A listener on either method receives the emits of both.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `user_uuid` | `$userUuid` | `string`from docblock |
| 2 | `server_uuid` | `$serverUuid` | `int`from docblock |
| 3 | `schedule_id` | `$scheduleId` | `int` |

When it fires (3 sites)

-   [`UpdateScheduleTool::execute`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Services/Chatbot/Tools/UpdateScheduleTool.php#L216)
-   [`ServerScheduleController::updateSchedule`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerScheduleController.php#L590)[`PUT /api/user/servers/{uuidShort}/schedules/{scheduleId}`](https://featherpanel.com/docs/api/reference/user/server/schedules/#put-user-servers-uuidShort-schedules-scheduleId)
-   [`ServerScheduleController::runNow`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerScheduleController.php#L1036)[`POST /api/user/servers/{uuidShort}/schedules/{scheduleId}/run`](https://featherpanel.com/docs/api/reference/user/server/schedules/#post-user-servers-uuidShort-schedules-scheduleId-run)

```php
$event->on(ServerScheduleEvent::onServerScheduleUpdated(), function ($userUuid, $serverUuid, $scheduleId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:schedule:updated ' . json_encode(['user_uuid' => $userUuid, 'server_uuid' => $serverUuid, 'schedule_id' => $scheduleId]));
});
```