pincer.middleware.channel_pins_update

Complexity

Total Complexity

2

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Importance

Changes

0

2 Functions

Rating	Name	Duplication	Size	Complexity
A	channel_pins_update_middleware()	0	21	1
A	export()	0	2	1

# Copyright Pincer 2021-Present
# Full MIT License can be found in `LICENSE` at the project root.

"""sent when a message in pinned/unpinned"""

from ..core.dispatch import GatewayDispatch
from ..objects.events.channel import ChannelPinsUpdateEvent


async def channel_pins_update_middleware(self, payload: GatewayDispatch):

The argument self seems to be unused.

    """|coro|

    Middleware for ``on_channel_pins_update``,

    Parameters
    ----------
    self : :class:`Client`
        The current client/bot.

    payload : :class:`pincer.core.dispatch.GatewayDispatch`
        The data received from the channel pins update event.

    Returns
    -------
    Tuple[:class:`str`, List[:class:`~pincer.objects.guild.channel.Channel`]]
        ``on_channel_pins_update`` and a ``Channel``
    """

    return "on_channel_pins_update", [
        ChannelPinsUpdateEvent.from_dict(payload.data)
    ]


def export():

Missing function or method docstring

    return channel_pins_update_middleware