about summary refs log tree commit diff stats
path: root/discord/client.py
diff options
context:
space:
mode:
authorNoah <mounderfod@gmail.com>2022-07-09 19:14:04 +0100
committerNoah <mounderfod@gmail.com>2022-07-09 19:14:04 +0100
commit6576d95f3601613fc03232b106f1cdeda1d99e06 (patch)
treeb9ddd69206b3aa0d84d29847e376780f9f6c0788 /discord/client.py
parentfabbc3ac7a6a39dbb6c44512ec4bf17ac2745126 (diff)
downloaddiscobra-6576d95f3601613fc03232b106f1cdeda1d99e06.tar.gz
docs: Add more documentation where possible.
Diffstat (limited to 'discord/client.py')
-rw-r--r--discord/client.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/discord/client.py b/discord/client.py
index 7ba1f96..fc9bcd5 100644
--- a/discord/client.py
+++ b/discord/client.py
@@ -16,18 +16,32 @@ from .user import User
 
 
 class GatewayEvents(IntEnum):
+    """
+    Contains constants for the gateway opcodes.
+    """
     DISPATCH = 0
+    """An event was dispatched."""
     HEARTBEAT = 1
+    """Sent at regular intervals by the client to keep the gateway connection alive."""
     IDENTIFY = 2
+    """Used to identify yourself with the token during the initial handshake."""
     PRESENCE = 3
+    """Used to update the client's presence."""
     VOICE_STATE = 4
+    """Used to join and leave voice channels."""
     VOICE_PING = 5
     RESUME = 6
+    """Used to resume a disconnected session."""
     RECONNECT = 7
+    """Used to reconnect to the session."""
     REQUEST_MEMBERS = 8
+    """Used to request information about guild members when there are too many for """
     INVALIDATE_SESSION = 9
+    """Means that the session is invalid. When this is received, you must reconnect and re-identify."""
     HELLO = 10
+    """Acknowledgement of gateway connection."""
     HEARTBEAT_ACK = 11
+    """Acknowledgement of gateway heartbeat."""
     GUILD_SYNC = 12