Total Complexity | 2 |
Total Lines | 46 |
Duplicated Lines | 0 % |
Changes | 0 |
1 | # Copyright Pincer 2021-Present |
||
2 | # Full MIT License can be found in `LICENSE` at the project root. |
||
3 | |||
4 | """ |
||
5 | sent when the user clicks a Rich Presence spectate invite in chat to |
||
6 | spectate a game |
||
7 | """ |
||
8 | |||
9 | from __future__ import annotations |
||
10 | |||
11 | from typing import TYPE_CHECKING |
||
12 | |||
13 | from ..objects.events.activity import ActivitySpectateEvent |
||
14 | from ..utils.types import Coro |
||
15 | |||
16 | if TYPE_CHECKING: |
||
17 | from ..client import Client |
||
18 | from ..core.gateway import Gateway |
||
19 | from ..core.gateway import GatewayDispatch |
||
20 | |||
21 | |||
22 | async def activity_spectate_middleware( |
||
23 | self: Client, gateway: Gateway, payload: GatewayDispatch |
||
24 | ): |
||
25 | """|coro| |
||
26 | |||
27 | Middleware for the ``on_activity_spectate`` event. |
||
28 | |||
29 | Parameters |
||
30 | ---------- |
||
31 | payload : :class:`~pincer.core.gateway.GatewayDispatch` |
||
32 | The data received from the activity spectate event. |
||
33 | gateway : :class:`~pincer.core.gateway.Gateway` |
||
34 | The gateway for the current shard. |
||
35 | |||
36 | Returns |
||
37 | ------- |
||
38 | Tuple[:class:`str`, :class:`~pincer.objects.event.activity.ActivitySpectateEvent`] |
||
39 | ``on_activity_spectate`` and an ``ActivitySpectateEvent`` |
||
40 | """ # noqa: E501 |
||
41 | return "on_activity_spectate", ActivitySpectateEvent.from_dict(payload.data) |
||
42 | |||
43 | |||
44 | def export() -> Coro: |
||
45 | return activity_spectate_middleware |
||
46 |