diff options
| author | SebbyLaw <[email protected]> | 2020-10-04 05:41:29 -0700 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2020-11-21 21:11:47 -0500 |
| commit | 2e2560126fb924d558c9df3f92162eda4de46323 (patch) | |
| tree | fffc3eee715cf2296b35f903aa3ba3e9e8ecb1c5 /discord/appinfo.py | |
| parent | Translation sync with crowdin (diff) | |
| download | discord.py-2e2560126fb924d558c9df3f92162eda4de46323.tar.xz discord.py-2e2560126fb924d558c9df3f92162eda4de46323.zip | |
Implement icon_rl_as and cover_image_url_as for AppInfo
Diffstat (limited to 'discord/appinfo.py')
| -rw-r--r-- | discord/appinfo.py | 66 |
1 files changed, 64 insertions, 2 deletions
diff --git a/discord/appinfo.py b/discord/appinfo.py index 0a15e1e1..4ff76d39 100644 --- a/discord/appinfo.py +++ b/discord/appinfo.py @@ -131,17 +131,79 @@ class AppInfo: def icon_url(self): """:class:`.Asset`: Retrieves the application's icon asset. + This is equivalent to calling :meth:`icon_url_as` with + the default parameters ('webp' format and a size of 1024). + .. versionadded:: 1.3 """ - return Asset._from_icon(self._state, self, 'app') + return self.icon_url_as() + + def icon_url_as(self, *, format='webp', size=1024): + """Returns an :class:`Asset` for the icon the application has. + + The format must be one of 'webp', 'jpeg', 'jpg' or 'png'. + The size must be a power of 2 between 16 and 4096. + + .. versionadded:: 1.6 + + Parameters + ----------- + format: :class:`str` + The format to attempt to convert the icon to. Defaults to 'webp'. + size: :class:`int` + The size of the image to display. + + Raises + ------ + InvalidArgument + Bad image format passed to ``format`` or invalid ``size``. + + Returns + -------- + :class:`Asset` + The resulting CDN asset. + """ + return Asset._from_icon(self._state, self, 'app', format=format, size=size) + @property def cover_image_url(self): """:class:`.Asset`: Retrieves the cover image on a store embed. + This is equivalent to calling :meth:`cover_image_url_as` with + the default parameters ('webp' format and a size of 1024). + .. versionadded:: 1.3 """ - return Asset._from_cover_image(self._state, self) + return self.cover_image_url_as() + + def cover_image_url_as(self, *, format='webp', size=1024): + """Returns an :class:`Asset` for the image on store embeds + if this application is a game sold on Discord. + + The format must be one of 'webp', 'jpeg', 'jpg' or 'png'. + The size must be a power of 2 between 16 and 4096. + + .. versionadded:: 1.6 + + Parameters + ----------- + format: :class:`str` + The format to attempt to convert the image to. Defaults to 'webp'. + size: :class:`int` + The size of the image to display. + + Raises + ------ + InvalidArgument + Bad image format passed to ``format`` or invalid ``size``. + + Returns + -------- + :class:`Asset` + The resulting CDN asset. + """ + return Asset._from_cover_image(self._state, self, format=format, size=size) @property def guild(self): |