Skip to content

hikari.events.shard_events#

Events relating to specific shards events.

ChannelInfo #

Ephemeral information for a channel in a guild.

This is sent as part of a hikari.events.shard_events.ChannelInfoEvent.

channel_id class-attribute instance-attribute #

channel_id: Snowflake = attrs.field(repr=True)

ID of the channel this information is for.

status class-attribute instance-attribute #

status: str | None = attrs.field(repr=True)

The voice channel status.

This will be None if no status is set or the field was not requested.

voice_start_time class-attribute instance-attribute #

voice_start_time: datetime | None = attrs.field(repr=True)

When the ongoing voice session started.

This will be None if there is no ongoing voice session or the field was not requested.

ChannelInfoEvent #

Bases: ShardEvent

Event fired when a channel info payload is received on a gateway shard.

This is sent in response to hikari.api.shard.GatewayShard.request_channel_info.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

channels class-attribute instance-attribute #

channels: Mapping[Snowflake, ChannelInfo] = attrs.field(
    repr=False
)

Mapping of channel IDs to the ephemeral information of the guild's channels.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field(repr=True)

ID of the guild this event is for.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

MemberChunkEvent #

Bases: ShardEvent, Sequence['guilds.Member']

Event fired when a member chunk payload is received on a gateway shard.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

chunk_count class-attribute instance-attribute #

chunk_count: int = attrs.field(repr=True)

Total number of expected chunks for the request this is associated with.

chunk_index class-attribute instance-attribute #

chunk_index: int = attrs.field(repr=True)

Zero-indexed position of this within the queued up chunks for this request.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field(repr=True)

members class-attribute instance-attribute #

members: Mapping[Snowflake, Member] = attrs.field(
    repr=False
)

Mapping of user IDs to the objects of the members in this chunk.

nonce class-attribute instance-attribute #

nonce: str | None = attrs.field(repr=True)

String nonce used to identify the request member chunks are associated with.

This is the nonce value passed while requesting member chunks or None if there was no nonce passed.

not_found class-attribute instance-attribute #

not_found: Sequence[Snowflake] = attrs.field(repr=True)

Sequence of the snowflakes that were not found while making this request.

This is only applicable when user IDs are specified while making the member request the chunk is associated with.

presences class-attribute instance-attribute #

presences: Mapping[Snowflake, MemberPresence] = attrs.field(
    repr=False
)

Mapping of user IDs to found member presence objects.

This will be empty if no presences are found or include_presences is not passed as True while requesting the member chunks.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

RequestGuildMembersRateLimitedEvent #

Bases: ShardRateLimitedEvent

Event fired when requesting guild members is rate limited on a shard.

guild_id class-attribute instance-attribute #

guild_id: Snowflake = attrs.field(repr=True)

ID of the guild members were requested for.

nonce class-attribute instance-attribute #

nonce: str | None = attrs.field(repr=True)

The nonce sent in the request that was rate limited, if any.

ShardConnectedEvent #

Bases: ShardStateEvent

Event fired when a shard successfully connects.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

ShardDisconnectedEvent #

Bases: ShardStateEvent

Event fired when a shard disconnects.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

ShardEvent #

Bases: Event, ABC

Base class for any event that was shard-specific.

shard abstractmethod property #

shard: GatewayShard

Shard that received this event.

ShardPayloadEvent #

Bases: ShardEvent

Event fired for most shard events with their raw payload.

Note

This will only be dispatched for real dispatch events received from Discord and not artificial events like the hikari.events.shard_events.ShardStateEvent events.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

name class-attribute instance-attribute #

name: str = attrs.field()

Name of the received event.

payload class-attribute instance-attribute #

payload: Mapping[str, Any] = attrs.field()

The raw payload for this event.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

ShardRateLimitedEvent #

Bases: ShardEvent

Event fired when a gateway operation is rate limited on a shard.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

meta class-attribute instance-attribute #

meta: Mapping[str, Any] = attrs.field(repr=True)

The raw metadata for the operation that was rate limited.

opcode class-attribute instance-attribute #

opcode: int = attrs.field(repr=True)

Opcode of the gateway operation that was rate limited.

retry_after class-attribute instance-attribute #

retry_after: float = attrs.field(repr=True)

How many seconds to wait before the operation can be retried.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

ShardReadyEvent #

Bases: ShardStateEvent

Event fired when a shard declares it is ready.

actual_gateway_version class-attribute instance-attribute #

actual_gateway_version: int = attrs.field(repr=True)

Actual gateway version being used.

app property #

app: RESTAware

App instance for this application.

application_flags class-attribute instance-attribute #

application_flags: ApplicationFlags = attrs.field(repr=True)

Flags of the application this ready event is for.

application_id class-attribute instance-attribute #

application_id: Snowflake = attrs.field(repr=True)

ID of the application this ready event is for.

my_user class-attribute instance-attribute #

my_user: OwnUser = attrs.field(repr=True)

User for the current bot account this connection is authenticated with.

resume_gateway_url class-attribute instance-attribute #

resume_gateway_url: str = attrs.field(repr=False)

The URL to use to when reconnecting to the gateway.

session_id class-attribute instance-attribute #

session_id: str = attrs.field(repr=True)

ID for this session.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

unavailable_guilds class-attribute instance-attribute #

unavailable_guilds: Sequence[Snowflake] = attrs.field(
    repr=False
)

Sequence of the IDs for all guilds this bot is currently in.

All guilds will start off "unavailable" and should become available after a few seconds of connecting one-by-one.

ShardResumedEvent #

Bases: ShardStateEvent

Event fired when a shard resumes an existing session.

app class-attribute instance-attribute #

app: RESTAware = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

App instance for this application.

shard class-attribute instance-attribute #

shard: GatewayShard = attrs.field(
    metadata={attrs_extensions.SKIP_DEEP_COPY: True}
)

Shard that received this event.

ShardStateEvent #

Bases: ShardEvent, ABC

Base class for any event concerning the state/connectivity of a shard.

This currently wraps connection/disconnection/ready/resumed events only.