From 53b48904358866e62c6afec1a548424f12c7e1d1 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Wed, 13 Sep 2017 09:38:05 -0400 Subject: Add category support. This adds: * CategoryChannel, which represents a category * Guild.by_category() which traverses the channels grouping by category * Guild.categories to get a list of categories * abc.GuildChannel.category to get the category a channel belongs to * sync_permissions keyword argument to abc.GuildChannel.edit to sync permissions with a pre-existing or new category * category keyword argument to abc.GuildChannel.edit to move a channel to a category --- docs/api.rst | 7 +++++++ docs/migrating.rst | 4 ++++ 2 files changed, 11 insertions(+) (limited to 'docs') diff --git a/docs/api.rst b/docs/api.rst index 14381d64..5f6245ea 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1912,6 +1912,13 @@ VoiceChannel :members: :inherited-members: +CategoryChannel +~~~~~~~~~~~~~ + +.. autoclass:: CategoryChannel() + :members: + :inherited-members: + DMChannel ~~~~~~~~~ diff --git a/docs/migrating.rst b/docs/migrating.rst index c0434626..57d4f3a6 100644 --- a/docs/migrating.rst +++ b/docs/migrating.rst @@ -366,11 +366,15 @@ They will be enumerated here. **Added** - :class:`Attachment` to represent a discord attachment. +- :class:`CategoryChannel` to represent a channel category. - :attr:`VoiceChannel.members` for fetching members connected to a voice channel. - :attr:`TextChannel.members` for fetching members that can see the channel. - :attr:`Role.members` for fetching members that have the role. - :attr:`Guild.text_channels` for fetching text channels only. - :attr:`Guild.voice_channels` for fetching voice channels only. +- :attr:`Guild.categories` for fetching channel categories only. +- :attr:`TextChannel.category` and :attr:`VoiceChannel.category` to get the category a channel belongs to. +- :meth:`Guild.by_category` to get channels grouped by their category. - :attr:`Guild.chunked` to check member chunking status. - :attr:`Guild.explicit_content_filter` to fetch the content filter. - :attr:`Guild.shard_id` to get a guild's Shard ID if you're sharding. -- cgit v1.2.3