Skip to content

Ready Event

Note

The following classes come from the scurrypy.events.ready_event module.


ReadyEvent dataclass

Bases: Event, DataModel

Received when bot goes online.

v: int instance-attribute

API version number.

user: UserModel instance-attribute

Information about the user.

guilds: list[ReadyGuildModel] instance-attribute

List of guilds bot is in.

session_id: str instance-attribute

Used for resuming connections.

resume_gateway_url: str instance-attribute

Gateway URL for resuming connections.

shard: list[int] instance-attribute

Shard information associated with this session.

application: ApplicationModel instance-attribute

Partial application object. Contains ID and flags.

name: str instance-attribute

Dispatch name of event.

raw: dict instance-attribute

Event's raw JSON payload. NOT A DATACLASS.

to_dict

Recursively turns the dataclass into a dictionary and drops empty fields.

Returns:

  • dict

    serialized dataclasss