You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/access_token.rst
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ AccessToken
96
96
:param bool mute: Wether they should be server muted when they join.
97
97
:param bool deaf: Wether they should be server deafend when they join.
98
98
99
-
:returns::class:`dict`
99
+
:returns: dict
100
100
:raises discordoauth2.exceptions.HTTPException: The request failed
101
101
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.join scope or the bot isn't in the guild/have the correct permissions.
102
102
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -111,7 +111,7 @@ AccessToken
111
111
112
112
.. versionadded:: 1.1
113
113
114
-
:returns::class:`dict`
114
+
:returns: dict
115
115
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
116
116
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
117
117
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -126,7 +126,7 @@ AccessToken
126
126
:param str platform_username: Text that appears under the platform name, large, and usally denoting the user's name on the platform.
127
127
:param dict metadata: List of keys and values to set the user's metadata. Supported types: :class:`bool`, :class:`datetime.datetime`, :class:`int`
128
128
129
-
:returns::class:`dict`
129
+
:returns: dict
130
130
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
131
131
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
132
132
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -141,7 +141,7 @@ AccessToken
141
141
142
142
.. versionadded:: 1.1
143
143
144
-
:returns::class:`dict`
144
+
:returns: dict
145
145
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
146
146
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
147
147
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -184,7 +184,7 @@ AccessToken
184
184
185
185
Returns a dictionary with a `user object <https://discord.com/developers/docs/resources/user#user-object-user-structure>`__ which includes ``email`` and ``verified`` (verified email) if the ``email`` scope is provided
186
186
187
-
:returns::class:`dict`
187
+
:returns: dict
188
188
:raises discordoauth2.exceptions.HTTPException: The request failed
189
189
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the identify scope.
190
190
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -193,7 +193,7 @@ AccessToken
193
193
194
194
Returns a list of `connection objects <https://discord.com/developers/docs/resources/user#connection-object-connection-structure>`__
195
195
196
-
:returns::class:`list`
196
+
:returns: list[dict]
197
197
:raises discordoauth2.exceptions.HTTPException: The request failed
198
198
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the connections scope.
199
199
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -203,7 +203,7 @@ AccessToken
203
203
204
204
Returns a list of partial `guild objects <https://discord.com/developers/docs/resources/guild#guild-object>`__
205
205
206
-
:returns::class:`list`
206
+
:returns: list[dict]
207
207
:raises discordoauth2.exceptions.HTTPException: The request failed
208
208
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds scope.
209
209
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -214,7 +214,7 @@ AccessToken
214
214
215
215
:param int guild_id: The guild ID to retrieve member data from.
216
216
217
-
:returns::class:`dict`
217
+
:returns: dict
218
218
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
219
219
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
220
220
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -229,7 +229,7 @@ AccessToken
229
229
:param bool mute: Wether they should be server muted when they join.
230
230
:param bool deaf: Wether they should be server deafend when they join.
231
231
232
-
:returns::class:`dict`
232
+
:returns: dict
233
233
:raises discordoauth2.exceptions.HTTPException: The request failed
234
234
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.join scope or the bot isn't in the guild/have the correct permissions.
235
235
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -240,7 +240,7 @@ AccessToken
240
240
241
241
.. versionadded:: 1.1
242
242
243
-
:returns::class:`dict`
243
+
:returns: dict
244
244
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
245
245
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
246
246
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -255,7 +255,7 @@ AccessToken
255
255
:param str platform_username: Text that appears under the platform name, large, and usally denoting the user's name on the platform.
256
256
:param dict metadata: List of keys and values to set the user's metadata. Supported types: :class:`bool`, :class:`datetime.datetime`, :class:`int`
257
257
258
-
:returns::class:`dict`
258
+
:returns: dict
259
259
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
260
260
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
261
261
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
@@ -270,7 +270,7 @@ AccessToken
270
270
271
271
.. versionadded:: 1.1
272
272
273
-
:returns::class:`dict`
273
+
:returns: dict
274
274
:raises discordoauth2.exceptions.HTTPException: The request failed, possibly because the member is not in the guild.
275
275
:raises discordoauth2.exceptions.Forbidden: The AccessToken doesn't have the guilds.member.read scope.
276
276
:raises discordoauth2.exceptions.RateLimited: You're being rate limited.
Copy file name to clipboardExpand all lines: docs/source/client.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Client
12
12
13
13
.. attribute:: id
14
14
15
-
The application ID
15
+
The application's ID
16
16
17
17
:type: int
18
18
@@ -42,7 +42,7 @@ Client
42
42
43
43
.. method:: refresh_token(refresh_token)
44
44
45
-
Converts a refresh token into a new `AccessToken`. You should store the refresh token and access token, so you can renew the access token when it expires.
45
+
Converts a refresh token into a new :class:`discordoauth2.AccessToken`. You should store the refresh token and access token, so you can renew the access token when it expires.
46
46
47
47
:param str refresh_token: The refresh token, can be found from :attr:`discordoauth2.AccessToken.refresh_token`
48
48
@@ -52,7 +52,7 @@ Client
52
52
53
53
.. method:: client_credentails_grant(scope)
54
54
55
-
Creates an `AccessToken` on behalf of the application's owner.
55
+
Creates an :class:`discordoauth2.AccessToken` on behalf of the application's owner.
56
56
57
57
:param list[str] scope: List of scopes.
58
58
@@ -62,7 +62,7 @@ Client
62
62
63
63
.. warning::
64
64
65
-
If the application is owned by a team, you can only request for the `identify` scope. You can also request `applications.commands.update`, but the library does not support it yet.
65
+
If the application is owned by a team, you can only request for the ``identify`` scope. You can also request ``applications.commands.update`, but the library does not support it yet.``
66
66
67
67
.. method:: revoke_token(token, token_type=None)
68
68
@@ -82,7 +82,7 @@ Client
82
82
83
83
.. versionadded:: 1.1
84
84
85
-
:param dict metadata: Should be a list of `application role connection metadata<https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object>`__
85
+
:param dict metadata: Should be a list of `application role connection metadata<https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object>`__
0 commit comments