@@ -297,4 +297,58 @@ All events are prefixed with **event_**
297
297
* - Whisper Received
298
298
- :meth: `~eventsub.WhisperReceivedSubscription `
299
299
- message_whisper
300
- - :class: `~models.eventsub_.Whisper `
300
+ - :class: `~models.eventsub_.Whisper `
301
+
302
+
303
+ Client Events
304
+ ~~~~~~~~~~~~~
305
+
306
+ .. py :function :: event_ready() -> None
307
+
308
+ Event dispatched when the :class: `~.Client ` is ready and has completed login.
309
+
310
+ .. py :function :: event_error(payload: twitchio.EventErrorPayload) -> None
311
+
312
+ Event dispatched when an exception is raised inside of a dispatched event.
313
+
314
+ :param twitchio.EventErrorPayload payload: The payload containing information about the event and exception raised.
315
+
316
+ .. py :function :: event_oauth_authorized(payload: twitchio.authentication.UserTokenPayload) -> None
317
+
318
+ Event dispatched when a user authorizes your Client-ID via Twitch OAuth on a built-in web adapter.
319
+
320
+ The default behaviour of this event is to add the authorized token to the client.
321
+ See: :class: `~twitchio.Client.add_token ` for more details.
322
+
323
+ :param UserTokenPayload payload: The payload containing token information.
324
+
325
+
326
+ Commands Events
327
+ ~~~~~~~~~~~~~~~
328
+
329
+ .. py :function :: event_command_invoked(ctx: twitchio.ext.commands.Context) -> None
330
+
331
+ Event dispatched when a :class: `~twitchio.ext.commands.Command ` is invoked.
332
+
333
+ :param twitchio.ext.commands.Context ctx: The context object that invoked the command.
334
+
335
+ .. py :function :: event_command_completed(ctx: twitchio.ext.commands.Context) -> None
336
+
337
+ Event dispatched when a :class: `~twitchio.ext.commands.Command ` has completed invocation.
338
+
339
+ :param twitchio.ext.commands.Context ctx: The context object that invoked the command.
340
+
341
+ .. py :function :: event_command_error(payload: twitchio.ext.commands.CommandErrorPayload) -> None
342
+
343
+ Event dispatched when a :class: `~twitchio.ext.commands.Command ` encounters an error during invocation.
344
+
345
+ :param twitchio.ext.commands.CommandErrorPayload payload: The error payload containing context and the exception raised.
346
+
347
+
348
+ Payloads
349
+ ~~~~~~~~
350
+
351
+ .. attributetable :: twitchio.EventErrorPayload
352
+
353
+ .. autoclass :: twitchio.EventErrorPayload()
354
+ :members:
0 commit comments