From 65dfc1acd2f603fbe764697af797273e169f1336 Mon Sep 17 00:00:00 2001 From: Chiggy-Playz Date: Sun, 17 Oct 2021 13:34:59 +0530 Subject: [PATCH] Document the ProtocolUrl Enum --- docs/api.rst | 176 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 176 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index e513eb0a..5e135de7 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2656,6 +2656,182 @@ of :class:`enum.Enum`. The guild may contain NSFW content. +.. class:: ProtocolUrl + + Represents the different `discord://` Urls + + .. attribute:: home + + The url for the home page. + + .. attribute:: nitro + + The url for the nitro page. + + .. attribute:: apps + + The url for the downloads page. This breaks the client and needs it to be restarted. + + .. attribute:: guild_discovery + + The url for the server discovery page. + + .. attribute:: new_guild + + The url for the new server modal. + + .. attribute:: guild_invite + + The url for the join server page. Needs to be formatted with `invite_code`. + + .. attribute:: account_settings + + The url for the "My Account" page in settings. + + .. attribute:: profile_settings + + The url for the "User Profile" page in settings. + + .. attribute:: privacy_settings + + The url for the "Privacy & Safety" page in settings. + + .. attribute:: safety_settings + + An alias for :attr:`privacy_settings`. + + .. attribute:: authorized_apps_settings + + The url for the "Authorized Apps" page in settings. + + .. attribute:: connections_settings + + The url for the "Connections" page in settings. + + .. attribute:: nitro_settings + + The url for the "Discord Nitro" page in settings. Same page as :attr:`nitro`, but inside of settings. + + .. attribute:: guild_premium_subscription + + The url for the "Server Boost" page in settings. + + .. attribute:: subscription_settings + + The url for the "Subscriptions" page in settings. + + .. attribute:: gift_inventory_settings + + The url for the "Gift Inventory" page in settings. + + .. attribute:: billing_settings + + The url for the "Billing" page in settings. + + .. attribute:: appearance_settings + + The url for the "Appearance" page in settings. + + .. attribute:: accessibility_settings + + The url for the "Accessibility" page in settings. + + .. attribute:: voice_video_settings + + The url for the "Voice & Video" page in settings. + + .. attribute:: test_images_settings + + The url for the "Text & Images" page in settings. + + .. attribute:: notifications_settings + + The url for the "Notifications" page in settings. + + .. attribute:: keybinds_settings + + The url for the "Keybinds" page in settings. + + .. attribute:: language_settings + + The url for the "Language" page in settings. + + .. attribute:: windows_settings + + The url for the "Windows Settings" page in settings. Leads to a blank screen if used on the wrong platform. + + .. attribute:: linux_settings + + The url for the "Linux Settings" page in settings. Leads to a blank screen if used on the wrong platform. + + .. attribute:: streamer_mode_settings + + The url for the "Streamer Mode" page in settings. + + .. attribute:: advanced_settings + + The url for the "Advanced" page in settings. + + .. attribute:: activity_status_settings + + The url for the "Activity Status" page in settings. + + .. attribute:: game_overlay_settings + + The url for the "Game Overlay" page in settings. + + .. attribute:: hypesquad_settings + + The url for the "Hypesquad" page in settings. + + .. attribute:: changelogs + + The url for the changelogs modal. + + .. attribute:: experiments + + The url for the "Experiments" page in settings. Leads to a blank screen if it isn't activated. + + .. attribute:: developer_options + + The url for the "Developer Options" page in settings. Leads to a blank screen if it isn't activated. + + .. attribute:: hotspot_options + + The url for the "Hotspot Options" page in settings. Leads to a blank screen if it isn't activated. + + .. attribute:: user_profile + + The url for a user's profile modal. Needs to be formatted with `user_id`. + + .. attribute:: dm_channel + + The url for a DM channel. Needs to be formatted with `channel_id`. + + .. attribute:: dm_message + + The url for a message in a DM channel. Needs to be formatted with `channel_id` and `message_id`. + + .. attribute:: guild_channel + + The url for a guild channel. Needs to be formatted with `guild_id` and `channel_id`. + + .. attribute:: guild_message + + The url for a guild channel. Needs to be formatted with `guild_id`, `channel_id` and `message_id`. + + .. attribute:: guild_membership_screening + + The url for a guild's membership screening page. Needs to be formatted with `guild_id`. + + .. attribute:: games_library + + The url for the game library. + + .. attribute:: library_settings + + The url for the library settings. + Async Iterator ----------------