Add Protocol Urls #103

Merged
Chiggy-Playz merged 17 commits from ProtocolUrls into 2.0 2021-10-27 12:32:50 +00:00
3 changed files with 249 additions and 4 deletions

View File

@ -55,6 +55,7 @@ __all__ = (
"InteractionType",
"InteractionResponseType",
"NSFWLevel",
"ProtocolURL",
)
@ -590,6 +591,74 @@ class NSFWLevel(Enum, comparable=True):
age_restricted = 3
class ProtocolURL(Enum):
# General
home = "discord://-/channels/@me/"
nitro = "discord://-/store"
apps = "discord://-/apps" # Breaks the client on windows (Shows download links for different OS)
guild_discovery = "discord://-/guild-discovery"
guild_create = "discord://-/guilds/create"
guild_invite = "discord://-/invite/{invite_code}"
# Settings
account_settings = "discord://-/settings/account"
profile_settings = "discord://-/settings/profile-customization"
privacy_settings = "discord://-/settings/privacy-and-safety"
safety_settings = "discord://-/settings/privacy-and-safety" # Alias
authorized_apps_settings = "discord://-/settings/authorized-apps"
connections_settings = "discord://-/settings/connections"
nitro_settings = "discord://-/settings/premium" # Same as store, but inside of settings
guild_premium_subscription = "discord://-/settings/premium-guild-subscription"
subscription_settings = "discord://-/settings/subscriptions"
gift_inventory_settings = "discord://-/settings/inventory"
billing_settings = "discord://-/settings/billing"
appearance_settings = "discord://-/settings/appearance"
accessibility_settings = "discord://-/settings/accessibility"
voice_video_settings = "discord://-/settings/voice"
text_images_settings = "discord://-/settings/text"
notifications_settings = "discord://-/settings/notifications"
keybinds_settings = "discord://-/settings/keybinds"
language_settings = "discord://-/settings/locale"
windows_settings = "discord://-/settings/windows" # Doesnt work if used on wrong platform
linux_settings = "discord://-/settings/linux" # Doesnt work if used on wrong platform
streamer_mode_settings = "discord://-/settings/streamer-mode"
advanced_settings = "discord://-/settings/advanced"
activity_status_settings = "discord://-/settings/activity-status"
game_overlay_settings = "discord://-/settings/overlay"
hypesquad_settings = "discord://-/settings/hypesquad-online"
changelogs = "discord://-/settings/changelogs"
# Doesn't work if you don't have it actually activated. Just blank screen.
experiments = "discord://-/settings/experiments"
developer_options = "discord://-/settings/developer-options" # Same as experiments
hotspot_options = "discord://-/settings/hotspot-options" # Same as experiments
# Users, Guilds, and DMs
user_profile = "discord://-/users/{user_id}"
dm_channel = "discord://-/channels/@me/{channel_id}"
dm_message = "discord://-/channels/@me/{channel_id}/{message_id}"
guild_channel = "discord://-/channels/{guild_id}/{channel_id}"
guild_message = "discord://-/channels/{guild_id}/{channel_id}/{message_id}"
guild_membership_screening = "discord://-/member-verification/{guild_id}"
# Library
games_library = "discord://-/library"
library_settings = "discord://-/library/settings"
def __str__(self) -> str:
return self.value
def format(self, **kwargs: Any) -> str:
return self.value.format(**kwargs)
T = TypeVar("T")

View File

@ -24,7 +24,7 @@ DEALINGS IN THE SOFTWARE.
from __future__ import annotations
from typing import Callable, Optional, TYPE_CHECKING, Tuple, Type, TypeVar, Union
from typing import Any, Callable, Optional, TYPE_CHECKING, Tuple, Type, TypeVar, Union
import inspect
import os
@ -60,7 +60,7 @@ class Button(Item[V]):
The ID of the button that gets received during an interaction.
If this button is for a URL, it does not have a custom ID.
url: Optional[:class:`str`]
The URL this button sends you to.
The URL this button sends you to. This param is automatically casted to :class:`str`.
disabled: :class:`bool`
Whether the button is disabled or not.
label: Optional[:class:`str`]
@ -91,7 +91,7 @@ class Button(Item[V]):
label: Optional[str] = None,
disabled: bool = False,
custom_id: Optional[str] = None,
url: Optional[str] = None,
url: Optional[Any] = None,
emoji: Optional[Union[str, Emoji, PartialEmoji]] = None,
row: Optional[int] = None,
):
@ -117,7 +117,7 @@ class Button(Item[V]):
self._underlying = ButtonComponent._raw_construct(
type=ComponentType.button,
custom_id=custom_id,
url=url,
url=str(url) if url else None,
disabled=disabled,
label=label,
style=style,

View File

@ -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
----------------