CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-21 18:27:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Core] Dispatch on_red_api_tokens_update event on api keys update (#3146)

Browse Source 
* feat: dispatch `on_red_api_tokens_update` event on api keys update

* docs: add event reference in Shared API Keys docs

* chore(changelog): add tonwcrier entries

* fix: wrap dispatched api tokens in MappingProxyType

* docs: reflect change of type change to read-only Mapping
This commit is contained in:
jack1142
2019-11-23 22:58:35 +01:00
committed by Michael H
parent bc5c2513f6
commit f0836d7182
4 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/framework_apikeys.rst
View File

@@ -46,3 +46,17 @@ Basic Usage
if youtube_keys.get("api_key") is None:
return await ctx.send("The YouTube API key has not been set.")
# Use the API key to access content as you normally would
***************
Event Reference
***************
.. function:: on_red_api_tokens_update(service_name, api_tokens)
Dispatched when service's api keys are updated.
:param service_name: Name of the service.
:type service_name: :class:`str`
:param api_tokens: New Mapping of token names to tokens. This contains api tokens that weren't changed too.
:type api_tokens: Mapping[:class:`str`, :class:`str`]