aboutsummaryrefslogtreecommitdiff
path: root/discord/appinfo.py
diff options
context:
space:
mode:
authorHarmon <[email protected]>2020-01-22 22:55:05 -0600
committerDanny <[email protected]>2020-01-22 23:55:05 -0500
commit6f9793fe5e8090446f7e8fd0d1e0d752cd66fd0f (patch)
tree8df53b1ae373eb4dc0e05c3df4f2c388497e5499 /discord/appinfo.py
parent1.3.0 changelog: fetch_roles fetches roles, not members (diff)
downloaddiscord.py-6f9793fe5e8090446f7e8fd0d1e0d752cd66fd0f.tar.xz
discord.py-6f9793fe5e8090446f7e8fd0d1e0d752cd66fd0f.zip
Fixes and improvements for v1.3 documentation
* Add missing versionadded strings for v1.3 * Add missing versionchanged string for Message.edit * Consistently use versionadded for attributes * Consistently use versionchanged for parameters * Use versionchanged for Bot.is_owner * Fix references in v1.3 changelog * Improve grammar in v1.3 changelog
Diffstat (limited to 'discord/appinfo.py')
-rw-r--r--discord/appinfo.py35
1 files changed, 32 insertions, 3 deletions
diff --git a/discord/appinfo.py b/discord/appinfo.py
index 4b3c9e94..0a15e1e1 100644
--- a/discord/appinfo.py
+++ b/discord/appinfo.py
@@ -44,6 +44,9 @@ class AppInfo:
The application owner.
team: Optional[:class:`Team`]
The application's team.
+
+ .. versionadded:: 1.3
+
icon: Optional[:class:`str`]
The icon hash, if it exists.
description: Optional[:class:`str`]
@@ -59,20 +62,37 @@ class AppInfo:
summary: :class:`str`
If this application is a game sold on Discord,
this field will be the summary field for the store page of its primary SKU
+
+ .. versionadded:: 1.3
+
verify_key: :class:`str`
The base64 encoded key for the GameSDK's GetTicket
+
+ .. versionadded:: 1.3
+
guild_id: Optional[:class:`int`]
If this application is a game sold on Discord,
this field will be the guild to which it has been linked
+
+ .. versionadded:: 1.3
+
primary_sku_id: Optional[:class:`int`]
If this application is a game sold on Discord,
this field will be the id of the "Game SKU" that is created, if exists
+
+ .. versionadded:: 1.3
+
slug: Optional[:class:`str`]
If this application is a game sold on Discord,
this field will be the URL slug that links to the store page
+
+ .. versionadded:: 1.3
+
cover_image: Optional[:class:`str`]
If this application is a game sold on Discord,
this field will be the hash of the image on store embeds
+
+ .. versionadded:: 1.3
"""
__slots__ = ('_state', 'description', 'id', 'name', 'rpc_origins',
'bot_public', 'bot_require_code_grant', 'owner', 'icon',
@@ -109,16 +129,25 @@ class AppInfo:
@property
def icon_url(self):
- """:class:`.Asset`: Retrieves the application's icon asset."""
+ """:class:`.Asset`: Retrieves the application's icon asset.
+
+ .. versionadded:: 1.3
+ """
return Asset._from_icon(self._state, self, 'app')
@property
def cover_image_url(self):
- """:class:`.Asset`: Retrieves the cover image on a store embed."""
+ """:class:`.Asset`: Retrieves the cover image on a store embed.
+
+ .. versionadded:: 1.3
+ """
return Asset._from_cover_image(self._state, self)
@property
def guild(self):
"""Optional[:class:`Guild`]: If this application is a game sold on Discord,
- this field will be the guild to which it has been linked"""
+ this field will be the guild to which it has been linked
+
+ .. versionadded:: 1.3
+ """
return self._state._get_guild(int(self.guild_id))