Events fired for interaction related changes.
# -*- coding: utf-8 -*-
# cython: language_level=3
# Copyright (c) 2020 Nekokatt
# Copyright (c) 2021-present davfsa
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Events fired for interaction related changes."""
from __future__ import annotations
__all__: typing.List[str] = ["InteractionCreateEvent"]
import typing
import attr
from hikari.events import shard_events
from hikari.internal import attr_extensions
if typing.TYPE_CHECKING:
from hikari import traits
from hikari.api import shard as gateway_shard
from hikari.interactions import base_interactions
@attr_extensions.with_copy
@attr.define(kw_only=True, weakref_slot=False)
class InteractionCreateEvent(shard_events.ShardEvent):
"""Event fired when an interaction is created."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
"""Shard that received this event."""
interaction: base_interactions.PartialInteraction = attr.field(repr=True)
"""Interaction that this event is related to.
Returns
-------
hikari.interactions.base_interactions.PartialInteraction
Object of the interaction that this event is related to.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.interaction.app
class InteractionCreateEvent (
*,
shard: gateway_shard.GatewayShard,
interaction: base_interactions.PartialInteraction,
): ...
Event fired when an interaction is created.
Method generated by attrs for class InteractionCreateEvent.
class InteractionCreateEvent(shard_events.ShardEvent):
"""Event fired when an interaction is created."""
shard: gateway_shard.GatewayShard = attr.field(metadata={attr_extensions.SKIP_DEEP_COPY: True})
"""Shard that received this event."""
interaction: base_interactions.PartialInteraction = attr.field(repr=True)
"""Interaction that this event is related to.
Returns
-------
hikari.interactions.base_interactions.PartialInteraction
Object of the interaction that this event is related to.
"""
@property
def app(self) -> traits.RESTAware:
# <<inherited docstring from Event>>.
return self.interaction.app
Base class for any event that was shard-specific.
Base event type that all Hikari events should subclass.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAware
App instance for this application.
RESTAware
property interaction : base_interactions.PartialInteraction
Interaction that this event is related to.
PartialInteraction
property shard : gateway_shard.GatewayShard
Shard that received this event.
def bitmask() -> int: ...
Inherited from:
ShardEvent
.bitmask
Bitmask for this event.
def dispatches() -> Sequence[Type[Event]]: ...
Inherited from:
ShardEvent
.dispatches
Sequence of the event classes this event is dispatched as.