Application and entities that are used to describe guilds on Discord.
# -*- coding: utf-8 -*-
# cython: language_level=3
# Copyright (c) 2020 Nekokatt
# Copyright (c) 2021-present davfsa
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Application and entities that are used to describe guilds on Discord."""
from __future__ import annotations
__all__: typing.Sequence[str] = (
"Guild",
"RESTGuild",
"GatewayGuild",
"GuildWidget",
"Role",
"GuildFeature",
"GuildSystemChannelFlag",
"GuildMessageNotificationsLevel",
"GuildExplicitContentFilterLevel",
"GuildMFALevel",
"GuildVerificationLevel",
"GuildPremiumTier",
"GuildPreview",
"GuildBan",
"GuildNSFWLevel",
"Member",
"Integration",
"IntegrationAccount",
"IntegrationType",
"IntegrationApplication",
"IntegrationExpireBehaviour",
"PartialApplication",
"PartialGuild",
"PartialIntegration",
"PartialRole",
"WelcomeScreen",
"WelcomeChannel",
)
import typing
import attr
from hikari import channels as channels_
from hikari import snowflakes
from hikari import stickers
from hikari import traits
from hikari import undefined
from hikari import urls
from hikari import users
from hikari.internal import attr_extensions
from hikari.internal import deprecation
from hikari.internal import enums
from hikari.internal import routes
from hikari.internal import time
if typing.TYPE_CHECKING:
import datetime
from hikari import colors
from hikari import colours
from hikari import emojis as emojis_
from hikari import files
from hikari import locales
from hikari import permissions as permissions_
from hikari import presences as presences_
from hikari import voices as voices_
@typing.final
class GuildExplicitContentFilterLevel(int, enums.Enum):
"""Represents the explicit content filter setting for a guild."""
DISABLED = 0
"""No explicit content filter."""
MEMBERS_WITHOUT_ROLES = 1
"""Filter posts from anyone without a role."""
ALL_MEMBERS = 2
"""Filter all posts."""
@typing.final
class GuildFeature(str, enums.Enum):
"""Features that a guild can provide."""
ANIMATED_ICON = "ANIMATED_ICON"
"""Guild has access to set an animated guild icon."""
BANNER = "BANNER"
"""Guild has access to set a guild banner image."""
COMMERCE = "COMMERCE"
"""Guild has access to use commerce features (i.e. create store channels)."""
COMMUNITY = "COMMUNITY"
"""Guild has community features enabled."""
DISCOVERABLE = "DISCOVERABLE"
"""Guild is able to be discovered in the directory.
This also implies the guild can be viewed without joining.
"""
FEATURABLE = "FEATURABLE"
"""Guild is able to be featured in the directory."""
INVITE_SPLASH = "INVITE_SPLASH"
"""Guild has access to set an invite splash background."""
MORE_EMOJI = "MORE_EMOJI"
"""More emojis can be hosted in this guild than normal."""
NEWS = "NEWS"
"""Guild has access to create news channels."""
PARTNERED = "PARTNERED"
"""Guild is partnered."""
RELAY_ENABLED = "RELAY_ENABLED"
"""Guild is using relays.
Relays are new infrastructure designed to handle large guilds more
efficiently server-side.
"""
VANITY_URL = "VANITY_URL"
"""Guild has access to set a vanity URL."""
VERIFIED = "VERIFIED"
"""Guild is verified."""
VIP_REGIONS = "VIP_REGIONS"
"""Guild has access to set 384kbps bitrate in voice.
Previously gave access to VIP voice servers.
"""
WELCOME_SCREEN_ENABLED = "WELCOME_SCREEN_ENABLED"
"""Guild has enabled the welcome screen."""
MEMBER_VERIFICATION_GATE_ENABLED = "MEMBER_VERIFICATION_GATE_ENABLED"
"""Guild has enabled Membership Screening."""
PREVIEW_ENABLED = "PREVIEW_ENABLED"
"""Guild can be viewed before Membership Screening is complete."""
TICKETED_EVENTS_ENABLED = "TICKETED_EVENTS_ENABLED"
"""Guild has enabled ticketed events."""
MONETIZATION_ENABLED = "MONETIZATION_ENABLED"
"""Guild has enabled monetization."""
MORE_STICKERS = "MORE_STICKERS"
"""Guild has an increased custom stickers slots."""
@typing.final
class GuildMessageNotificationsLevel(int, enums.Enum):
"""Represents the default notification level for new messages in a guild."""
ALL_MESSAGES = 0
"""Notify users when any message is sent."""
ONLY_MENTIONS = 1
"""Only notify users when they are @mentioned."""
@typing.final
class GuildMFALevel(int, enums.Enum):
"""Represents the multi-factor authorization requirement for a guild."""
NONE = 0
"""No MFA requirement."""
ELEVATED = 1
"""MFA requirement."""
@typing.final
class GuildPremiumTier(int, enums.Enum):
"""Tier for Discord Nitro boosting in a guild."""
NONE = 0
"""No Nitro boost level."""
TIER_1 = 1
"""Level 1 Nitro boost."""
TIER_2 = 2
"""Level 2 Nitro boost."""
TIER_3 = 3
"""Level 3 Nitro boost."""
@typing.final
class GuildSystemChannelFlag(enums.Flag):
"""Defines which features are suppressed in the system channel."""
NONE = 0
"""Nothing is suppressed."""
SUPPRESS_USER_JOIN = 1 << 0
"""Suppress displaying a message about new users joining."""
SUPPRESS_PREMIUM_SUBSCRIPTION = 1 << 1
"""Suppress displaying a message when the guild is Nitro boosted."""
SUPPRESS_GUILD_REMINDER = 1 << 2
"""Suppress displaying messages with guild setup tips."""
SUPPRESS_USER_JOIN_REPLIES = 1 << 3
"""Suppress displaying a reply button on join notifications."""
@typing.final
class GuildVerificationLevel(int, enums.Enum):
"""Represents the level of verification of a guild."""
NONE = 0
"""Unrestricted."""
LOW = 1
"""Must have a verified email on their account."""
MEDIUM = 2
"""Must have been registered on Discord for more than 5 minutes."""
HIGH = 3
"""Must also be a member of the guild for longer than 10 minutes."""
VERY_HIGH = 4
"""Must have a verified phone number."""
@typing.final
class GuildNSFWLevel(int, enums.Enum):
"""Represents the NSFW level of a guild."""
DEFAULT = 0
"""Guild has not been categorized yet."""
EXPLICIT = 1
"""Guild contains explicit NSFW content."""
SAFE = 2
"""Guild is safe of NSFW content."""
AGE_RESTRICTED = 3
"""Guild may contain NSFW content."""
@attr_extensions.with_copy
@attr.define(hash=False, kw_only=True, weakref_slot=False)
class GuildWidget:
"""Represents a guild widget."""
app: traits.RESTAware = attr.field(
repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
)
"""The client application that models may use for procedures."""
channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(repr=True)
"""The ID of the channel the invite for this embed targets, if enabled."""
is_enabled: bool = attr.field(repr=True)
"""Whether this embed is enabled."""
async def fetch_channel(self) -> typing.Optional[channels_.GuildChannel]:
"""Fetch the widget channel.
This will be `builtins.None` if not set.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The requested channel.
You can check the type of the channel by
using `builtins.isinstance`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.channel_id:
return None
widget_channel = await self.app.rest.fetch_channel(self.channel_id)
assert isinstance(widget_channel, channels_.GuildChannel)
return widget_channel
@attr_extensions.with_copy
@attr.define(eq=False, hash=False, kw_only=True, weakref_slot=False)
class Member(users.User):
"""Used to represent a guild bound member."""
guild_id: snowflakes.Snowflake = attr.field(repr=True)
"""The ID of the guild this member belongs to."""
is_deaf: undefined.UndefinedOr[bool] = attr.field(repr=False)
"""`builtins.True` if this member is deafened in the current voice channel.
This will be `hikari.undefined.UNDEFINED` if it's state is
unknown.
"""
is_mute: undefined.UndefinedOr[bool] = attr.field(repr=False)
"""`builtins.True` if this member is muted in the current voice channel.
This will be `hikari.undefined.UNDEFINED` if it's state is unknown.
"""
is_pending: undefined.UndefinedOr[bool] = attr.field(repr=False)
"""Whether the user has passed the guild's membership screening requirements.
This will be `hikari.undefined.UNDEFINED` if it's state is unknown.
"""
joined_at: datetime.datetime = attr.field(repr=True)
"""The datetime of when this member joined the guild they belong to."""
nickname: typing.Optional[str] = attr.field(repr=True)
"""This member's nickname.
This will be `builtins.None` if not set.
"""
premium_since: typing.Optional[datetime.datetime] = attr.field(repr=False)
"""The datetime of when this member started "boosting" this guild.
Will be `builtins.None` if the member is not a premium user.
"""
raw_communication_disabled_until: typing.Optional[datetime.datetime] = attr.field(repr=False)
"""The datetime when this member's timeout will expire.
Will be `builtins.None` if the member is not timed out.
!!! note
The datetime might be in the past, so it is recommended to use
`communication_disabled_until` method to check if the member is timed
out at the time of the call.
"""
role_ids: typing.Sequence[snowflakes.Snowflake] = attr.field(repr=False)
"""A sequence of the IDs of the member's current roles."""
# This is technically optional, since UPDATE MEMBER and MESSAGE CREATE
# events do not inject the user into the member payload, but specify it
# separately. However, to get around this inconsistency, we force the
# entity factory to always provide the user object in these cases, so we
# can assume this is always set, and thus we are always able to get info
# such as the ID of the user this member represents.
user: users.User = attr.field(repr=True)
"""This member's corresponding user object."""
guild_avatar_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""Hash of the member's guild avatar guild if set, else `builtins.None`.
!!! note
This takes precedence over `Member.avatar_hash`.
"""
@property
def app(self) -> traits.RESTAware:
"""Return the app that is bound to the user object."""
return self.user.app
@property
def avatar_hash(self) -> typing.Optional[str]:
return self.user.avatar_hash
@property
def avatar_url(self) -> typing.Optional[files.URL]:
return self.user.avatar_url
@property
def guild_avatar_url(self) -> typing.Optional[files.URL]:
"""Guild Avatar URL for the user, if they have one set.
May be `builtins.None` if no guild avatar is set. In this case, you
should use `avatar_hash` or `default_avatar_url` instead.
"""
return self.make_guild_avatar_url()
@property
def default_avatar_url(self) -> files.URL:
return self.user.default_avatar_url
@property
def display_avatar_url(self) -> files.URL:
return self.make_guild_avatar_url() or super().display_avatar_url
@property
def banner_hash(self) -> typing.Optional[str]:
return self.user.banner_hash
@property
def banner_url(self) -> typing.Optional[files.URL]:
return self.user.banner_url
@property
def accent_color(self) -> typing.Optional[colors.Color]:
return self.user.accent_color
@property
def discriminator(self) -> str:
return self.user.discriminator
@property
def display_name(self) -> str:
"""Return the member's display name.
If the member has a nickname, this will return that nickname.
Otherwise, it will return the username instead.
Returns
-------
builtins.str
The member display name.
See Also
--------
Nickname: `Member.nickname`
Username: `Member.username`
"""
return self.nickname if isinstance(self.nickname, str) else self.username
@property
def flags(self) -> users.UserFlag:
return self.user.flags
@property
def id(self) -> snowflakes.Snowflake:
return self.user.id
@property
def is_bot(self) -> bool:
return self.user.is_bot
@property
def is_system(self) -> bool:
return self.user.is_system
@property
def mention(self) -> str:
return self.user.mention
def communication_disabled_until(self) -> typing.Optional[datetime.datetime]:
"""Return when the timeout for this member ends.
Unlike `raw_communication_disabled_until`, this will always be
`builtins.None` if the member is not currently timed out.
!!! note
The output of this function can depend based on when
the function is called.
"""
if (
self.raw_communication_disabled_until is not None
and self.raw_communication_disabled_until > time.utc_datetime()
):
return self.raw_communication_disabled_until
return None
def get_guild(self) -> typing.Optional[Guild]:
"""Return the guild associated with this member.
Returns
-------
typing.Optional[hikari.guilds.Guild]
The linked guild object or `builtins.None` if it's not cached.
"""
if not isinstance(self.user.app, traits.CacheAware):
return None
return self.user.app.cache.get_guild(self.guild_id)
def get_presence(self) -> typing.Optional[presences_.MemberPresence]:
"""Get the cached presence for this member, if known.
Presence info includes user status and activities.
This requires the `GUILD_PRESENCES` intent to be enabled.
Returns
-------
typing.Optional[hikari.presences.MemberPresence]
The member presence, or `builtins.None` if not known.
"""
if not isinstance(self.user.app, traits.CacheAware):
return None
return self.user.app.cache.get_presence(self.guild_id, self.user.id)
def get_roles(self) -> typing.Sequence[Role]:
"""Return the roles the user has.
This will be empty if the roles are missing from the cache.
Returns
-------
typing.Sequence[hikari.guilds.Role]
The roles the users has.
"""
roles: typing.List[Role] = []
if not isinstance(self.user.app, traits.CacheAware):
return roles
for role_id in self.role_ids:
if role := self.user.app.cache.get_role(role_id):
roles.append(role)
return roles
def get_top_role(self) -> typing.Optional[Role]:
"""Return the highest role the member has.
Returns
-------
typing.Optional[hikari.guilds.Role]
`builtins.None` if the cache is missing the roles information or
the highest role the user has.
"""
roles = sorted(self.get_roles(), key=lambda r: r.position, reverse=True)
try:
return next(iter(roles))
except StopIteration:
return None
@property
def username(self) -> str:
return self.user.username
def make_avatar_url(self, *, ext: typing.Optional[str] = None, size: int = 4096) -> typing.Optional[files.URL]:
return self.user.make_avatar_url(ext=ext, size=size)
def make_guild_avatar_url(
self, *, ext: typing.Optional[str] = None, size: int = 4096
) -> typing.Optional[files.URL]:
"""Generate the guild specific avatar url for this member, if set.
If no guild avatar is set, this returns `builtins.None`. You can then
use the `make_avatar_url` to get their global custom avatar or
`default_avatar_url` if they have no custom avatar set.
Parameters
----------
ext : typing.Optional[builtins.str]
The ext to use for this URL, defaults to `png` or `gif`.
Supports `png`, `jpeg`, `jpg`, `webp` and `gif` (when
animated). Will be ignored for default avatars which can only be
`png`.
If `builtins.None`, then the correct default extension is
determined based on whether the icon is animated or not.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Will be ignored for default avatars.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the avatar, or `builtins.None` if not present.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.guild_avatar_hash is None:
return None
if ext is None:
if self.guild_avatar_hash.startswith("a_"):
ext = "gif"
else:
ext = "png"
return routes.CDN_MEMBER_AVATAR.compile_to_file(
urls.CDN_URL,
guild_id=self.guild_id,
user_id=self.id,
hash=self.guild_avatar_hash,
size=size,
file_format=ext,
)
async def fetch_self(self) -> Member:
"""Fetch an up-to-date view of this member from the API.
Returns
-------
hikari.guilds.Member
An up-to-date view of this member.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the member is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.user.app.rest.fetch_member(self.guild_id, self.user.id)
async def fetch_dm_channel(self) -> channels_.DMChannel:
return await self.user.fetch_dm_channel()
async def fetch_roles(self) -> typing.Sequence[Role]:
"""Fetch an up-to-date view of this member's roles from the API.
Returns
-------
typing.Sequence[hikari.guilds.Role]
An up-to-date view of this member's roles.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the member is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
fetched_roles = await self.app.rest.fetch_roles(self.guild_id)
return [role for role in fetched_roles if role.id in self.role_ids]
async def ban(
self,
*,
delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Ban this member from this guild.
Other Parameters
----------------
delete_message_days : hikari.undefined.UndefinedNoneOr[builtins.int]
If provided, the number of days to delete messages for.
This must be between 0 and 7.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.ban_user(
self.guild_id, self.user.id, delete_message_days=delete_message_days, reason=reason
)
async def unban(
self,
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Unban this member from the guild.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.unban_user(self.guild_id, self.user.id, reason=reason)
async def kick(
self,
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Kick this member from this guild.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `KICK_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.kick_user(self.guild_id, self.user.id, reason=reason)
async def add_role(
self, role: snowflakes.SnowflakeishOr[PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED
) -> None:
"""Add a role to the member.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]
The role to add. This may be the object or the
ID of an existing role.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.ForbiddenError
If you are missing the `MANAGE_ROLES` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild, user or role are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.add_role_to_member(self.guild_id, self.user.id, role, reason=reason)
async def remove_role(
self, role: snowflakes.SnowflakeishOr[PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED
) -> None:
"""Remove a role from the member.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]
The role to remove. This may be the object or the
ID of an existing role.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.ForbiddenError
If you are missing the `MANAGE_ROLES` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild, user or role are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.remove_role_from_member(self.guild_id, self.user.id, role, reason=reason)
async def edit(
self,
*,
nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED,
nick: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED,
roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[PartialRole]] = undefined.UNDEFINED,
mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
voice_channel: undefined.UndefinedNoneOr[
snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]
] = undefined.UNDEFINED,
communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> Member:
"""Edit the member.
Other Parameters
----------------
nickname : hikari.undefined.UndefinedNoneOr[builtins.str]
If provided, the new nick for the member. If `builtins.None`,
will remove the members nick.
Requires the `MANAGE_NICKNAMES` permission.
nick : hikari.undefined.UndefinedNoneOr[builtins.str]
Deprecated alias for `nickname`.
roles : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]
If provided, the new roles for the member.
Requires the `MANAGE_ROLES` permission.
mute : hikari.undefined.UndefinedOr[builtins.bool]
If provided, the new server mute state for the member.
Requires the `MUTE_MEMBERS` permission.
deaf : hikari.undefined.UndefinedOr[builtins.bool]
If provided, the new server deaf state for the member.
Requires the `DEAFEN_MEMBERS` permission.
voice_channel : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]]
If provided, `builtins.None` or the object or the ID of
an existing voice channel to move the member to.
If `builtins.None`, will disconnect the member from voice.
Requires the `MOVE_MEMBERS` permission and the `CONNECT`
permission in the original voice channel and the target
voice channel.
!!! note
If the member is not in a voice channel, this will
take no effect.
communication_disabled_until : hikari.undefined.UndefinedNoneOr[datetime.datetime]
If provided, the datetime when the timeout (disable communication)
of the member expires, up to 28 days in the future, or `builtins.None`
to remove the timeout from the member.
Requires the `MODERATE_MEMBERS` permission.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.guilds.Member
Object of the member that was updated.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing a permission to do an action.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or the user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if nick is not undefined.UNDEFINED:
deprecation.warn_deprecated("nick", alternative="nickname")
nickname = nick
return await self.user.app.rest.edit_member(
self.guild_id,
self.user.id,
nickname=nickname,
roles=roles,
mute=mute,
deaf=deaf,
voice_channel=voice_channel,
communication_disabled_until=communication_disabled_until,
reason=reason,
)
def __str__(self) -> str:
return str(self.user)
def __hash__(self) -> int:
return hash(self.user)
def __eq__(self, other: object) -> bool:
return self.user == other
@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class PartialRole(snowflakes.Unique):
"""Represents a partial guild bound Role object."""
app: traits.RESTAware = attr.field(
repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
)
"""The client application that models may use for procedures."""
id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
"""The ID of this entity."""
name: str = attr.field(eq=False, hash=False, repr=True)
"""The role's name."""
@property
def mention(self) -> str:
"""Return a raw mention string for the role.
Returns
-------
builtins.str
The mention string to use.
"""
return f"<@&{self.id}>"
def __str__(self) -> str:
return self.name
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class Role(PartialRole):
"""Represents a guild bound Role object."""
color: colors.Color = attr.field(eq=False, hash=False, repr=True)
"""The colour of this role.
This will be applied to a member's name in chat if it's their top coloured role.
"""
guild_id: snowflakes.Snowflake = attr.field(eq=False, hash=False, repr=True)
"""The ID of the guild this role belongs to"""
is_hoisted: bool = attr.field(eq=False, hash=False, repr=True)
"""Whether this role is hoisting the members it's attached to in the member list.
members will be hoisted under their highest role where this is set to `builtins.True`.
"""
icon_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""Hash of the role's icon if set, else `builtins.None`."""
unicode_emoji: typing.Optional[emojis_.UnicodeEmoji] = attr.field(eq=False, hash=False, repr=False)
"""Role's icon as an unicode emoji if set, else `builtins.None`."""
is_managed: bool = attr.field(eq=False, hash=False, repr=False)
"""Whether this role is managed by an integration."""
is_mentionable: bool = attr.field(eq=False, hash=False, repr=False)
"""Whether this role can be mentioned by all regardless of permissions."""
permissions: permissions_.Permissions = attr.field(eq=False, hash=False, repr=False)
"""The guild wide permissions this role gives to the members it's attached to,
This may be overridden by channel overwrites.
"""
position: int = attr.field(eq=False, hash=False, repr=True)
"""The position of this role in the role hierarchy.
This will start at `0` for the lowest role (@everyone)
and increase as you go up the hierarchy.
"""
bot_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=True)
"""The ID of the bot this role belongs to.
If `builtins.None`, this is not a bot role.
"""
integration_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=True)
"""The ID of the integration this role belongs to.
If `builtins.None`, this is not a integration role.
"""
is_premium_subscriber_role: bool = attr.field(eq=False, hash=False, repr=True)
"""Whether this role is the guild's nitro subscriber role."""
@property
def colour(self) -> colours.Colour:
"""Alias for the `color` field."""
return self.color
@property
def icon_url(self) -> typing.Optional[files.URL]:
"""Role icon URL, if there is one.
Returns
-------
typing.Optional[hikari.files.URL]
The URL, or `builtins.None` if no icon exists.
"""
return self.make_icon_url()
def make_icon_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the icon URL for this role, if set.
If no role icon is set, this returns `builtins.None`.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the icon, or `builtins.None` if not present.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.icon_hash is None:
return None
return routes.CDN_ROLE_ICON.compile_to_file(
urls.CDN_URL,
role_id=self.id,
hash=self.icon_hash,
size=size,
file_format=ext,
)
@typing.final
class IntegrationType(str, enums.Enum):
"""The integration type."""
TWITCH = "twitch"
YOUTUBE = "youtube"
DISCORD_BOT = "discord"
@typing.final
class IntegrationExpireBehaviour(int, enums.Enum):
"""Behavior for expiring integration subscribers."""
REMOVE_ROLE = 0
"""Remove the role."""
KICK = 1
"""Kick the subscriber."""
@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class IntegrationAccount:
"""An account that's linked to an integration."""
id: str = attr.field(hash=True, repr=True)
"""The string ID of this (likely) third party account."""
name: str = attr.field(eq=False, hash=False, repr=True)
"""The name of this account."""
def __str__(self) -> str:
return self.name
# This is here rather than in applications.py to avoid circular imports
@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class PartialApplication(snowflakes.Unique):
"""A partial representation of a Discord application."""
id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
"""The ID of this entity."""
name: str = attr.field(eq=False, hash=False, repr=True)
"""The name of this application."""
description: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The description of this application, if any."""
icon_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The CDN hash of this application's icon, if set."""
def __str__(self) -> str:
return self.name
@property
def icon_url(self) -> typing.Optional[files.URL]:
"""Team icon URL, if there is one.
Returns
-------
typing.Optional[hikari.files.URL]
The URL, or `builtins.None` if no icon exists.
"""
return self.make_icon_url()
def make_icon_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the icon URL for this application.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL, or `builtins.None` if no icon exists.
Raises
------
builtins.ValueError
If the size is not an integer power of 2 between 16 and 4096
(inclusive).
"""
if self.icon_hash is None:
return None
return routes.CDN_APPLICATION_ICON.compile_to_file(
urls.CDN_URL,
application_id=self.id,
hash=self.icon_hash,
size=size,
file_format=ext,
)
@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class IntegrationApplication(PartialApplication):
"""An application that's linked to an integration."""
bot: typing.Optional[users.User] = attr.field(eq=False, hash=False, repr=False)
"""The bot associated with this application."""
@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class PartialIntegration(snowflakes.Unique):
"""A partial representation of an integration, found in audit logs."""
account: IntegrationAccount = attr.field(eq=False, hash=False, repr=False)
"""The account connected to this integration."""
id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
"""The ID of this entity."""
name: str = attr.field(eq=False, hash=False, repr=True)
"""The name of this integration."""
type: typing.Union[IntegrationType, str] = attr.field(eq=False, hash=False, repr=True)
"""The type of this integration."""
def __str__(self) -> str:
return self.name
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class Integration(PartialIntegration):
"""Represents a guild integration object."""
guild_id: snowflakes.Snowflake = attr.field()
"""The ID of the guild this integration belongs to."""
expire_behavior: typing.Union[IntegrationExpireBehaviour, int, None] = attr.field(eq=False, hash=False, repr=False)
"""How members should be treated after their connected subscription expires.
This will not be enacted until after `GuildIntegration.expire_grace_period`
passes.
!!! note
This will always be `builtins.None` for Discord integrations.
"""
expire_grace_period: typing.Optional[datetime.timedelta] = attr.field(eq=False, hash=False, repr=False)
"""How many days users with expired subscriptions are given until
`GuildIntegration.expire_behavior` is enacted out on them.
!!! note
This will always be `builtins.None` for Discord integrations.
"""
is_enabled: bool = attr.field(eq=False, hash=False, repr=True)
"""Whether this integration is enabled."""
is_syncing: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether this integration is syncing subscribers/emojis."""
is_emojis_enabled: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether users under this integration are allowed to use it's custom emojis."""
is_revoked: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether the integration has been revoked."""
last_synced_at: typing.Optional[datetime.datetime] = attr.field(eq=False, hash=False, repr=False)
"""The datetime of when this integration's subscribers were last synced."""
role_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the managed role used for this integration's subscribers."""
user: typing.Optional[users.User] = attr.field(eq=False, hash=False, repr=False)
"""The user this integration belongs to."""
subscriber_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The number of subscribers this integration has."""
application: typing.Optional[IntegrationApplication] = attr.field(eq=False, hash=False, repr=False)
"""The bot/OAuth2 application associated with this integration.
!!! note
This is only available for Discord integrations.
"""
@attr_extensions.with_copy
@attr.define(hash=False, weakref_slot=False)
class WelcomeChannel:
"""Used to represent channels on guild welcome screens."""
channel_id: snowflakes.Snowflake = attr.field(hash=False, repr=True)
"""ID of the channel shown in the welcome screen."""
description: str = attr.field(hash=False, repr=False)
"""The description shown for this channel."""
emoji_name: typing.Union[str, emojis_.UnicodeEmoji, None] = attr.field(
default=None, kw_only=True, hash=False, repr=True
)
"""The emoji shown in the welcome screen channel if set to a unicode emoji.
!!! warning
While it may also be present for custom emojis, this is neither guaranteed
to be provided nor accurate.
"""
emoji_id: typing.Optional[snowflakes.Snowflake] = attr.field(default=None, kw_only=True, hash=False, repr=True)
"""ID of the emoji shown in the welcome screen channel if it's set to a custom emoji."""
@attr_extensions.with_copy
@attr.define(hash=False, kw_only=True, weakref_slot=False)
class WelcomeScreen:
"""Used to represent guild welcome screens on Discord."""
description: typing.Optional[str] = attr.field(hash=False, repr=True)
"""The guild's description shown in the welcome screen."""
channels: typing.Sequence[WelcomeChannel] = attr.field(hash=False, repr=True)
"""An array of up to 5 of the channels shown in the welcome screen."""
@attr_extensions.with_copy
@attr.define(hash=False, kw_only=True, weakref_slot=False)
class GuildBan:
"""Used to represent guild bans."""
reason: typing.Optional[str] = attr.field(repr=True)
"""The reason for this ban, will be `builtins.None` if no reason was given."""
user: users.User = attr.field(repr=True)
"""The object of the user this ban targets."""
@attr_extensions.with_copy
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class PartialGuild(snowflakes.Unique):
"""Base object for any partial guild objects."""
app: traits.RESTAware = attr.field(
repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
)
"""The client application that models may use for procedures."""
id: snowflakes.Snowflake = attr.field(hash=True, repr=True)
"""The ID of this entity."""
icon_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash for the guild icon, if there is one."""
name: str = attr.field(eq=False, hash=False, repr=True)
"""The name of the guild."""
def __str__(self) -> str:
return self.name
@property
def icon_url(self) -> typing.Optional[files.URL]:
"""Icon URL for the guild, if set; otherwise `builtins.None`."""
return self.make_icon_url()
@property
def shard_id(self) -> typing.Optional[int]:
"""Return the ID of the shard this guild is served by.
This may return `None` if the application does not have a gateway
connection.
"""
if not isinstance(self.app, traits.ShardAware):
return None
shard_count = self.app.shard_count
assert isinstance(shard_count, int)
return snowflakes.calculate_shard_id(shard_count, self.id)
def make_icon_url(self, *, ext: typing.Optional[str] = None, size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's icon URL, if set.
Parameters
----------
ext : typing.Optional[builtins.str]
The extension to use for this URL, defaults to `png` or `gif`.
Supports `png`, `jpeg`, `jpg`, `webp` and `gif` (when
animated).
If `builtins.None`, then the correct default extension is
determined based on whether the icon is animated or not.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the resource, or `builtins.None` if no icon is set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.icon_hash is None:
return None
if ext is None:
if self.icon_hash.startswith("a_"):
ext = "gif"
else:
ext = "png"
return routes.CDN_GUILD_ICON.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.icon_hash,
size=size,
file_format=ext,
)
async def ban(
self,
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Ban the given user from this guild.
Parameters
----------
user: hikari.snowflakes.Snowflakeish[hikari.users.PartialUser]
The user to ban from the guild
Other Parameters
----------------
delete_message_days : hikari.undefined.UndefinedNoneOr[builtins.int]
If provided, the number of days to delete messages for.
This must be between 0 and 7.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.app.rest.ban_user(self.id, user, delete_message_days=delete_message_days, reason=reason)
async def unban(
self,
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Unban the given user from this guild.
Parameters
----------
user: hikari.snowflakes.Snowflakeish[hikari.users.PartialUser]
The user to unban from the guild
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.app.rest.unban_user(self.id, user, reason=reason)
async def kick(
self,
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Kicks the given user from this guild.
Parameters
----------
user: hikari.snowflakes.Snowflakeish[hikari.users.PartialUser]
The user to kick from the guild
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `KICK_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.app.rest.kick_user(self.id, user, reason=reason)
async def edit(
self,
*,
name: undefined.UndefinedOr[str] = undefined.UNDEFINED,
verification_level: undefined.UndefinedOr[GuildVerificationLevel] = undefined.UNDEFINED,
default_message_notifications: undefined.UndefinedOr[GuildMessageNotificationsLevel] = undefined.UNDEFINED,
explicit_content_filter_level: undefined.UndefinedOr[GuildExplicitContentFilterLevel] = undefined.UNDEFINED,
afk_channel: undefined.UndefinedOr[
snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]
] = undefined.UNDEFINED,
afk_timeout: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED,
icon: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED,
owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = undefined.UNDEFINED,
splash: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED,
banner: undefined.UndefinedNoneOr[files.Resourceish] = undefined.UNDEFINED,
system_channel: undefined.UndefinedNoneOr[
snowflakes.SnowflakeishOr[channels_.GuildTextChannel]
] = undefined.UNDEFINED,
rules_channel: undefined.UndefinedNoneOr[
snowflakes.SnowflakeishOr[channels_.GuildTextChannel]
] = undefined.UNDEFINED,
public_updates_channel: undefined.UndefinedNoneOr[
snowflakes.SnowflakeishOr[channels_.GuildTextChannel]
] = undefined.UNDEFINED,
preferred_locale: undefined.UndefinedOr[typing.Union[str, locales.Locale]] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> RESTGuild:
"""Edits the guild.
Parameters
----------
name : hikari.undefined.UndefinedOr[builtins.str]
If provided, the new name for the guild.
verification_level : hikari.undefined.UndefinedOr[hikari.guilds.GuildVerificationLevel]
If provided, the new verification level.
default_message_notifications : hikari.undefined.UndefinedOr[hikari.guilds.GuildMessageNotificationsLevel]
If provided, the new default message notifications level.
explicit_content_filter_level : hikari.undefined.UndefinedOr[hikari.guilds.GuildExplicitContentFilterLevel]
If provided, the new explicit content filter level.
afk_channel : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]
If provided, the new afk channel. Requires `afk_timeout` to
be set to work.
afk_timeout : hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]
If provided, the new afk timeout.
icon : hikari.undefined.UndefinedOr[hikari.files.Resourceish]
If provided, the new guild icon. Must be a 1024x1024 image or can be
an animated gif when the guild has the `ANIMATED_ICON` feature.
owner : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]]]
If provided, the new guild owner.
!!! warning
You need to be the owner of the server to use this.
splash : hikari.undefined.UndefinedNoneOr[hikari.files.Resourceish]
If provided, the new guild splash. Must be a 16:9 image and the
guild must have the `INVITE_SPLASH` feature.
banner : hikari.undefined.UndefinedNoneOr[hikari.files.Resourceish]
If provided, the new guild banner. Must be a 16:9 image and the
guild must have the `BANNER` feature.
system_channel : hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildTextChannel]]
If provided, the new system channel.
rules_channel : hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildTextChannel]]
If provided, the new rules channel.
public_updates_channel : hikari.undefined.UndefinedNoneOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildTextChannel]]
If provided, the new public updates channel.
preferred_locale : hikari.undefined.UndefinedNoneOr[builtins.str]
If provided, the new preferred locale.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.guilds.RESTGuild
The edited guild.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value. Or
you are missing the
hikari.errors.ForbiddenError
If you are missing the `MANAGE_GUILD` permission or if you tried to
pass ownership without being the server owner.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
""" # noqa: E501 - Line too long
return await self.app.rest.edit_guild(
self.id,
name=name,
verification_level=verification_level,
default_message_notifications=default_message_notifications,
explicit_content_filter_level=explicit_content_filter_level,
afk_channel=afk_channel,
afk_timeout=afk_timeout,
icon=icon,
owner=owner,
splash=splash,
banner=banner,
system_channel=system_channel,
rules_channel=rules_channel,
public_updates_channel=public_updates_channel,
preferred_locale=preferred_locale,
reason=reason,
)
async def fetch_emojis(self) -> typing.Sequence[emojis_.KnownCustomEmoji]:
"""Fetch the emojis of the guild.
Returns
-------
typing.Sequence[hikari.emojis.KnownCustomEmoji]
The requested emojis.
Raises
------
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_guild_emojis(self.id)
async def fetch_emoji(self, emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji]) -> emojis_.KnownCustomEmoji:
"""Fetch an emoji from the guild.
Parameters
----------
emoji : hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]
The emoji to fetch. This can be a `hikari.emojis.CustomEmoji`
or the ID of an existing emoji.
Returns
-------
hikari.emojis.KnownCustomEmoji
The requested emoji.
Raises
------
hikari.errors.NotFoundError
If the guild or the emoji are not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_emoji(self.id, emoji)
async def fetch_stickers(self) -> typing.Sequence[stickers.GuildSticker]:
"""Fetch the stickers of the guild.
Returns
-------
typing.Sequence[hikari.stickers.GuildSticker]
The requested stickers.
Raises
------
hikari.errors.ForbiddenError
If you are not part of the server.
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_guild_stickers(self.id)
async def fetch_sticker(self, sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker]) -> stickers.GuildSticker:
"""Fetch a sticker from the guild.
Parameters
----------
sticker : snowflakes.SnowflakeishOr[hikari.stickers.PartialSticker]
The sticker to fetch. This can be a sticker object or the
ID of an existing sticker.
Returns
-------
hikari.stickers.GuildSticker
The requested sticker.
Raises
------
hikari.errors.ForbiddenError
If you are not part of the server.
hikari.errors.NotFoundError
If the guild or the sticker are not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_guild_sticker(self.id, sticker)
async def create_sticker(
self,
name: str,
tag: str,
image: files.Resourceish,
*,
description: undefined.UndefinedOr[str] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> stickers.GuildSticker:
"""Create a sticker in a guild.
Parameters
----------
name : builtins.str
The name for the sticker.
tag : builtins.str
The tag for the sticker.
image : hikari.files.Resourceish
The 320x320 image for the sticker. Maximum upload size is 500kb.
This can be a still or an animated PNG or a Lottie.
!!! note
Lottie support is only available for verified and partnered
servers.
Other Parameters
----------------
description: hikari.undefined.UndefinedOr[builtins.str]
If provided, the description of the sticker.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.stickers.GuildSticker
The created sticker.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value or
if there are no more spaces for the sticker in the guild.
hikari.errors.ForbiddenError
If you are missing `MANAGE_EMOJIS_AND_STICKERS` in the server.
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.create_sticker(self.id, name, tag, image, description=description, reason=reason)
async def edit_sticker(
self,
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
name: undefined.UndefinedOr[str] = undefined.UNDEFINED,
description: undefined.UndefinedOr[str] = undefined.UNDEFINED,
tag: undefined.UndefinedOr[str] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> stickers.GuildSticker:
"""Edit a sticker in a guild.
Parameters
----------
sticker : hikari.snowflakes.SnowflakeishOr[hikari.stickers.PartialSticker]
The sticker to edit. This can be a sticker object or the ID of an
existing sticker.
Other Parameters
----------------
name : hikari.undefined.UndefinedOr[builtins.str]
If provided, the new name for the sticker.
description : hikari.undefined.UndefinedOr[builtins.str]
If provided, the new description for the sticker.
tag : hikari.undefined.UndefinedOr[builtins.str]
If provided, the new sticker tag.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.stickers.GuildSticker
The edited sticker.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing `MANAGE_EMOJIS_AND_STICKERS` in the server.
hikari.errors.NotFoundError
If the guild or the sticker are not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.edit_sticker(
self.id, sticker, name=name, description=description, tag=tag, reason=reason
)
async def delete_sticker(
self,
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Delete a sticker in a guild.
Parameters
----------
sticker : hikari.snowflakes.SnowflakeishOr[hikari.stickers.PartialSticker]
The sticker to delete. This can be a sticker object or the ID
of an existing sticker.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.ForbiddenError
If you are missing `MANAGE_EMOJIS_AND_STICKERS` in the server.
hikari.errors.NotFoundError
If the guild or the sticker are not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.delete_sticker(self.id, sticker, reason=reason)
async def create_category(
self,
name: str,
*,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Sequence[channels_.PermissionOverwrite]
] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> channels_.GuildCategory:
"""Create a category in the guild.
Parameters
----------
name : builtins.str
The channels name. Must be between 2 and 1000 characters.
Other Parameters
----------------
position : hikari.undefined.UndefinedOr[builtins.int]
If provided, the position of the category.
permission_overwrites : hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]
If provided, the permission overwrites for the category.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.channels.GuildCategory
The created category.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `MANAGE_CHANNEL` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.create_guild_category(
self.id, name, position=position, permission_overwrites=permission_overwrites, reason=reason
)
async def create_text_channel(
self,
name: str,
*,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
topic: undefined.UndefinedOr[str] = undefined.UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Sequence[channels_.PermissionOverwrite]
] = undefined.UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> channels_.GuildTextChannel:
"""Create a text channel in the guild.
Parameters
----------
name : builtins.str
The channels name. Must be between 2 and 1000 characters.
Other Parameters
----------------
position : hikari.undefined.UndefinedOr[builtins.int]
If provided, the position of the channel (relative to the
category, if any).
topic : hikari.undefined.UndefinedOr[builtins.str]
If provided, the channels topic. Maximum 1024 characters.
nsfw : hikari.undefined.UndefinedOr[builtins.bool]
If provided, whether to mark the channel as NSFW.
rate_limit_per_user : hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]
If provided, the amount of seconds a user has to wait
before being able to send another message in the channel.
Maximum 21600 seconds.
permission_overwrites : hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]
If provided, the permission overwrites for the channel.
category : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]
The category to create the channel under. This may be the
object or the ID of an existing category.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.channels.GuildTextChannel
The created channel.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `MANAGE_CHANNEL` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.create_guild_text_channel(
self.id,
name,
position=position,
topic=topic,
nsfw=nsfw,
rate_limit_per_user=rate_limit_per_user,
permission_overwrites=permission_overwrites,
category=category,
reason=reason,
)
async def create_news_channel(
self,
name: str,
*,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
topic: undefined.UndefinedOr[str] = undefined.UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Sequence[channels_.PermissionOverwrite]
] = undefined.UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> channels_.GuildNewsChannel:
"""Create a news channel in the guild.
Parameters
----------
name : builtins.str
The channels name. Must be between 2 and 1000 characters.
Other Parameters
----------------
position : hikari.undefined.UndefinedOr[builtins.int]
If provided, the position of the channel (relative to the
category, if any).
topic : hikari.undefined.UndefinedOr[builtins.str]
If provided, the channels topic. Maximum 1024 characters.
nsfw : hikari.undefined.UndefinedOr[builtins.bool]
If provided, whether to mark the channel as NSFW.
rate_limit_per_user : hikari.undefined.UndefinedOr[hikari.internal.time.Intervalish]
If provided, the amount of seconds a user has to wait
before being able to send another message in the channel.
Maximum 21600 seconds.
permission_overwrites : hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]
If provided, the permission overwrites for the channel.
category : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]
The category to create the channel under. This may be the
object or the ID of an existing category.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.channels.GuildNewsChannel
The created channel.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `MANAGE_CHANNEL` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.create_guild_news_channel(
self.id,
name,
position=position,
topic=topic,
nsfw=nsfw,
rate_limit_per_user=rate_limit_per_user,
permission_overwrites=permission_overwrites,
category=category,
reason=reason,
)
async def create_voice_channel(
self,
name: str,
*,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED,
bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED,
video_quality_mode: undefined.UndefinedOr[typing.Union[channels_.VideoQualityMode, int]] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Sequence[channels_.PermissionOverwrite]
] = undefined.UNDEFINED,
region: undefined.UndefinedOr[typing.Union[voices_.VoiceRegion, str]] = undefined.UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> channels_.GuildVoiceChannel:
"""Create a voice channel in a guild.
Parameters
----------
guild : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]
The guild to create the channel in. This may be the
object or the ID of an existing guild.
name : builtins.str
The channels name. Must be between 2 and 1000 characters.
Other Parameters
----------------
position : hikari.undefined.UndefinedOr[builtins.int]
If provided, the position of the channel (relative to the
category, if any).
user_limit : hikari.undefined.UndefinedOr[builtins.int]
If provided, the maximum users in the channel at once.
Must be between 0 and 99 with 0 meaning no limit.
bitrate : hikari.undefined.UndefinedOr[builtins.int]
If provided, the bitrate for the channel. Must be
between 8000 and 96000 or 8000 and 128000 for VIP
servers.
video_quality_mode: hikari.undefined.UndefinedOr[typing.Union[hikari.channels.VideoQualityMode, builtins.int]]
If provided, the new video quality mode for the channel.
permission_overwrites : hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]
If provided, the permission overwrites for the channel.
region : hikari.undefined.UndefinedOr[typing.Union[hikari.voices.VoiceRegion, builtins.str]]
If provided, the voice region to for this channel. Passing
`builtins.None` here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.
category : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]
The category to create the channel under. This may be the
object or the ID of an existing category.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.channels.GuildVoiceChannel
The created channel.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `MANAGE_CHANNEL` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the gui ld is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.create_guild_voice_channel(
self.id,
name,
position=position,
user_limit=user_limit,
bitrate=bitrate,
video_quality_mode=video_quality_mode,
permission_overwrites=permission_overwrites,
region=region,
category=category,
reason=reason,
)
async def create_stage_channel(
self,
name: str,
*,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED,
bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Sequence[channels_.PermissionOverwrite]
] = undefined.UNDEFINED,
region: undefined.UndefinedOr[typing.Union[voices_.VoiceRegion, str]] = undefined.UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> channels_.GuildStageChannel:
"""Create a stage channel in the guild.
Parameters
----------
name : builtins.str
The channel's name. Must be between 2 and 1000 characters.
Other Parameters
----------------
position : hikari.undefined.UndefinedOr[builtins.int]
If provided, the position of the channel (relative to the
category, if any).
user_limit : hikari.undefined.UndefinedOr[builtins.int]
If provided, the maximum users in the channel at once.
Must be between 0 and 99 with 0 meaning no limit.
bitrate : hikari.undefined.UndefinedOr[builtins.int]
If provided, the bitrate for the channel. Must be
between 8000 and 96000 or 8000 and 128000 for VIP
servers.
permission_overwrites : hikari.undefined.UndefinedOr[typing.Sequence[hikari.channels.PermissionOverwrite]]
If provided, the permission overwrites for the channel.
region : hikari.undefined.UndefinedOr[typing.Union[hikari.voices.VoiceRegion, builtins.str]]
If provided, the voice region to for this channel. Passing
`builtins.None` here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.
category : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildCategory]]
The category to create the channel under. This may be the
object or the ID of an existing category.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.channels.GuildStageChannel
The created channel.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `MANAGE_CHANNEL` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.create_guild_stage_channel(
self.id,
name,
position=position,
user_limit=user_limit,
bitrate=bitrate,
permission_overwrites=permission_overwrites,
region=region,
category=category,
reason=reason,
)
async def delete_channel(
self, channel: snowflakes.SnowflakeishOr[channels_.GuildChannel]
) -> channels_.GuildChannel:
"""Delete a channel in the guild.
!!! note
This method can also be used for deleting guild categories as well.
Parameters
----------
channel : hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildChannel]
The channel or category to delete. This may be the object or the ID of an
existing channel.
Returns
-------
hikari.channels.GuildChannel
Object of the channel or category that was deleted.
Raises
------
hikari.errors.UnauthorizedError, or close a DM.
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `MANAGE_CHANNEL` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
!!! note
For Public servers, the set 'Rules' or 'Guidelines' channels and the
'Public Server Updates' channel cannot be deleted.
"""
deleted_channel = await self.app.rest.delete_channel(channel)
assert isinstance(deleted_channel, channels_.GuildChannel)
return deleted_channel
async def fetch_self(self) -> RESTGuild:
"""Fetch the guild.
Returns
-------
hikari.guilds.RESTGuild
The requested guild.
Raises
------
hikari.errors.ForbiddenError
If you are not part of the guild.
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_guild(self.id)
async def fetch_roles(self) -> typing.Sequence[Role]:
"""Fetch the roles of the guild.
Returns
-------
typing.Sequence[hikari.guilds.Role]
The requested roles.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_roles(self.id)
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class GuildPreview(PartialGuild):
"""A preview of a guild with the `GuildFeature.DISCOVERABLE` feature."""
features: typing.Sequence[typing.Union[str, GuildFeature]] = attr.field(eq=False, hash=False, repr=False)
"""A list of the features in this guild."""
splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the splash for the guild, if there is one."""
discovery_splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the discovery splash for the guild, if there is one."""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(
eq=False, hash=False, repr=False
)
"""The mapping of IDs to the emojis this guild provides."""
approximate_active_member_count: int = attr.field(eq=False, hash=False, repr=True)
"""The approximate amount of presences in this guild."""
approximate_member_count: int = attr.field(eq=False, hash=False, repr=True)
"""The approximate amount of members in this guild."""
description: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The guild's description, if set."""
@property
def discovery_splash_url(self) -> typing.Optional[files.URL]:
"""Discovery URL splash for the guild, if set."""
return self.make_discovery_splash_url()
@property
def splash_url(self) -> typing.Optional[files.URL]:
"""Splash URL for the guild, if set."""
return self.make_splash_url()
def make_discovery_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's discovery splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The string URL.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.discovery_splash_hash is None:
return None
return routes.CDN_GUILD_DISCOVERY_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.discovery_splash_hash,
size=size,
file_format=ext,
)
def make_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the splash, or `builtins.None` if not set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.splash_hash is None:
return None
return routes.CDN_GUILD_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.splash_hash,
size=size,
file_format=ext,
)
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class Guild(PartialGuild):
"""A representation of a guild on Discord."""
features: typing.Sequence[typing.Union[str, GuildFeature]] = attr.field(eq=False, hash=False, repr=False)
"""A list of the features in this guild."""
application_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the application that created this guild.
This will always be `builtins.None` for guilds that weren't created by a bot.
"""
afk_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID for the channel that AFK voice users get sent to.
If `builtins.None`, then no AFK channel is set up for this guild.
"""
afk_timeout: datetime.timedelta = attr.field(eq=False, hash=False, repr=False)
"""Timeout for activity before a member is classed as AFK.
How long a voice user has to be AFK for before they are classed as being
AFK and are moved to the AFK channel (`Guild.afk_channel_id`).
"""
banner_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash for the guild's banner.
This is only present if the guild has `GuildFeature.BANNER` in
`Guild.features` for this guild. For all other purposes, it is `builtins.None`.
"""
default_message_notifications: typing.Union[GuildMessageNotificationsLevel, int] = attr.field(
eq=False, hash=False, repr=False
)
"""The default setting for message notifications in this guild."""
description: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The guild's description.
This is only present if certain `GuildFeature`'s are set in
`Guild.features` for this guild. Otherwise, this will always be `builtins.None`.
"""
discovery_splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the discovery splash for the guild, if there is one."""
explicit_content_filter: typing.Union[GuildExplicitContentFilterLevel, int] = attr.field(
eq=False, hash=False, repr=False
)
"""The setting for the explicit content filter in this guild."""
is_widget_enabled: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Describes whether the guild widget is enabled or not.
If this information is not present, this will be `builtins.None`.
"""
max_video_channel_users: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The maximum number of users allowed in a video channel together.
This information may not be present, in which case, it will be `builtins.None`.
"""
mfa_level: typing.Union[GuildMFALevel, int] = attr.field(eq=False, hash=False, repr=False)
"""The required MFA level for users wishing to participate in this guild."""
owner_id: snowflakes.Snowflake = attr.field(eq=False, hash=False, repr=True)
"""The ID of the owner of this guild."""
preferred_locale: typing.Union[str, locales.Locale] = attr.field(eq=False, hash=False, repr=False)
"""The preferred locale to use for this guild.
This can only be change if `GuildFeature.COMMUNITY` is in `Guild.features`
for this guild and will otherwise default to `en-US`.
"""
premium_subscription_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The number of nitro boosts that the server currently has.
This information may not be present, in which case, it will be `builtins.None`.
"""
premium_tier: typing.Union[GuildPremiumTier, int] = attr.field(eq=False, hash=False, repr=False)
"""The premium tier for this guild."""
public_updates_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The channel ID of the channel where admins and moderators receive notices
from Discord.
This is only present if `GuildFeature.COMMUNITY` is in `Guild.features` for
this guild. For all other purposes, it should be considered to be `builtins.None`.
"""
rules_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the channel where guilds with the `GuildFeature.COMMUNITY`
`features` display rules and guidelines.
If the `GuildFeature.COMMUNITY` feature is not defined, then this is `builtins.None`.
"""
splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the splash for the guild, if there is one."""
system_channel_flags: GuildSystemChannelFlag = attr.field(eq=False, hash=False, repr=False)
"""Return flags for the guild system channel.
These are used to describe which notifications are suppressed.
Returns
-------
GuildSystemChannelFlag
The system channel flags for this channel.
"""
system_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the system channel or `builtins.None` if it is not enabled.
Welcome messages and Nitro boost messages may be sent to this channel.
"""
vanity_url_code: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The vanity URL code for the guild's vanity URL.
This is only present if `GuildFeature.VANITY_URL` is in `Guild.features` for
this guild. If not, this will always be `builtins.None`.
"""
verification_level: typing.Union[GuildVerificationLevel, int] = attr.field(eq=False, hash=False, repr=False)
"""The verification level needed for a user to participate in this guild."""
widget_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The channel ID that the widget's generated invite will send the user to.
If this information is unavailable or this is not enabled for the guild then
this will be `builtins.None`.
"""
nsfw_level: GuildNSFWLevel = attr.field(eq=False, hash=False, repr=False)
"""The NSFW level of the guild."""
@property
def banner_url(self) -> typing.Optional[files.URL]:
"""Banner URL for the guild, if set."""
return self.make_banner_url()
@property
def discovery_splash_url(self) -> typing.Optional[files.URL]:
"""Discovery splash URL for the guild, if set."""
return self.make_discovery_splash_url()
@property
def splash_url(self) -> typing.Optional[files.URL]:
"""Splash URL for the guild, if set."""
return self.make_splash_url()
def get_members(self) -> typing.Mapping[snowflakes.Snowflake, Member]:
"""Get the members cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, Member]
A mapping of user IDs to objects of the members cached for the guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_members_view_for_guild(self.id)
def get_presences(self) -> typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence]:
"""Get the presences cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence]
A mapping of user IDs to objects of the presences cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_presences_view_for_guild(self.id)
def get_channels(self) -> typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel]:
"""Get the channels cached for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.channels.GuildChannel]
A mapping of channel IDs to objects of the channels cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_guild_channels_view_for_guild(self.id)
def get_voice_states(self) -> typing.Mapping[snowflakes.Snowflake, voices_.VoiceState]:
"""Get the voice states cached for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.voices.VoiceState]
A mapping of user IDs to objects of the voice states cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_voice_states_view_for_guild(self.id)
def get_emojis(self) -> typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]:
"""Return the emojis in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
A mapping of emoji IDs to the objects of emojis in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_emojis_view_for_guild(self.id)
def get_stickers(self) -> typing.Mapping[snowflakes.Snowflake, stickers.GuildSticker]:
"""Return the stickers in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.stickers.GuildSticker]
A mapping of sticker IDs to the objects of sticker in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_stickers_view_for_guild(self.id)
def get_roles(self) -> typing.Mapping[snowflakes.Snowflake, Role]:
"""Return the roles in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, Role]
A mapping of role IDs to the objects of roles in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_roles_view_for_guild(self.id)
def make_banner_url(self, *, ext: typing.Optional[str] = None, size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's banner image URL, if set.
Parameters
----------
ext : typing.Optional[builtins.str]
The ext to use for this URL, defaults to `png` or `gif`.
Supports `png`, `jpeg`, `jpg`, `webp` and `gif` (when
animated).
If `builtins.None`, then the correct default extension is
determined based on whether the banner is animated or not.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL of the banner, or `builtins.None` if no banner is set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.banner_hash is None:
return None
if ext is None:
if self.banner_hash.startswith("a_"):
ext = "gif"
else:
ext = "png"
return routes.CDN_GUILD_BANNER.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.banner_hash,
size=size,
file_format=ext,
)
def make_discovery_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's discovery splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The string URL.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.discovery_splash_hash is None:
return None
return routes.CDN_GUILD_DISCOVERY_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.discovery_splash_hash,
size=size,
file_format=ext,
)
def make_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the splash, or `builtins.None` if not set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.splash_hash is None:
return None
return routes.CDN_GUILD_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.splash_hash,
size=size,
file_format=ext,
)
def get_channel(
self,
channel: snowflakes.SnowflakeishOr[channels_.PartialChannel],
) -> typing.Optional[channels_.GuildChannel]:
"""Get a cached channel that belongs to the guild by it's ID or object.
Parameters
----------
channel : hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]
The object or ID of the guild channel to get from the cache.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The object of the guild channel found in cache or `builtins.None.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_guild_channel(channel)
def get_member(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -> typing.Optional[Member]:
"""Get a cached member that belongs to the guild by it's user ID or object.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached member for.
Returns
-------
typing.Optional[Member]
The cached member object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_member(self.id, user)
def get_my_member(self) -> typing.Optional[Member]:
"""Return the cached member for the bot user in this guild, if known.
Returns
-------
typing.Optional[Member]
The cached member for this guild, or `builtins.None` if not known.
"""
if not isinstance(self.app, traits.ShardAware):
return None
me = self.app.get_me()
if me is None:
return None
return self.get_member(me.id)
def get_presence(
self, user: snowflakes.SnowflakeishOr[users.PartialUser]
) -> typing.Optional[presences_.MemberPresence]:
"""Get a cached presence that belongs to the guild by it's user ID or object.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached presence for.
Returns
-------
typing.Optional[hikari.presences.MemberPresence]
The cached presence object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_presence(self.id, user)
def get_voice_state(
self, user: snowflakes.SnowflakeishOr[users.PartialUser]
) -> typing.Optional[voices_.VoiceState]:
"""Get a cached voice state that belongs to the guild by it's user.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached voice state for.
Returns
-------
typing.Optional[hikari.voices.VoiceState]
The cached voice state object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_voice_state(self.id, user)
def get_emoji(
self, emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji]
) -> typing.Optional[emojis_.KnownCustomEmoji]:
"""Get a cached emoji that belongs to the guild by it's ID or object.
Parameters
----------
emoji : hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]
The object or ID of the emoji to get from the cache.
Returns
-------
typing.Optional[hikari.emojis.KnownCustomEmoji]
The object of the custom emoji if found in cache, else
`builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_emoji(emoji)
def get_sticker(
self, sticker: snowflakes.SnowflakeishOr[stickers.GuildSticker]
) -> typing.Optional[stickers.GuildSticker]:
"""Get a cached sticker that belongs to the guild by it's ID or object.
Parameters
----------
sticker : hikari.snowflakes.SnowflakeishOr[hikari.stickers.GuildSticker]
The object or ID of the sticker to get from the cache.
Returns
-------
typing.Optional[hikari.stickers.GuildSticker]
The object of the sticker if found in cache, else
`builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_sticker(sticker)
def get_role(self, role: snowflakes.SnowflakeishOr[PartialRole]) -> typing.Optional[Role]:
"""Get a cached role that belongs to the guild by it's ID or object.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[PartialRole]
The object or ID of the role to get for this guild from the cache.
Returns
-------
typing.Optional[Role]
The object of the role found in cache, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_role(role)
async def fetch_owner(self) -> Member:
"""Fetch the owner of the guild.
Returns
-------
hikari.guilds.Member
The guild owner.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or the user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_member(self.id, self.owner_id)
async def fetch_widget_channel(self) -> typing.Optional[channels_.GuildChannel]:
"""Fetch the widget channel.
This will be `builtins.None` if not set.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The channel the widget is linked to or else `builtins.None`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.widget_channel_id:
return None
widget_channel = await self.app.rest.fetch_channel(self.widget_channel_id)
assert isinstance(widget_channel, channels_.GuildChannel)
return widget_channel
async def fetch_afk_channel(self) -> typing.Optional[channels_.GuildVoiceChannel]:
"""Fetch the channel that AFK voice users get sent to.
Returns
-------
typing.Optional[hikari.channels.GuildVoiceChannel]
The AFK channel or `builtins.None` if not enabled.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.afk_channel_id:
return None
afk_channel = await self.app.rest.fetch_channel(self.afk_channel_id)
assert isinstance(afk_channel, channels_.GuildVoiceChannel)
return afk_channel
async def fetch_system_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch the system channel.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The system channel for this guild or `builtins.None` if not
enabled.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.system_channel_id:
return None
system_channel = await self.app.rest.fetch_channel(self.system_channel_id)
assert isinstance(system_channel, channels_.GuildTextChannel)
return system_channel
async def fetch_rules_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch the channel where guilds display rules and guidelines.
If the `GuildFeature.COMMUNITY` feature is not defined, then this is `builtins.None`.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The channel where the rules of the guild are specified or else `builtins.None`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.rules_channel_id:
return None
rules_channel = await self.app.rest.fetch_channel(self.rules_channel_id)
assert isinstance(rules_channel, channels_.GuildTextChannel)
return rules_channel
async def fetch_public_updates_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if `GuildFeature.COMMUNITY` is in `Guild.features` for
this guild. For all other purposes, it should be considered to be `builtins.None`.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The channel where discord sends relevant updates to moderators and admins.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.public_updates_channel_id:
return None
updates_channel = await self.app.rest.fetch_channel(self.public_updates_channel_id)
assert isinstance(updates_channel, channels_.GuildTextChannel)
return updates_channel
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class RESTGuild(Guild):
"""Guild specialization that is sent via the REST API only."""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(
eq=False, hash=False, repr=False
)
"""A mapping of emoji IDs to the objects of the emojis this guild provides."""
stickers: typing.Mapping[snowflakes.Snowflake, stickers.GuildSticker] = attr.field(eq=False, hash=False, repr=False)
"""A mapping of sticker IDs to the objects of the stickers this guild provides."""
roles: typing.Mapping[snowflakes.Snowflake, Role] = attr.field(eq=False, hash=False, repr=False)
"""The roles in this guild, represented as a mapping of role ID to role object."""
approximate_active_member_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The approximate number of members in the guild that are not offline.
This will be `builtins.None` when creating a guild.
"""
approximate_member_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The approximate number of members in the guild.
This will be `builtins.None` when creating a guild.
"""
max_presences: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The maximum number of presences for the guild.
If `builtins.None`, then there is no limit.
"""
max_members: int = attr.field(eq=False, hash=False, repr=False)
"""The maximum number of members allowed in this guild."""
@attr.define(hash=True, kw_only=True, weakref_slot=False)
class GatewayGuild(Guild):
"""Guild specialization that is sent via the gateway only."""
is_large: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether the guild is considered to be large or not.
This information is only available if the guild was sent via a `GUILD_CREATE`
event. If the guild is received from any other place, this will always be
`builtins.None`.
The implications of a large guild are that presence information will not be
sent about members who are offline or invisible.
"""
joined_at: typing.Optional[datetime.datetime] = attr.field(eq=False, hash=False, repr=False)
"""The date and time that the bot user joined this guild.
This information is only available if the guild was sent via a `GUILD_CREATE`
event. If the guild is received from any other place, this will always be
`builtins.None`.
"""
member_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The number of members in this guild.
This information is only available if the guild was sent via a `GUILD_CREATE`
event. If the guild is received from any other place, this will always be
`builtins.None`.
"""class GatewayGuild (
*,
app: traits.RESTAware,
id: snowflakes.Snowflake,
icon_hash: Optional[str],
name: str,
features: Sequence[Union[str, GuildFeature]],
application_id: Optional[snowflakes.Snowflake],
afk_channel_id: Optional[snowflakes.Snowflake],
afk_timeout: datetime.timedelta,
banner_hash: Optional[str],
default_message_notifications: Union[GuildMessageNotificationsLevel, int],
description: Optional[str],
discovery_splash_hash: Optional[str],
explicit_content_filter: Union[GuildExplicitContentFilterLevel, int],
is_widget_enabled: Optional[bool],
max_video_channel_users: Optional[int],
mfa_level: Union[GuildMFALevel, int],
owner_id: snowflakes.Snowflake,
preferred_locale: Union[str, locales.Locale],
premium_subscription_count: Optional[int],
premium_tier: Union[GuildPremiumTier, int],
public_updates_channel_id: Optional[snowflakes.Snowflake],
rules_channel_id: Optional[snowflakes.Snowflake],
splash_hash: Optional[str],
system_channel_flags: GuildSystemChannelFlag,
system_channel_id: Optional[snowflakes.Snowflake],
vanity_url_code: Optional[str],
verification_level: Union[GuildVerificationLevel, int],
widget_channel_id: Optional[snowflakes.Snowflake],
nsfw_level: GuildNSFWLevel,
is_large: Optional[bool],
joined_at: Optional[datetime.datetime],
member_count: Optional[int],
): ...Guild specialization that is sent via the gateway only.
Method generated by attrs for class GatewayGuild.
class GatewayGuild(Guild):
"""Guild specialization that is sent via the gateway only."""
is_large: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether the guild is considered to be large or not.
This information is only available if the guild was sent via a `GUILD_CREATE`
event. If the guild is received from any other place, this will always be
`builtins.None`.
The implications of a large guild are that presence information will not be
sent about members who are offline or invisible.
"""
joined_at: typing.Optional[datetime.datetime] = attr.field(eq=False, hash=False, repr=False)
"""The date and time that the bot user joined this guild.
This information is only available if the guild was sent via a `GUILD_CREATE`
event. If the guild is received from any other place, this will always be
`builtins.None`.
"""
member_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The number of members in this guild.
This information is only available if the guild was sent via a `GUILD_CREATE`
event. If the guild is received from any other place, this will always be
`builtins.None`.
"""A representation of a guild on Discord …
Base object for any partial guild objects …
Mixin for a class that enforces uniqueness by a snowflake ID.
Helper class that provides a standard way to create an ABC using inheritance.
property afk_channel_id : Optional[snowflakes.Snowflake]The ID for the channel that AFK voice users get sent to.
If None, then no AFK channel is set up for this guild.
property afk_timeout : datetime.timedeltaTimeout for activity before a member is classed as AFK.
How long a voice user has to be AFK for before they are classed as being
AFK and are moved to the AFK channel (afk_channel_id).
property app : traits.RESTAwareThe client application that models may use for procedures.
property application_id : Optional[snowflakes.Snowflake]The ID of the application that created this guild.
This will always be None for guilds that weren't created by a bot.
property created_at : datetime.datetimeWhen the object was created.
property default_message_notifications : Union[GuildMessageNotificationsLevel, int]The default setting for message notifications in this guild.
property description : Optional[str]The guild's description.
This is only present if certain GuildFeature's are set in
features for this guild. Otherwise, this will always be None.
property discovery_splash_hash : Optional[str]The hash of the discovery splash for the guild, if there is one.
property discovery_splash_url : Optional[files.URL]Discovery splash URL for the guild, if set.
property explicit_content_filter : Union[GuildExplicitContentFilterLevel, int]The setting for the explicit content filter in this guild.
property features : Sequence[Union[str, GuildFeature]]A list of the features in this guild.
property id : snowflakes.SnowflakeThe ID of this entity.
property is_large : Optional[bool]Whether the guild is considered to be large or not.
This information is only available if the guild was sent via a GUILD_CREATE
event. If the guild is received from any other place, this will always be
None.
The implications of a large guild are that presence information will not be sent about members who are offline or invisible.
property is_widget_enabled : Optional[bool]Describes whether the guild widget is enabled or not.
If this information is not present, this will be None.
property joined_at : Optional[datetime.datetime]The date and time that the bot user joined this guild.
This information is only available if the guild was sent via a GUILD_CREATE
event. If the guild is received from any other place, this will always be
None.
property max_video_channel_users : Optional[int]The maximum number of users allowed in a video channel together.
This information may not be present, in which case, it will be None.
property member_count : Optional[int]The number of members in this guild.
This information is only available if the guild was sent via a GUILD_CREATE
event. If the guild is received from any other place, this will always be
None.
property mfa_level : Union[GuildMFALevel, int]The required MFA level for users wishing to participate in this guild.
property nsfw_level : GuildNSFWLevelThe NSFW level of the guild.
property owner_id : snowflakes.SnowflakeThe ID of the owner of this guild.
property preferred_locale : Union[str, locales.Locale]The preferred locale to use for this guild.
This can only be change if COMMUNITY is in features
for this guild and will otherwise default to en-US.
property public_updates_channel_id : Optional[snowflakes.Snowflake]The channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if COMMUNITY is in features for
this guild. For all other purposes, it should be considered to be None.
property rules_channel_id : Optional[snowflakes.Snowflake]The ID of the channel where guilds with the COMMUNITY
features display rules and guidelines.
property shard_id : Optional[int]Return the ID of the shard this guild is served by.
This may return None if the application does not have a gateway
connection.
property splash_hash : Optional[str]The hash of the splash for the guild, if there is one.
property splash_url : Optional[files.URL]Splash URL for the guild, if set.
property system_channel_flags : GuildSystemChannelFlagReturn flags for the guild system channel.
These are used to describe which notifications are suppressed.
GuildSystemChannelFlagproperty system_channel_id : Optional[snowflakes.Snowflake]The ID of the system channel or None if it is not enabled.
Welcome messages and Nitro boost messages may be sent to this channel.
property vanity_url_code : Optional[str]The vanity URL code for the guild's vanity URL.
This is only present if VANITY_URL is in features for
this guild. If not, this will always be None.
property verification_level : Union[GuildVerificationLevel, int]The verification level needed for a user to participate in this guild.
property widget_channel_id : Optional[snowflakes.Snowflake]The channel ID that the widget's generated invite will send the user to.
If this information is unavailable or this is not enabled for the guild then
this will be None.
async def ban(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
delete_message_days: undefined.UndefinedOr[int] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...Ban the given user from this guild.
user : Snowflakeish[PartialUser]delete_message_days : UndefinedNoneOr[int]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_category(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildCategory: ...
Inherited from:
Guild.create_category
Create a category in the guild.
name : strposition : UndefinedOr[int]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]reason : UndefinedOr[str]GuildCategoryBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_news_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
topic: undefined.UndefinedOr[str] = UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildNewsChannel: ...
Inherited from:
Guild.create_news_channel
Create a news channel in the guild.
name : strposition : UndefinedOr[int]topic : UndefinedOr[str]nsfw : UndefinedOr[bool]rate_limit_per_user : UndefinedOr[Intervalish]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildNewsChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_stage_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
user_limit: undefined.UndefinedOr[int] = UNDEFINED,
bitrate: undefined.UndefinedOr[int] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
region: undefined.UndefinedOr[Union[voices_.VoiceRegion, str]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> channels_.GuildStageChannel: ...
Inherited from:
Guild.create_stage_channel
Create a stage channel in the guild.
name : strposition : UndefinedOr[int]user_limit : UndefinedOr[int]bitrate : UndefinedOr[int]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]region : UndefinedOr[Union[VoiceRegion, str]]None here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildStageChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_sticker(
name: str,
tag: str,
image: files.Resourceish,
*,
description: undefined.UndefinedOr[str] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> stickers.GuildSticker: ...
Inherited from:
Guild.create_sticker
Create a sticker in a guild.
name : strtag : strimage : ResourceishThe 320x320 image for the sticker. Maximum upload size is 500kb. This can be a still or an animated PNG or a Lottie.
Note
Lottie support is only available for verified and partnered servers.
description : UndefinedOr[str]reason : UndefinedOr[str]GuildStickerBadRequestErrorForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_text_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
topic: undefined.UndefinedOr[str] = UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildTextChannel: ...
Inherited from:
Guild.create_text_channel
Create a text channel in the guild.
name : strposition : UndefinedOr[int]topic : UndefinedOr[str]nsfw : UndefinedOr[bool]rate_limit_per_user : UndefinedOr[Intervalish]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildTextChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_voice_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
user_limit: undefined.UndefinedOr[int] = UNDEFINED,
bitrate: undefined.UndefinedOr[int] = UNDEFINED,
video_quality_mode: undefined.UndefinedOr[Union[channels_.VideoQualityMode, int]] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
region: undefined.UndefinedOr[Union[voices_.VoiceRegion, str]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> channels_.GuildVoiceChannel: ...
Inherited from:
Guild.create_voice_channel
Create a voice channel in a guild.
guild : SnowflakeishOr[PartialGuild]name : strposition : UndefinedOr[int]user_limit : UndefinedOr[int]bitrate : UndefinedOr[int]video_quality_mode : UndefinedOr[Union[VideoQualityMode, int]]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]region : UndefinedOr[Union[VoiceRegion, str]]None here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildVoiceChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def delete_channel(
channel: snowflakes.SnowflakeishOr[channels_.GuildChannel],
) -> GuildChannel: ...
Inherited from:
Guild.delete_channel
Delete a channel in the guild.
Note
This method can also be used for deleting guild categories as well.
channel : SnowflakeishOr[GuildChannel]GuildChannelForbiddenErrorMANAGE_CHANNEL permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorNote
For Public servers, the set 'Rules' or 'Guidelines' channels and the 'Public Server Updates' channel cannot be deleted.
async def delete_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
Guild.delete_sticker
Delete a sticker in a guild.
sticker : SnowflakeishOr[PartialSticker]reason : UndefinedOr[str]ForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit(
*,
name: undefined.UndefinedOr[str] = UNDEFINED,
verification_level: undefined.UndefinedOr[GuildVerificationLevel] = UNDEFINED,
default_message_notifications: undefined.UndefinedOr[GuildMessageNotificationsLevel] = UNDEFINED,
explicit_content_filter_level: undefined.UndefinedOr[GuildExplicitContentFilterLevel] = UNDEFINED,
afk_channel: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]] = UNDEFINED,
afk_timeout: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
icon: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = UNDEFINED,
splash: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
banner: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
system_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
rules_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
public_updates_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
preferred_locale: undefined.UndefinedOr[Union[str, locales.Locale]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> RESTGuild: ...Edits the guild.
name : UndefinedOr[str]verification_level : UndefinedOr[GuildVerificationLevel]default_message_notifications : UndefinedOr[GuildMessageNotificationsLevel]explicit_content_filter_level : UndefinedOr[GuildExplicitContentFilterLevel]afk_channel : UndefinedOr[SnowflakeishOr[GuildVoiceChannel]]afk_timeout to
be set to work.afk_timeout : UndefinedOr[Intervalish]icon : UndefinedOr[Resourceish]ANIMATED_ICON feature.owner : UndefinedOr[SnowflakeishOr[PartialUser]]]If provided, the new guild owner.
Warning
You need to be the owner of the server to use this.
splash : UndefinedNoneOr[Resourceish]INVITE_SPLASH feature.banner : UndefinedNoneOr[Resourceish]BANNER feature.system_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]rules_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]public_updates_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]preferred_locale : UndefinedNoneOr[str]reason : UndefinedOr[str]RESTGuildBadRequestErrorForbiddenErrorMANAGE_GUILD permission or if you tried to
pass ownership without being the server owner.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
name: undefined.UndefinedOr[str] = UNDEFINED,
description: undefined.UndefinedOr[str] = UNDEFINED,
tag: undefined.UndefinedOr[str] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildSticker: ...
Inherited from:
Guild.edit_sticker
Edit a sticker in a guild.
sticker : SnowflakeishOr[PartialSticker]name : UndefinedOr[str]description : UndefinedOr[str]tag : UndefinedOr[str]reason : UndefinedOr[str]GuildStickerBadRequestErrorForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_afk_channel() -> Optional[GuildVoiceChannel]: ...
Inherited from:
Guild.fetch_afk_channel
Fetch the channel that AFK voice users get sent to.
Optional[GuildVoiceChannel]None if not enabled.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_emoji(
emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji],
) -> emojis_.KnownCustomEmoji: ...
Inherited from:
Guild.fetch_emoji
Fetch an emoji from the guild.
emoji : SnowflakeishOr[CustomEmoji]CustomEmoji
or the ID of an existing emoji.KnownCustomEmojiNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_emojis() -> Sequence[emojis_.KnownCustomEmoji]: ...
Inherited from:
Guild.fetch_emojis
Fetch the emojis of the guild.
Sequence[KnownCustomEmoji]NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_owner() -> Member: ...
Inherited from:
Guild.fetch_owner
Fetch the owner of the guild.
MemberUnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_public_updates_channel() -> Optional[GuildTextChannel]: ...
Inherited from:
Guild.fetch_public_updates_channel
Fetch channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if COMMUNITY is in features for
this guild. For all other purposes, it should be considered to be None.
Optional[GuildTextChannel]UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_roles() -> Sequence[Role]: ...
Inherited from:
Guild.fetch_roles
Fetch the roles of the guild.
UnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_rules_channel() -> Optional[GuildTextChannel]: ...
Inherited from:
Guild.fetch_rules_channel
Fetch the channel where guilds display rules and guidelines.
If the COMMUNITY feature is not defined, then this is None.
Optional[GuildTextChannel]None.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_self() -> RESTGuild: ...
Inherited from:
Guild.fetch_self
Fetch the guild.
RESTGuildForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
) -> GuildSticker: ...
Inherited from:
Guild.fetch_sticker
Fetch a sticker from the guild.
sticker : snowflakes.SnowflakeishOr[PartialSticker]GuildStickerForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_stickers() -> Sequence[GuildSticker]: ...
Inherited from:
Guild.fetch_stickers
Fetch the stickers of the guild.
Sequence[GuildSticker]ForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_system_channel() -> Optional[GuildTextChannel]: ...
Inherited from:
Guild.fetch_system_channel
Fetch the system channel.
Optional[GuildTextChannel]None if not
enabled.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_widget_channel() -> Optional[GuildChannel]: ...
Inherited from:
Guild.fetch_widget_channel
Fetch the widget channel.
This will be None if not set.
Optional[GuildChannel]None.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrordef get_channel(
channel: snowflakes.SnowflakeishOr[channels_.PartialChannel],
) -> Optional[GuildChannel]: ...
Inherited from:
Guild.get_channel
Get a cached channel that belongs to the guild by it's ID or object.
channel : SnowflakeishOr[PartialChannel]Optional[GuildChannel]def get_channels() -> Mapping[Snowflake, GuildChannel]: ...
Inherited from:
Guild.get_channels
Get the channels cached for the guild.
Mapping[Snowflake, GuildChannel]def get_emoji(
emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji],
) -> Optional[emojis_.KnownCustomEmoji]: ...
Inherited from:
Guild.get_emoji
Get a cached emoji that belongs to the guild by it's ID or object.
emoji : SnowflakeishOr[CustomEmoji]Optional[KnownCustomEmoji]None.def get_emojis() -> Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]: ...
Inherited from:
Guild.get_emojis
Return the emojis in this guild.
Mapping[Snowflake, KnownCustomEmoji]def get_member(
user: snowflakes.SnowflakeishOr[users.PartialUser],
) -> Optional[Member]: ...
Inherited from:
Guild.get_member
Get a cached member that belongs to the guild by it's user ID or object.
user : SnowflakeishOr[PartialUser]def get_members() -> Mapping[Snowflake, Member]: ...
Inherited from:
Guild.get_members
Get the members cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, Member] A mapping of user IDs to objects of the members cached for the guild.
def get_my_member() -> Optional[Member]: ...
Inherited from:
Guild.get_my_member
Return the cached member for the bot user in this guild, if known.
def get_presence(
user: snowflakes.SnowflakeishOr[users.PartialUser],
) -> Optional[presences_.MemberPresence]: ...
Inherited from:
Guild.get_presence
Get a cached presence that belongs to the guild by it's user ID or object.
user : SnowflakeishOr[PartialUser]Optional[MemberPresence]None.def get_presences() -> Mapping[snowflakes.Snowflake, presences_.MemberPresence]: ...
Inherited from:
Guild.get_presences
Get the presences cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence] A mapping of user IDs to objects of the presences cached for the guild.
def get_role(
role: snowflakes.SnowflakeishOr[PartialRole],
) -> Optional[Role]: ...
Inherited from:
Guild.get_role
Get a cached role that belongs to the guild by it's ID or object.
role : SnowflakeishOr[PartialRole]def get_roles() -> Mapping[Snowflake, Role]: ...
Inherited from:
Guild.get_roles
Return the roles in this guild.
def get_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.GuildSticker],
) -> Optional[GuildSticker]: ...
Inherited from:
Guild.get_sticker
Get a cached sticker that belongs to the guild by it's ID or object.
sticker : SnowflakeishOr[GuildSticker]Optional[GuildSticker]None.def get_stickers() -> Mapping[Snowflake, GuildSticker]: ...
Inherited from:
Guild.get_stickers
Return the stickers in this guild.
Mapping[Snowflake, GuildSticker]def get_voice_state(
user: snowflakes.SnowflakeishOr[users.PartialUser],
) -> Optional[voices_.VoiceState]: ...
Inherited from:
Guild.get_voice_state
Get a cached voice state that belongs to the guild by it's user.
user : SnowflakeishOr[PartialUser]Optional[VoiceState]None.def get_voice_states() -> Mapping[snowflakes.Snowflake, voices_.VoiceState]: ...
Inherited from:
Guild.get_voice_states
Get the voice states cached for the guild.
Mapping[Snowflake, VoiceState]async def kick(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...Kicks the given user from this guild.
user : Snowflakeish[PartialUser]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorKICK_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrordef make_discovery_splash_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...
Inherited from:
Guild.make_discovery_splash_url
Generate the guild's discovery splash image URL, if set.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_icon_url(
*,
ext: Optional[str] = None,
size: int = 4096,
) -> Optional[files.URL]: ...
Inherited from:
Guild.make_icon_url
Generate the guild's icon URL, if set.
ext : Optional[str]The extension to use for this URL, defaults to png or gif.
Supports png, jpeg, jpg, webp and gif (when
animated).
If None, then the correct default extension is
determined based on whether the icon is animated or not.
size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_splash_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...
Inherited from:
Guild.make_splash_url
Generate the guild's splash image URL, if set.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.async def unban(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...Unban the given user from this guild.
user : Snowflakeish[PartialUser]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorclass Guild (
*,
app: traits.RESTAware,
id: snowflakes.Snowflake,
icon_hash: Optional[str],
name: str,
features: Sequence[Union[str, GuildFeature]],
application_id: Optional[snowflakes.Snowflake],
afk_channel_id: Optional[snowflakes.Snowflake],
afk_timeout: datetime.timedelta,
banner_hash: Optional[str],
default_message_notifications: Union[GuildMessageNotificationsLevel, int],
description: Optional[str],
discovery_splash_hash: Optional[str],
explicit_content_filter: Union[GuildExplicitContentFilterLevel, int],
is_widget_enabled: Optional[bool],
max_video_channel_users: Optional[int],
mfa_level: Union[GuildMFALevel, int],
owner_id: snowflakes.Snowflake,
preferred_locale: Union[str, locales.Locale],
premium_subscription_count: Optional[int],
premium_tier: Union[GuildPremiumTier, int],
public_updates_channel_id: Optional[snowflakes.Snowflake],
rules_channel_id: Optional[snowflakes.Snowflake],
splash_hash: Optional[str],
system_channel_flags: GuildSystemChannelFlag,
system_channel_id: Optional[snowflakes.Snowflake],
vanity_url_code: Optional[str],
verification_level: Union[GuildVerificationLevel, int],
widget_channel_id: Optional[snowflakes.Snowflake],
nsfw_level: GuildNSFWLevel,
): ...A representation of a guild on Discord.
Method generated by attrs for class Guild.
class Guild(PartialGuild):
"""A representation of a guild on Discord."""
features: typing.Sequence[typing.Union[str, GuildFeature]] = attr.field(eq=False, hash=False, repr=False)
"""A list of the features in this guild."""
application_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the application that created this guild.
This will always be `builtins.None` for guilds that weren't created by a bot.
"""
afk_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID for the channel that AFK voice users get sent to.
If `builtins.None`, then no AFK channel is set up for this guild.
"""
afk_timeout: datetime.timedelta = attr.field(eq=False, hash=False, repr=False)
"""Timeout for activity before a member is classed as AFK.
How long a voice user has to be AFK for before they are classed as being
AFK and are moved to the AFK channel (`Guild.afk_channel_id`).
"""
banner_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash for the guild's banner.
This is only present if the guild has `GuildFeature.BANNER` in
`Guild.features` for this guild. For all other purposes, it is `builtins.None`.
"""
default_message_notifications: typing.Union[GuildMessageNotificationsLevel, int] = attr.field(
eq=False, hash=False, repr=False
)
"""The default setting for message notifications in this guild."""
description: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The guild's description.
This is only present if certain `GuildFeature`'s are set in
`Guild.features` for this guild. Otherwise, this will always be `builtins.None`.
"""
discovery_splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the discovery splash for the guild, if there is one."""
explicit_content_filter: typing.Union[GuildExplicitContentFilterLevel, int] = attr.field(
eq=False, hash=False, repr=False
)
"""The setting for the explicit content filter in this guild."""
is_widget_enabled: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Describes whether the guild widget is enabled or not.
If this information is not present, this will be `builtins.None`.
"""
max_video_channel_users: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The maximum number of users allowed in a video channel together.
This information may not be present, in which case, it will be `builtins.None`.
"""
mfa_level: typing.Union[GuildMFALevel, int] = attr.field(eq=False, hash=False, repr=False)
"""The required MFA level for users wishing to participate in this guild."""
owner_id: snowflakes.Snowflake = attr.field(eq=False, hash=False, repr=True)
"""The ID of the owner of this guild."""
preferred_locale: typing.Union[str, locales.Locale] = attr.field(eq=False, hash=False, repr=False)
"""The preferred locale to use for this guild.
This can only be change if `GuildFeature.COMMUNITY` is in `Guild.features`
for this guild and will otherwise default to `en-US`.
"""
premium_subscription_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The number of nitro boosts that the server currently has.
This information may not be present, in which case, it will be `builtins.None`.
"""
premium_tier: typing.Union[GuildPremiumTier, int] = attr.field(eq=False, hash=False, repr=False)
"""The premium tier for this guild."""
public_updates_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The channel ID of the channel where admins and moderators receive notices
from Discord.
This is only present if `GuildFeature.COMMUNITY` is in `Guild.features` for
this guild. For all other purposes, it should be considered to be `builtins.None`.
"""
rules_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the channel where guilds with the `GuildFeature.COMMUNITY`
`features` display rules and guidelines.
If the `GuildFeature.COMMUNITY` feature is not defined, then this is `builtins.None`.
"""
splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the splash for the guild, if there is one."""
system_channel_flags: GuildSystemChannelFlag = attr.field(eq=False, hash=False, repr=False)
"""Return flags for the guild system channel.
These are used to describe which notifications are suppressed.
Returns
-------
GuildSystemChannelFlag
The system channel flags for this channel.
"""
system_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the system channel or `builtins.None` if it is not enabled.
Welcome messages and Nitro boost messages may be sent to this channel.
"""
vanity_url_code: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The vanity URL code for the guild's vanity URL.
This is only present if `GuildFeature.VANITY_URL` is in `Guild.features` for
this guild. If not, this will always be `builtins.None`.
"""
verification_level: typing.Union[GuildVerificationLevel, int] = attr.field(eq=False, hash=False, repr=False)
"""The verification level needed for a user to participate in this guild."""
widget_channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The channel ID that the widget's generated invite will send the user to.
If this information is unavailable or this is not enabled for the guild then
this will be `builtins.None`.
"""
nsfw_level: GuildNSFWLevel = attr.field(eq=False, hash=False, repr=False)
"""The NSFW level of the guild."""
@property
def banner_url(self) -> typing.Optional[files.URL]:
"""Banner URL for the guild, if set."""
return self.make_banner_url()
@property
def discovery_splash_url(self) -> typing.Optional[files.URL]:
"""Discovery splash URL for the guild, if set."""
return self.make_discovery_splash_url()
@property
def splash_url(self) -> typing.Optional[files.URL]:
"""Splash URL for the guild, if set."""
return self.make_splash_url()
def get_members(self) -> typing.Mapping[snowflakes.Snowflake, Member]:
"""Get the members cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, Member]
A mapping of user IDs to objects of the members cached for the guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_members_view_for_guild(self.id)
def get_presences(self) -> typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence]:
"""Get the presences cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence]
A mapping of user IDs to objects of the presences cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_presences_view_for_guild(self.id)
def get_channels(self) -> typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel]:
"""Get the channels cached for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.channels.GuildChannel]
A mapping of channel IDs to objects of the channels cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_guild_channels_view_for_guild(self.id)
def get_voice_states(self) -> typing.Mapping[snowflakes.Snowflake, voices_.VoiceState]:
"""Get the voice states cached for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.voices.VoiceState]
A mapping of user IDs to objects of the voice states cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_voice_states_view_for_guild(self.id)
def get_emojis(self) -> typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]:
"""Return the emojis in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
A mapping of emoji IDs to the objects of emojis in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_emojis_view_for_guild(self.id)
def get_stickers(self) -> typing.Mapping[snowflakes.Snowflake, stickers.GuildSticker]:
"""Return the stickers in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.stickers.GuildSticker]
A mapping of sticker IDs to the objects of sticker in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_stickers_view_for_guild(self.id)
def get_roles(self) -> typing.Mapping[snowflakes.Snowflake, Role]:
"""Return the roles in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, Role]
A mapping of role IDs to the objects of roles in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_roles_view_for_guild(self.id)
def make_banner_url(self, *, ext: typing.Optional[str] = None, size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's banner image URL, if set.
Parameters
----------
ext : typing.Optional[builtins.str]
The ext to use for this URL, defaults to `png` or `gif`.
Supports `png`, `jpeg`, `jpg`, `webp` and `gif` (when
animated).
If `builtins.None`, then the correct default extension is
determined based on whether the banner is animated or not.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL of the banner, or `builtins.None` if no banner is set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.banner_hash is None:
return None
if ext is None:
if self.banner_hash.startswith("a_"):
ext = "gif"
else:
ext = "png"
return routes.CDN_GUILD_BANNER.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.banner_hash,
size=size,
file_format=ext,
)
def make_discovery_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's discovery splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The string URL.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.discovery_splash_hash is None:
return None
return routes.CDN_GUILD_DISCOVERY_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.discovery_splash_hash,
size=size,
file_format=ext,
)
def make_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the splash, or `builtins.None` if not set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.splash_hash is None:
return None
return routes.CDN_GUILD_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.splash_hash,
size=size,
file_format=ext,
)
def get_channel(
self,
channel: snowflakes.SnowflakeishOr[channels_.PartialChannel],
) -> typing.Optional[channels_.GuildChannel]:
"""Get a cached channel that belongs to the guild by it's ID or object.
Parameters
----------
channel : hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]
The object or ID of the guild channel to get from the cache.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The object of the guild channel found in cache or `builtins.None.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_guild_channel(channel)
def get_member(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -> typing.Optional[Member]:
"""Get a cached member that belongs to the guild by it's user ID or object.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached member for.
Returns
-------
typing.Optional[Member]
The cached member object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_member(self.id, user)
def get_my_member(self) -> typing.Optional[Member]:
"""Return the cached member for the bot user in this guild, if known.
Returns
-------
typing.Optional[Member]
The cached member for this guild, or `builtins.None` if not known.
"""
if not isinstance(self.app, traits.ShardAware):
return None
me = self.app.get_me()
if me is None:
return None
return self.get_member(me.id)
def get_presence(
self, user: snowflakes.SnowflakeishOr[users.PartialUser]
) -> typing.Optional[presences_.MemberPresence]:
"""Get a cached presence that belongs to the guild by it's user ID or object.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached presence for.
Returns
-------
typing.Optional[hikari.presences.MemberPresence]
The cached presence object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_presence(self.id, user)
def get_voice_state(
self, user: snowflakes.SnowflakeishOr[users.PartialUser]
) -> typing.Optional[voices_.VoiceState]:
"""Get a cached voice state that belongs to the guild by it's user.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached voice state for.
Returns
-------
typing.Optional[hikari.voices.VoiceState]
The cached voice state object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_voice_state(self.id, user)
def get_emoji(
self, emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji]
) -> typing.Optional[emojis_.KnownCustomEmoji]:
"""Get a cached emoji that belongs to the guild by it's ID or object.
Parameters
----------
emoji : hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]
The object or ID of the emoji to get from the cache.
Returns
-------
typing.Optional[hikari.emojis.KnownCustomEmoji]
The object of the custom emoji if found in cache, else
`builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_emoji(emoji)
def get_sticker(
self, sticker: snowflakes.SnowflakeishOr[stickers.GuildSticker]
) -> typing.Optional[stickers.GuildSticker]:
"""Get a cached sticker that belongs to the guild by it's ID or object.
Parameters
----------
sticker : hikari.snowflakes.SnowflakeishOr[hikari.stickers.GuildSticker]
The object or ID of the sticker to get from the cache.
Returns
-------
typing.Optional[hikari.stickers.GuildSticker]
The object of the sticker if found in cache, else
`builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_sticker(sticker)
def get_role(self, role: snowflakes.SnowflakeishOr[PartialRole]) -> typing.Optional[Role]:
"""Get a cached role that belongs to the guild by it's ID or object.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[PartialRole]
The object or ID of the role to get for this guild from the cache.
Returns
-------
typing.Optional[Role]
The object of the role found in cache, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_role(role)
async def fetch_owner(self) -> Member:
"""Fetch the owner of the guild.
Returns
-------
hikari.guilds.Member
The guild owner.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or the user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_member(self.id, self.owner_id)
async def fetch_widget_channel(self) -> typing.Optional[channels_.GuildChannel]:
"""Fetch the widget channel.
This will be `builtins.None` if not set.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The channel the widget is linked to or else `builtins.None`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.widget_channel_id:
return None
widget_channel = await self.app.rest.fetch_channel(self.widget_channel_id)
assert isinstance(widget_channel, channels_.GuildChannel)
return widget_channel
async def fetch_afk_channel(self) -> typing.Optional[channels_.GuildVoiceChannel]:
"""Fetch the channel that AFK voice users get sent to.
Returns
-------
typing.Optional[hikari.channels.GuildVoiceChannel]
The AFK channel or `builtins.None` if not enabled.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.afk_channel_id:
return None
afk_channel = await self.app.rest.fetch_channel(self.afk_channel_id)
assert isinstance(afk_channel, channels_.GuildVoiceChannel)
return afk_channel
async def fetch_system_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch the system channel.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The system channel for this guild or `builtins.None` if not
enabled.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.system_channel_id:
return None
system_channel = await self.app.rest.fetch_channel(self.system_channel_id)
assert isinstance(system_channel, channels_.GuildTextChannel)
return system_channel
async def fetch_rules_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch the channel where guilds display rules and guidelines.
If the `GuildFeature.COMMUNITY` feature is not defined, then this is `builtins.None`.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The channel where the rules of the guild are specified or else `builtins.None`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.rules_channel_id:
return None
rules_channel = await self.app.rest.fetch_channel(self.rules_channel_id)
assert isinstance(rules_channel, channels_.GuildTextChannel)
return rules_channel
async def fetch_public_updates_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if `GuildFeature.COMMUNITY` is in `Guild.features` for
this guild. For all other purposes, it should be considered to be `builtins.None`.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The channel where discord sends relevant updates to moderators and admins.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.public_updates_channel_id:
return None
updates_channel = await self.app.rest.fetch_channel(self.public_updates_channel_id)
assert isinstance(updates_channel, channels_.GuildTextChannel)
return updates_channelGuild specialization that is sent via the gateway only …
Guild specialization that is sent via the REST API only …
Base object for any partial guild objects …
Mixin for a class that enforces uniqueness by a snowflake ID.
Helper class that provides a standard way to create an ABC using inheritance.
property afk_channel_id : Optional[snowflakes.Snowflake]The ID for the channel that AFK voice users get sent to.
If None, then no AFK channel is set up for this guild.
property afk_timeout : datetime.timedeltaTimeout for activity before a member is classed as AFK.
How long a voice user has to be AFK for before they are classed as being
AFK and are moved to the AFK channel (afk_channel_id).
property app : traits.RESTAwareThe client application that models may use for procedures.
property application_id : Optional[snowflakes.Snowflake]The ID of the application that created this guild.
This will always be None for guilds that weren't created by a bot.
property created_at : datetime.datetimeWhen the object was created.
property default_message_notifications : Union[GuildMessageNotificationsLevel, int]The default setting for message notifications in this guild.
property description : Optional[str]The guild's description.
This is only present if certain GuildFeature's are set in
features for this guild. Otherwise, this will always be None.
property discovery_splash_hash : Optional[str]The hash of the discovery splash for the guild, if there is one.
property discovery_splash_url : Optional[files.URL]Discovery splash URL for the guild, if set.
property explicit_content_filter : Union[GuildExplicitContentFilterLevel, int]The setting for the explicit content filter in this guild.
property features : Sequence[Union[str, GuildFeature]]A list of the features in this guild.
property id : snowflakes.SnowflakeThe ID of this entity.
property is_widget_enabled : Optional[bool]Describes whether the guild widget is enabled or not.
If this information is not present, this will be None.
property max_video_channel_users : Optional[int]The maximum number of users allowed in a video channel together.
This information may not be present, in which case, it will be None.
property mfa_level : Union[GuildMFALevel, int]The required MFA level for users wishing to participate in this guild.
property nsfw_level : GuildNSFWLevelThe NSFW level of the guild.
property owner_id : snowflakes.SnowflakeThe ID of the owner of this guild.
property preferred_locale : Union[str, locales.Locale]The preferred locale to use for this guild.
This can only be change if COMMUNITY is in features
for this guild and will otherwise default to en-US.
property public_updates_channel_id : Optional[snowflakes.Snowflake]The channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if COMMUNITY is in features for
this guild. For all other purposes, it should be considered to be None.
property rules_channel_id : Optional[snowflakes.Snowflake]The ID of the channel where guilds with the COMMUNITY
features display rules and guidelines.
property shard_id : Optional[int]Return the ID of the shard this guild is served by.
This may return None if the application does not have a gateway
connection.
property splash_hash : Optional[str]The hash of the splash for the guild, if there is one.
property splash_url : Optional[files.URL]Splash URL for the guild, if set.
property system_channel_flags : GuildSystemChannelFlagReturn flags for the guild system channel.
These are used to describe which notifications are suppressed.
GuildSystemChannelFlagproperty system_channel_id : Optional[snowflakes.Snowflake]The ID of the system channel or None if it is not enabled.
Welcome messages and Nitro boost messages may be sent to this channel.
property vanity_url_code : Optional[str]The vanity URL code for the guild's vanity URL.
This is only present if VANITY_URL is in features for
this guild. If not, this will always be None.
property verification_level : Union[GuildVerificationLevel, int]The verification level needed for a user to participate in this guild.
property widget_channel_id : Optional[snowflakes.Snowflake]The channel ID that the widget's generated invite will send the user to.
If this information is unavailable or this is not enabled for the guild then
this will be None.
async def ban(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
delete_message_days: undefined.UndefinedOr[int] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.ban
Ban the given user from this guild.
user : Snowflakeish[PartialUser]delete_message_days : UndefinedNoneOr[int]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_category(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildCategory: ...
Inherited from:
PartialGuild.create_category
Create a category in the guild.
name : strposition : UndefinedOr[int]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]reason : UndefinedOr[str]GuildCategoryBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_news_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
topic: undefined.UndefinedOr[str] = UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildNewsChannel: ...
Inherited from:
PartialGuild.create_news_channel
Create a news channel in the guild.
name : strposition : UndefinedOr[int]topic : UndefinedOr[str]nsfw : UndefinedOr[bool]rate_limit_per_user : UndefinedOr[Intervalish]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildNewsChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_stage_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
user_limit: undefined.UndefinedOr[int] = UNDEFINED,
bitrate: undefined.UndefinedOr[int] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
region: undefined.UndefinedOr[Union[voices_.VoiceRegion, str]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> channels_.GuildStageChannel: ...
Inherited from:
PartialGuild.create_stage_channel
Create a stage channel in the guild.
name : strposition : UndefinedOr[int]user_limit : UndefinedOr[int]bitrate : UndefinedOr[int]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]region : UndefinedOr[Union[VoiceRegion, str]]None here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildStageChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_sticker(
name: str,
tag: str,
image: files.Resourceish,
*,
description: undefined.UndefinedOr[str] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> stickers.GuildSticker: ...
Inherited from:
PartialGuild.create_sticker
Create a sticker in a guild.
name : strtag : strimage : ResourceishThe 320x320 image for the sticker. Maximum upload size is 500kb. This can be a still or an animated PNG or a Lottie.
Note
Lottie support is only available for verified and partnered servers.
description : UndefinedOr[str]reason : UndefinedOr[str]GuildStickerBadRequestErrorForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_text_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
topic: undefined.UndefinedOr[str] = UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildTextChannel: ...
Inherited from:
PartialGuild.create_text_channel
Create a text channel in the guild.
name : strposition : UndefinedOr[int]topic : UndefinedOr[str]nsfw : UndefinedOr[bool]rate_limit_per_user : UndefinedOr[Intervalish]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildTextChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_voice_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
user_limit: undefined.UndefinedOr[int] = UNDEFINED,
bitrate: undefined.UndefinedOr[int] = UNDEFINED,
video_quality_mode: undefined.UndefinedOr[Union[channels_.VideoQualityMode, int]] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
region: undefined.UndefinedOr[Union[voices_.VoiceRegion, str]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> channels_.GuildVoiceChannel: ...
Inherited from:
PartialGuild.create_voice_channel
Create a voice channel in a guild.
guild : SnowflakeishOr[PartialGuild]name : strposition : UndefinedOr[int]user_limit : UndefinedOr[int]bitrate : UndefinedOr[int]video_quality_mode : UndefinedOr[Union[VideoQualityMode, int]]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]region : UndefinedOr[Union[VoiceRegion, str]]None here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildVoiceChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def delete_channel(
channel: snowflakes.SnowflakeishOr[channels_.GuildChannel],
) -> GuildChannel: ...
Inherited from:
PartialGuild.delete_channel
Delete a channel in the guild.
Note
This method can also be used for deleting guild categories as well.
channel : SnowflakeishOr[GuildChannel]GuildChannelForbiddenErrorMANAGE_CHANNEL permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorNote
For Public servers, the set 'Rules' or 'Guidelines' channels and the 'Public Server Updates' channel cannot be deleted.
async def delete_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.delete_sticker
Delete a sticker in a guild.
sticker : SnowflakeishOr[PartialSticker]reason : UndefinedOr[str]ForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit(
*,
name: undefined.UndefinedOr[str] = UNDEFINED,
verification_level: undefined.UndefinedOr[GuildVerificationLevel] = UNDEFINED,
default_message_notifications: undefined.UndefinedOr[GuildMessageNotificationsLevel] = UNDEFINED,
explicit_content_filter_level: undefined.UndefinedOr[GuildExplicitContentFilterLevel] = UNDEFINED,
afk_channel: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]] = UNDEFINED,
afk_timeout: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
icon: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = UNDEFINED,
splash: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
banner: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
system_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
rules_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
public_updates_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
preferred_locale: undefined.UndefinedOr[Union[str, locales.Locale]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> RESTGuild: ...
Inherited from:
PartialGuild.edit
Edits the guild.
name : UndefinedOr[str]verification_level : UndefinedOr[GuildVerificationLevel]default_message_notifications : UndefinedOr[GuildMessageNotificationsLevel]explicit_content_filter_level : UndefinedOr[GuildExplicitContentFilterLevel]afk_channel : UndefinedOr[SnowflakeishOr[GuildVoiceChannel]]afk_timeout to
be set to work.afk_timeout : UndefinedOr[Intervalish]icon : UndefinedOr[Resourceish]ANIMATED_ICON feature.owner : UndefinedOr[SnowflakeishOr[PartialUser]]]If provided, the new guild owner.
Warning
You need to be the owner of the server to use this.
splash : UndefinedNoneOr[Resourceish]INVITE_SPLASH feature.banner : UndefinedNoneOr[Resourceish]BANNER feature.system_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]rules_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]public_updates_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]preferred_locale : UndefinedNoneOr[str]reason : UndefinedOr[str]RESTGuildBadRequestErrorForbiddenErrorMANAGE_GUILD permission or if you tried to
pass ownership without being the server owner.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
name: undefined.UndefinedOr[str] = UNDEFINED,
description: undefined.UndefinedOr[str] = UNDEFINED,
tag: undefined.UndefinedOr[str] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildSticker: ...
Inherited from:
PartialGuild.edit_sticker
Edit a sticker in a guild.
sticker : SnowflakeishOr[PartialSticker]name : UndefinedOr[str]description : UndefinedOr[str]tag : UndefinedOr[str]reason : UndefinedOr[str]GuildStickerBadRequestErrorForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_afk_channel() -> Optional[GuildVoiceChannel]: ...Fetch the channel that AFK voice users get sent to.
Optional[GuildVoiceChannel]None if not enabled.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_afk_channel(self) -> typing.Optional[channels_.GuildVoiceChannel]:
"""Fetch the channel that AFK voice users get sent to.
Returns
-------
typing.Optional[hikari.channels.GuildVoiceChannel]
The AFK channel or `builtins.None` if not enabled.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.afk_channel_id:
return None
afk_channel = await self.app.rest.fetch_channel(self.afk_channel_id)
assert isinstance(afk_channel, channels_.GuildVoiceChannel)
return afk_channelasync def fetch_emoji(
emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji],
) -> emojis_.KnownCustomEmoji: ...
Inherited from:
PartialGuild.fetch_emoji
Fetch an emoji from the guild.
emoji : SnowflakeishOr[CustomEmoji]CustomEmoji
or the ID of an existing emoji.KnownCustomEmojiNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_emojis() -> Sequence[emojis_.KnownCustomEmoji]: ...
Inherited from:
PartialGuild.fetch_emojis
Fetch the emojis of the guild.
Sequence[KnownCustomEmoji]NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_owner() -> Member: ...Fetch the owner of the guild.
MemberUnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_owner(self) -> Member:
"""Fetch the owner of the guild.
Returns
-------
hikari.guilds.Member
The guild owner.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or the user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.app.rest.fetch_member(self.id, self.owner_id)async def fetch_public_updates_channel() -> Optional[GuildTextChannel]: ...Fetch channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if COMMUNITY is in features for
this guild. For all other purposes, it should be considered to be None.
Optional[GuildTextChannel]UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_public_updates_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch channel ID of the channel where admins and moderators receive notices from Discord.
This is only present if `GuildFeature.COMMUNITY` is in `Guild.features` for
this guild. For all other purposes, it should be considered to be `builtins.None`.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The channel where discord sends relevant updates to moderators and admins.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.public_updates_channel_id:
return None
updates_channel = await self.app.rest.fetch_channel(self.public_updates_channel_id)
assert isinstance(updates_channel, channels_.GuildTextChannel)
return updates_channelasync def fetch_roles() -> Sequence[Role]: ...
Inherited from:
PartialGuild.fetch_roles
Fetch the roles of the guild.
UnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_rules_channel() -> Optional[GuildTextChannel]: ...Fetch the channel where guilds display rules and guidelines.
If the COMMUNITY feature is not defined, then this is None.
Optional[GuildTextChannel]None.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_rules_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch the channel where guilds display rules and guidelines.
If the `GuildFeature.COMMUNITY` feature is not defined, then this is `builtins.None`.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The channel where the rules of the guild are specified or else `builtins.None`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.rules_channel_id:
return None
rules_channel = await self.app.rest.fetch_channel(self.rules_channel_id)
assert isinstance(rules_channel, channels_.GuildTextChannel)
return rules_channelasync def fetch_self() -> RESTGuild: ...
Inherited from:
PartialGuild.fetch_self
Fetch the guild.
RESTGuildForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
) -> GuildSticker: ...
Inherited from:
PartialGuild.fetch_sticker
Fetch a sticker from the guild.
sticker : snowflakes.SnowflakeishOr[PartialSticker]GuildStickerForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_stickers() -> Sequence[GuildSticker]: ...
Inherited from:
PartialGuild.fetch_stickers
Fetch the stickers of the guild.
Sequence[GuildSticker]ForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_system_channel() -> Optional[GuildTextChannel]: ...Fetch the system channel.
Optional[GuildTextChannel]None if not
enabled.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_system_channel(self) -> typing.Optional[channels_.GuildTextChannel]:
"""Fetch the system channel.
Returns
-------
typing.Optional[hikari.channels.GuildTextChannel]
The system channel for this guild or `builtins.None` if not
enabled.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.system_channel_id:
return None
system_channel = await self.app.rest.fetch_channel(self.system_channel_id)
assert isinstance(system_channel, channels_.GuildTextChannel)
return system_channelasync def fetch_widget_channel() -> Optional[GuildChannel]: ...Fetch the widget channel.
This will be None if not set.
Optional[GuildChannel]None.UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_widget_channel(self) -> typing.Optional[channels_.GuildChannel]:
"""Fetch the widget channel.
This will be `builtins.None` if not set.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The channel the widget is linked to or else `builtins.None`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.widget_channel_id:
return None
widget_channel = await self.app.rest.fetch_channel(self.widget_channel_id)
assert isinstance(widget_channel, channels_.GuildChannel)
return widget_channeldef get_channel(
channel: snowflakes.SnowflakeishOr[channels_.PartialChannel],
) -> Optional[GuildChannel]: ...Get a cached channel that belongs to the guild by it's ID or object.
channel : SnowflakeishOr[PartialChannel]Optional[GuildChannel]def get_channel(
self,
channel: snowflakes.SnowflakeishOr[channels_.PartialChannel],
) -> typing.Optional[channels_.GuildChannel]:
"""Get a cached channel that belongs to the guild by it's ID or object.
Parameters
----------
channel : hikari.snowflakes.SnowflakeishOr[hikari.channels.PartialChannel]
The object or ID of the guild channel to get from the cache.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The object of the guild channel found in cache or `builtins.None.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_guild_channel(channel)def get_channels() -> Mapping[Snowflake, GuildChannel]: ...Get the channels cached for the guild.
Mapping[Snowflake, GuildChannel]def get_channels(self) -> typing.Mapping[snowflakes.Snowflake, channels_.GuildChannel]:
"""Get the channels cached for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.channels.GuildChannel]
A mapping of channel IDs to objects of the channels cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_guild_channels_view_for_guild(self.id)def get_emoji(
emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji],
) -> Optional[emojis_.KnownCustomEmoji]: ...Get a cached emoji that belongs to the guild by it's ID or object.
emoji : SnowflakeishOr[CustomEmoji]Optional[KnownCustomEmoji]None.def get_emoji(
self, emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji]
) -> typing.Optional[emojis_.KnownCustomEmoji]:
"""Get a cached emoji that belongs to the guild by it's ID or object.
Parameters
----------
emoji : hikari.snowflakes.SnowflakeishOr[hikari.emojis.CustomEmoji]
The object or ID of the emoji to get from the cache.
Returns
-------
typing.Optional[hikari.emojis.KnownCustomEmoji]
The object of the custom emoji if found in cache, else
`builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_emoji(emoji)def get_emojis() -> Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]: ...Return the emojis in this guild.
Mapping[Snowflake, KnownCustomEmoji]def get_emojis(self) -> typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]:
"""Return the emojis in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.emojis.KnownCustomEmoji]
A mapping of emoji IDs to the objects of emojis in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_emojis_view_for_guild(self.id)def get_member(
user: snowflakes.SnowflakeishOr[users.PartialUser],
) -> Optional[Member]: ...Get a cached member that belongs to the guild by it's user ID or object.
user : SnowflakeishOr[PartialUser]def get_member(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -> typing.Optional[Member]:
"""Get a cached member that belongs to the guild by it's user ID or object.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached member for.
Returns
-------
typing.Optional[Member]
The cached member object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_member(self.id, user)def get_members() -> Mapping[Snowflake, Member]: ...Get the members cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, Member] A mapping of user IDs to objects of the members cached for the guild.
def get_members(self) -> typing.Mapping[snowflakes.Snowflake, Member]:
"""Get the members cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, Member]
A mapping of user IDs to objects of the members cached for the guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_members_view_for_guild(self.id)def get_my_member() -> Optional[Member]: ...Return the cached member for the bot user in this guild, if known.
def get_my_member(self) -> typing.Optional[Member]:
"""Return the cached member for the bot user in this guild, if known.
Returns
-------
typing.Optional[Member]
The cached member for this guild, or `builtins.None` if not known.
"""
if not isinstance(self.app, traits.ShardAware):
return None
me = self.app.get_me()
if me is None:
return None
return self.get_member(me.id)def get_presence(
user: snowflakes.SnowflakeishOr[users.PartialUser],
) -> Optional[presences_.MemberPresence]: ...Get a cached presence that belongs to the guild by it's user ID or object.
user : SnowflakeishOr[PartialUser]Optional[MemberPresence]None.def get_presence(
self, user: snowflakes.SnowflakeishOr[users.PartialUser]
) -> typing.Optional[presences_.MemberPresence]:
"""Get a cached presence that belongs to the guild by it's user ID or object.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached presence for.
Returns
-------
typing.Optional[hikari.presences.MemberPresence]
The cached presence object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_presence(self.id, user)def get_presences() -> Mapping[snowflakes.Snowflake, presences_.MemberPresence]: ...Get the presences cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence] A mapping of user IDs to objects of the presences cached for the guild.
def get_presences(self) -> typing.Mapping[snowflakes.Snowflake, presences_.MemberPresence]:
"""Get the presences cached for the guild.
typing.Mapping[hikari.snowflakes.Snowflake, hikari.presences.MemberPresence]
A mapping of user IDs to objects of the presences cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_presences_view_for_guild(self.id)def get_role(
role: snowflakes.SnowflakeishOr[PartialRole],
) -> Optional[Role]: ...Get a cached role that belongs to the guild by it's ID or object.
role : SnowflakeishOr[PartialRole]def get_role(self, role: snowflakes.SnowflakeishOr[PartialRole]) -> typing.Optional[Role]:
"""Get a cached role that belongs to the guild by it's ID or object.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[PartialRole]
The object or ID of the role to get for this guild from the cache.
Returns
-------
typing.Optional[Role]
The object of the role found in cache, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_role(role)def get_roles() -> Mapping[Snowflake, Role]: ...Return the roles in this guild.
def get_roles(self) -> typing.Mapping[snowflakes.Snowflake, Role]:
"""Return the roles in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, Role]
A mapping of role IDs to the objects of roles in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_roles_view_for_guild(self.id)def get_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.GuildSticker],
) -> Optional[GuildSticker]: ...Get a cached sticker that belongs to the guild by it's ID or object.
sticker : SnowflakeishOr[GuildSticker]Optional[GuildSticker]None.def get_sticker(
self, sticker: snowflakes.SnowflakeishOr[stickers.GuildSticker]
) -> typing.Optional[stickers.GuildSticker]:
"""Get a cached sticker that belongs to the guild by it's ID or object.
Parameters
----------
sticker : hikari.snowflakes.SnowflakeishOr[hikari.stickers.GuildSticker]
The object or ID of the sticker to get from the cache.
Returns
-------
typing.Optional[hikari.stickers.GuildSticker]
The object of the sticker if found in cache, else
`builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_sticker(sticker)def get_stickers() -> Mapping[Snowflake, GuildSticker]: ...Return the stickers in this guild.
Mapping[Snowflake, GuildSticker]def get_stickers(self) -> typing.Mapping[snowflakes.Snowflake, stickers.GuildSticker]:
"""Return the stickers in this guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.stickers.GuildSticker]
A mapping of sticker IDs to the objects of sticker in this guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_stickers_view_for_guild(self.id)def get_voice_state(
user: snowflakes.SnowflakeishOr[users.PartialUser],
) -> Optional[voices_.VoiceState]: ...Get a cached voice state that belongs to the guild by it's user.
user : SnowflakeishOr[PartialUser]Optional[VoiceState]None.def get_voice_state(
self, user: snowflakes.SnowflakeishOr[users.PartialUser]
) -> typing.Optional[voices_.VoiceState]:
"""Get a cached voice state that belongs to the guild by it's user.
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The object or ID of the user to get the cached voice state for.
Returns
-------
typing.Optional[hikari.voices.VoiceState]
The cached voice state object if found, else `builtins.None`.
"""
if not isinstance(self.app, traits.CacheAware):
return None
return self.app.cache.get_voice_state(self.id, user)def get_voice_states() -> Mapping[snowflakes.Snowflake, voices_.VoiceState]: ...Get the voice states cached for the guild.
Mapping[Snowflake, VoiceState]def get_voice_states(self) -> typing.Mapping[snowflakes.Snowflake, voices_.VoiceState]:
"""Get the voice states cached for the guild.
Returns
-------
typing.Mapping[hikari.snowflakes.Snowflake, hikari.voices.VoiceState]
A mapping of user IDs to objects of the voice states cached for the
guild.
"""
if not isinstance(self.app, traits.CacheAware):
return {}
return self.app.cache.get_voice_states_view_for_guild(self.id)async def kick(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.kick
Kicks the given user from this guild.
user : Snowflakeish[PartialUser]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorKICK_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrordef make_discovery_splash_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...Generate the guild's discovery splash image URL, if set.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_discovery_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's discovery splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The string URL.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.discovery_splash_hash is None:
return None
return routes.CDN_GUILD_DISCOVERY_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.discovery_splash_hash,
size=size,
file_format=ext,
)def make_icon_url(
*,
ext: Optional[str] = None,
size: int = 4096,
) -> Optional[files.URL]: ...
Inherited from:
PartialGuild.make_icon_url
Generate the guild's icon URL, if set.
ext : Optional[str]The extension to use for this URL, defaults to png or gif.
Supports png, jpeg, jpg, webp and gif (when
animated).
If None, then the correct default extension is
determined based on whether the icon is animated or not.
size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_splash_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...Generate the guild's splash image URL, if set.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the splash, or `builtins.None` if not set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.splash_hash is None:
return None
return routes.CDN_GUILD_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.splash_hash,
size=size,
file_format=ext,
)async def unban(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.unban
Unban the given user from this guild.
user : Snowflakeish[PartialUser]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorclass GuildBan (
*,
reason: Optional[str],
user: users.User,
): ...Used to represent guild bans.
Method generated by attrs for class GuildBan.
class GuildBan:
"""Used to represent guild bans."""
reason: typing.Optional[str] = attr.field(repr=True)
"""The reason for this ban, will be `builtins.None` if no reason was given."""
user: users.User = attr.field(repr=True)
"""The object of the user this ban targets."""class GuildExplicitContentFilterLevel (
value: Any,
): ...Represents the explicit content filter setting for a guild.
class GuildExplicitContentFilterLevel(int, enums.Enum):
"""Represents the explicit content filter setting for a guild."""
DISABLED = 0
"""No explicit content filter."""
MEMBERS_WITHOUT_ROLES = 1
"""Filter posts from anyone without a role."""
ALL_MEMBERS = 2
"""Filter all posts."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const ALL_MEMBERS = 2Filter all posts.
const DISABLED = 0No explicit content filter.
const MEMBERS_WITHOUT_ROLES = 1Filter posts from anyone without a role.
class GuildFeature (
value: Any,
): ...Features that a guild can provide.
class GuildFeature(str, enums.Enum):
"""Features that a guild can provide."""
ANIMATED_ICON = "ANIMATED_ICON"
"""Guild has access to set an animated guild icon."""
BANNER = "BANNER"
"""Guild has access to set a guild banner image."""
COMMERCE = "COMMERCE"
"""Guild has access to use commerce features (i.e. create store channels)."""
COMMUNITY = "COMMUNITY"
"""Guild has community features enabled."""
DISCOVERABLE = "DISCOVERABLE"
"""Guild is able to be discovered in the directory.
This also implies the guild can be viewed without joining.
"""
FEATURABLE = "FEATURABLE"
"""Guild is able to be featured in the directory."""
INVITE_SPLASH = "INVITE_SPLASH"
"""Guild has access to set an invite splash background."""
MORE_EMOJI = "MORE_EMOJI"
"""More emojis can be hosted in this guild than normal."""
NEWS = "NEWS"
"""Guild has access to create news channels."""
PARTNERED = "PARTNERED"
"""Guild is partnered."""
RELAY_ENABLED = "RELAY_ENABLED"
"""Guild is using relays.
Relays are new infrastructure designed to handle large guilds more
efficiently server-side.
"""
VANITY_URL = "VANITY_URL"
"""Guild has access to set a vanity URL."""
VERIFIED = "VERIFIED"
"""Guild is verified."""
VIP_REGIONS = "VIP_REGIONS"
"""Guild has access to set 384kbps bitrate in voice.
Previously gave access to VIP voice servers.
"""
WELCOME_SCREEN_ENABLED = "WELCOME_SCREEN_ENABLED"
"""Guild has enabled the welcome screen."""
MEMBER_VERIFICATION_GATE_ENABLED = "MEMBER_VERIFICATION_GATE_ENABLED"
"""Guild has enabled Membership Screening."""
PREVIEW_ENABLED = "PREVIEW_ENABLED"
"""Guild can be viewed before Membership Screening is complete."""
TICKETED_EVENTS_ENABLED = "TICKETED_EVENTS_ENABLED"
"""Guild has enabled ticketed events."""
MONETIZATION_ENABLED = "MONETIZATION_ENABLED"
"""Guild has enabled monetization."""
MORE_STICKERS = "MORE_STICKERS"
"""Guild has an increased custom stickers slots."""str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const ANIMATED_ICON = 'ANIMATED_ICON'Guild has access to set an animated guild icon.
const BANNER = 'BANNER'Guild has access to set a guild banner image.
const COMMERCE = 'COMMERCE'Guild has access to use commerce features (i.e. create store channels).
const COMMUNITY = 'COMMUNITY'Guild has community features enabled.
const DISCOVERABLE = 'DISCOVERABLE'Guild is able to be discovered in the directory.
This also implies the guild can be viewed without joining.
const FEATURABLE = 'FEATURABLE'Guild is able to be featured in the directory.
const INVITE_SPLASH = 'INVITE_SPLASH'Guild has access to set an invite splash background.
const MEMBER_VERIFICATION_GATE_ENABLED = 'MEMBER_VERIFICATION_GATE_ENABLED'Guild has enabled Membership Screening.
const MONETIZATION_ENABLED = 'MONETIZATION_ENABLED'Guild has enabled monetization.
const MORE_EMOJI = 'MORE_EMOJI'More emojis can be hosted in this guild than normal.
const MORE_STICKERS = 'MORE_STICKERS'Guild has an increased custom stickers slots.
const NEWS = 'NEWS'Guild has access to create news channels.
const PARTNERED = 'PARTNERED'Guild is partnered.
const PREVIEW_ENABLED = 'PREVIEW_ENABLED'Guild can be viewed before Membership Screening is complete.
const RELAY_ENABLED = 'RELAY_ENABLED'Guild is using relays.
Relays are new infrastructure designed to handle large guilds more efficiently server-side.
const TICKETED_EVENTS_ENABLED = 'TICKETED_EVENTS_ENABLED'Guild has enabled ticketed events.
const VANITY_URL = 'VANITY_URL'Guild has access to set a vanity URL.
const VERIFIED = 'VERIFIED'Guild is verified.
const VIP_REGIONS = 'VIP_REGIONS'Guild has access to set 384kbps bitrate in voice.
Previously gave access to VIP voice servers.
const WELCOME_SCREEN_ENABLED = 'WELCOME_SCREEN_ENABLED'Guild has enabled the welcome screen.
class GuildMFALevel (
value: Any,
): ...Represents the multi-factor authorization requirement for a guild.
class GuildMFALevel(int, enums.Enum):
"""Represents the multi-factor authorization requirement for a guild."""
NONE = 0
"""No MFA requirement."""
ELEVATED = 1
"""MFA requirement."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
class GuildMessageNotificationsLevel (
value: Any,
): ...Represents the default notification level for new messages in a guild.
class GuildMessageNotificationsLevel(int, enums.Enum):
"""Represents the default notification level for new messages in a guild."""
ALL_MESSAGES = 0
"""Notify users when any message is sent."""
ONLY_MENTIONS = 1
"""Only notify users when they are @mentioned."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const ALL_MESSAGES = 0Notify users when any message is sent.
const ONLY_MENTIONS = 1Only notify users when they are @mentioned.
class GuildNSFWLevel (
value: Any,
): ...Represents the NSFW level of a guild.
class GuildNSFWLevel(int, enums.Enum):
"""Represents the NSFW level of a guild."""
DEFAULT = 0
"""Guild has not been categorized yet."""
EXPLICIT = 1
"""Guild contains explicit NSFW content."""
SAFE = 2
"""Guild is safe of NSFW content."""
AGE_RESTRICTED = 3
"""Guild may contain NSFW content."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const AGE_RESTRICTED = 3Guild may contain NSFW content.
const DEFAULT = 0Guild has not been categorized yet.
const EXPLICIT = 1Guild contains explicit NSFW content.
const SAFE = 2Guild is safe of NSFW content.
class GuildPremiumTier (
value: Any,
): ...Tier for Discord Nitro boosting in a guild.
class GuildPremiumTier(int, enums.Enum):
"""Tier for Discord Nitro boosting in a guild."""
NONE = 0
"""No Nitro boost level."""
TIER_1 = 1
"""Level 1 Nitro boost."""
TIER_2 = 2
"""Level 2 Nitro boost."""
TIER_3 = 3
"""Level 3 Nitro boost."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
class GuildPreview (
*,
app: traits.RESTAware,
id: snowflakes.Snowflake,
icon_hash: Optional[str],
name: str,
features: Sequence[Union[str, GuildFeature]],
splash_hash: Optional[str],
discovery_splash_hash: Optional[str],
emojis: Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji],
approximate_active_member_count: int,
approximate_member_count: int,
description: Optional[str],
): ...A preview of a guild with the DISCOVERABLE feature.
Method generated by attrs for class GuildPreview.
class GuildPreview(PartialGuild):
"""A preview of a guild with the `GuildFeature.DISCOVERABLE` feature."""
features: typing.Sequence[typing.Union[str, GuildFeature]] = attr.field(eq=False, hash=False, repr=False)
"""A list of the features in this guild."""
splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the splash for the guild, if there is one."""
discovery_splash_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The hash of the discovery splash for the guild, if there is one."""
emojis: typing.Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji] = attr.field(
eq=False, hash=False, repr=False
)
"""The mapping of IDs to the emojis this guild provides."""
approximate_active_member_count: int = attr.field(eq=False, hash=False, repr=True)
"""The approximate amount of presences in this guild."""
approximate_member_count: int = attr.field(eq=False, hash=False, repr=True)
"""The approximate amount of members in this guild."""
description: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""The guild's description, if set."""
@property
def discovery_splash_url(self) -> typing.Optional[files.URL]:
"""Discovery URL splash for the guild, if set."""
return self.make_discovery_splash_url()
@property
def splash_url(self) -> typing.Optional[files.URL]:
"""Splash URL for the guild, if set."""
return self.make_splash_url()
def make_discovery_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's discovery splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The string URL.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.discovery_splash_hash is None:
return None
return routes.CDN_GUILD_DISCOVERY_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.discovery_splash_hash,
size=size,
file_format=ext,
)
def make_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the splash, or `builtins.None` if not set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.splash_hash is None:
return None
return routes.CDN_GUILD_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.splash_hash,
size=size,
file_format=ext,
)Base object for any partial guild objects …
Mixin for a class that enforces uniqueness by a snowflake ID.
Helper class that provides a standard way to create an ABC using inheritance.
property app : traits.RESTAwareThe client application that models may use for procedures.
property approximate_active_member_count : intThe approximate amount of presences in this guild.
property approximate_member_count : intThe approximate amount of members in this guild.
property created_at : datetime.datetimeWhen the object was created.
property description : Optional[str]The guild's description, if set.
property discovery_splash_hash : Optional[str]The hash of the discovery splash for the guild, if there is one.
property discovery_splash_url : Optional[files.URL]Discovery URL splash for the guild, if set.
property emojis : Mapping[snowflakes.Snowflake, emojis_.KnownCustomEmoji]The mapping of IDs to the emojis this guild provides.
property features : Sequence[Union[str, GuildFeature]]A list of the features in this guild.
property id : snowflakes.SnowflakeThe ID of this entity.
property shard_id : Optional[int]Return the ID of the shard this guild is served by.
This may return None if the application does not have a gateway
connection.
property splash_hash : Optional[str]The hash of the splash for the guild, if there is one.
property splash_url : Optional[files.URL]Splash URL for the guild, if set.
async def ban(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
delete_message_days: undefined.UndefinedOr[int] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.ban
Ban the given user from this guild.
user : Snowflakeish[PartialUser]delete_message_days : UndefinedNoneOr[int]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_category(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildCategory: ...
Inherited from:
PartialGuild.create_category
Create a category in the guild.
name : strposition : UndefinedOr[int]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]reason : UndefinedOr[str]GuildCategoryBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_news_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
topic: undefined.UndefinedOr[str] = UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildNewsChannel: ...
Inherited from:
PartialGuild.create_news_channel
Create a news channel in the guild.
name : strposition : UndefinedOr[int]topic : UndefinedOr[str]nsfw : UndefinedOr[bool]rate_limit_per_user : UndefinedOr[Intervalish]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildNewsChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_stage_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
user_limit: undefined.UndefinedOr[int] = UNDEFINED,
bitrate: undefined.UndefinedOr[int] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
region: undefined.UndefinedOr[Union[voices_.VoiceRegion, str]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> channels_.GuildStageChannel: ...
Inherited from:
PartialGuild.create_stage_channel
Create a stage channel in the guild.
name : strposition : UndefinedOr[int]user_limit : UndefinedOr[int]bitrate : UndefinedOr[int]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]region : UndefinedOr[Union[VoiceRegion, str]]None here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildStageChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_sticker(
name: str,
tag: str,
image: files.Resourceish,
*,
description: undefined.UndefinedOr[str] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> stickers.GuildSticker: ...
Inherited from:
PartialGuild.create_sticker
Create a sticker in a guild.
name : strtag : strimage : ResourceishThe 320x320 image for the sticker. Maximum upload size is 500kb. This can be a still or an animated PNG or a Lottie.
Note
Lottie support is only available for verified and partnered servers.
description : UndefinedOr[str]reason : UndefinedOr[str]GuildStickerBadRequestErrorForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_text_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
topic: undefined.UndefinedOr[str] = UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildTextChannel: ...
Inherited from:
PartialGuild.create_text_channel
Create a text channel in the guild.
name : strposition : UndefinedOr[int]topic : UndefinedOr[str]nsfw : UndefinedOr[bool]rate_limit_per_user : UndefinedOr[Intervalish]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildTextChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def create_voice_channel(
name: str,
*,
position: undefined.UndefinedOr[int] = UNDEFINED,
user_limit: undefined.UndefinedOr[int] = UNDEFINED,
bitrate: undefined.UndefinedOr[int] = UNDEFINED,
video_quality_mode: undefined.UndefinedOr[Union[channels_.VideoQualityMode, int]] = UNDEFINED,
permission_overwrites: undefined.UndefinedOr[Sequence[channels_.PermissionOverwrite]] = UNDEFINED,
region: undefined.UndefinedOr[Union[voices_.VoiceRegion, str]] = UNDEFINED,
category: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildCategory]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> channels_.GuildVoiceChannel: ...
Inherited from:
PartialGuild.create_voice_channel
Create a voice channel in a guild.
guild : SnowflakeishOr[PartialGuild]name : strposition : UndefinedOr[int]user_limit : UndefinedOr[int]bitrate : UndefinedOr[int]video_quality_mode : UndefinedOr[Union[VideoQualityMode, int]]permission_overwrites : UndefinedOr[Sequence[PermissionOverwrite]]region : UndefinedOr[Union[VoiceRegion, str]]None here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.category : UndefinedOr[SnowflakeishOr[GuildCategory]]reason : UndefinedOr[str]GuildVoiceChannelBadRequestErrorForbiddenErrorMANAGE_CHANNEL permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def delete_channel(
channel: snowflakes.SnowflakeishOr[channels_.GuildChannel],
) -> GuildChannel: ...
Inherited from:
PartialGuild.delete_channel
Delete a channel in the guild.
Note
This method can also be used for deleting guild categories as well.
channel : SnowflakeishOr[GuildChannel]GuildChannelForbiddenErrorMANAGE_CHANNEL permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorNote
For Public servers, the set 'Rules' or 'Guidelines' channels and the 'Public Server Updates' channel cannot be deleted.
async def delete_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.delete_sticker
Delete a sticker in a guild.
sticker : SnowflakeishOr[PartialSticker]reason : UndefinedOr[str]ForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit(
*,
name: undefined.UndefinedOr[str] = UNDEFINED,
verification_level: undefined.UndefinedOr[GuildVerificationLevel] = UNDEFINED,
default_message_notifications: undefined.UndefinedOr[GuildMessageNotificationsLevel] = UNDEFINED,
explicit_content_filter_level: undefined.UndefinedOr[GuildExplicitContentFilterLevel] = UNDEFINED,
afk_channel: undefined.UndefinedOr[snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]] = UNDEFINED,
afk_timeout: undefined.UndefinedOr[time.Intervalish] = UNDEFINED,
icon: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
owner: undefined.UndefinedOr[snowflakes.SnowflakeishOr[users.PartialUser]] = UNDEFINED,
splash: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
banner: undefined.UndefinedNoneOr[files.Resourceish] = UNDEFINED,
system_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
rules_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
public_updates_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildTextChannel]] = UNDEFINED,
preferred_locale: undefined.UndefinedOr[Union[str, locales.Locale]] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> RESTGuild: ...
Inherited from:
PartialGuild.edit
Edits the guild.
name : UndefinedOr[str]verification_level : UndefinedOr[GuildVerificationLevel]default_message_notifications : UndefinedOr[GuildMessageNotificationsLevel]explicit_content_filter_level : UndefinedOr[GuildExplicitContentFilterLevel]afk_channel : UndefinedOr[SnowflakeishOr[GuildVoiceChannel]]afk_timeout to
be set to work.afk_timeout : UndefinedOr[Intervalish]icon : UndefinedOr[Resourceish]ANIMATED_ICON feature.owner : UndefinedOr[SnowflakeishOr[PartialUser]]]If provided, the new guild owner.
Warning
You need to be the owner of the server to use this.
splash : UndefinedNoneOr[Resourceish]INVITE_SPLASH feature.banner : UndefinedNoneOr[Resourceish]BANNER feature.system_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]rules_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]public_updates_channel : UndefinedNoneOr[SnowflakeishOr[GuildTextChannel]]preferred_locale : UndefinedNoneOr[str]reason : UndefinedOr[str]RESTGuildBadRequestErrorForbiddenErrorMANAGE_GUILD permission or if you tried to
pass ownership without being the server owner.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
*,
name: undefined.UndefinedOr[str] = UNDEFINED,
description: undefined.UndefinedOr[str] = UNDEFINED,
tag: undefined.UndefinedOr[str] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> GuildSticker: ...
Inherited from:
PartialGuild.edit_sticker
Edit a sticker in a guild.
sticker : SnowflakeishOr[PartialSticker]name : UndefinedOr[str]description : UndefinedOr[str]tag : UndefinedOr[str]reason : UndefinedOr[str]GuildStickerBadRequestErrorForbiddenErrorMANAGE_EMOJIS_AND_STICKERS in the server.NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_emoji(
emoji: snowflakes.SnowflakeishOr[emojis_.CustomEmoji],
) -> emojis_.KnownCustomEmoji: ...
Inherited from:
PartialGuild.fetch_emoji
Fetch an emoji from the guild.
emoji : SnowflakeishOr[CustomEmoji]CustomEmoji
or the ID of an existing emoji.KnownCustomEmojiNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_emojis() -> Sequence[emojis_.KnownCustomEmoji]: ...
Inherited from:
PartialGuild.fetch_emojis
Fetch the emojis of the guild.
Sequence[KnownCustomEmoji]NotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_roles() -> Sequence[Role]: ...
Inherited from:
PartialGuild.fetch_roles
Fetch the roles of the guild.
UnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_self() -> RESTGuild: ...
Inherited from:
PartialGuild.fetch_self
Fetch the guild.
RESTGuildForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_sticker(
sticker: snowflakes.SnowflakeishOr[stickers.PartialSticker],
) -> GuildSticker: ...
Inherited from:
PartialGuild.fetch_sticker
Fetch a sticker from the guild.
sticker : snowflakes.SnowflakeishOr[PartialSticker]GuildStickerForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_stickers() -> Sequence[GuildSticker]: ...
Inherited from:
PartialGuild.fetch_stickers
Fetch the stickers of the guild.
Sequence[GuildSticker]ForbiddenErrorNotFoundErrorUnauthorizedErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def kick(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.kick
Kicks the given user from this guild.
user : Snowflakeish[PartialUser]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorKICK_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrordef make_discovery_splash_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...Generate the guild's discovery splash image URL, if set.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_discovery_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's discovery splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The string URL.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.discovery_splash_hash is None:
return None
return routes.CDN_GUILD_DISCOVERY_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.discovery_splash_hash,
size=size,
file_format=ext,
)def make_icon_url(
*,
ext: Optional[str] = None,
size: int = 4096,
) -> Optional[files.URL]: ...
Inherited from:
PartialGuild.make_icon_url
Generate the guild's icon URL, if set.
ext : Optional[str]The extension to use for this URL, defaults to png or gif.
Supports png, jpeg, jpg, webp and gif (when
animated).
If None, then the correct default extension is
determined based on whether the icon is animated or not.
size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_splash_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...Generate the guild's splash image URL, if set.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorsize is not a power of two or not between 16 and 4096.def make_splash_url(self, *, ext: str = "png", size: int = 4096) -> typing.Optional[files.URL]:
"""Generate the guild's splash image URL, if set.
Parameters
----------
ext : builtins.str
The extension to use for this URL, defaults to `png`.
Supports `png`, `jpeg`, `jpg` and `webp`.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the splash, or `builtins.None` if not set.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.splash_hash is None:
return None
return routes.CDN_GUILD_SPLASH.compile_to_file(
urls.CDN_URL,
guild_id=self.id,
hash=self.splash_hash,
size=size,
file_format=ext,
)async def unban(
user: snowflakes.SnowflakeishOr[users.PartialUser],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...
Inherited from:
PartialGuild.unban
Unban the given user from this guild.
user : Snowflakeish[PartialUser]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorclass GuildSystemChannelFlag (
value: int = 0,
): ...Defines which features are suppressed in the system channel.
class GuildSystemChannelFlag(enums.Flag):
"""Defines which features are suppressed in the system channel."""
NONE = 0
"""Nothing is suppressed."""
SUPPRESS_USER_JOIN = 1 << 0
"""Suppress displaying a message about new users joining."""
SUPPRESS_PREMIUM_SUBSCRIPTION = 1 << 1
"""Suppress displaying a message when the guild is Nitro boosted."""
SUPPRESS_GUILD_REMINDER = 1 << 2
"""Suppress displaying messages with guild setup tips."""
SUPPRESS_USER_JOIN_REPLIES = 1 << 3
"""Suppress displaying a reply button on join notifications."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Flag implementation …
const NONE = 0Nothing is suppressed.
const SUPPRESS_GUILD_REMINDER = 4Suppress displaying messages with guild setup tips.
const SUPPRESS_PREMIUM_SUBSCRIPTION = 2Suppress displaying a message when the guild is Nitro boosted.
const SUPPRESS_USER_JOIN = 1Suppress displaying a message about new users joining.
const SUPPRESS_USER_JOIN_REPLIES = 8Suppress displaying a reply button on join notifications.
def all(
self: _T,
*flags: _T,
) -> bool: ...Check if all of the given flags are part of this value …
This function is defined explicitly at hikari.internal.enums.Flag.all. Visit that link to view the full documentation!def any(
self: _T,
*flags: _T,
) -> bool: ...Check if any of the given flags are part of this value …
This function is defined explicitly at hikari.internal.enums.Flag.any. Visit that link to view the full documentation!def difference(
self: _T,
other: Union[_T, int],
) -> ~_T: ...Perform a set difference with the other set …
This function is defined explicitly at hikari.internal.enums.Flag.difference. Visit that link to view the full documentation!def intersection(
self: _T,
other: Union[_T, int],
) -> ~_T: ...Return a combination of flags that are set for both given values …
This function is defined explicitly at hikari.internal.enums.Flag.intersection. Visit that link to view the full documentation!def invert(
self: _T,
) -> ~_T: ...Return a set of all flags not in the current set.
This function is defined explicitly at hikari.internal.enums.Flag.invert. Visit that link to view the full documentation!def is_disjoint(
self: _T,
other: Union[_T, int],
) -> bool: ...Return whether two sets have a intersection or not …
This function is defined explicitly at hikari.internal.enums.Flag.is_disjoint. Visit that link to view the full documentation!def is_subset(
self: _T,
other: Union[_T, int],
) -> bool: ...Return whether another set contains this set or not …
This function is defined explicitly at hikari.internal.enums.Flag.is_subset. Visit that link to view the full documentation!def is_superset(
self: _T,
other: Union[_T, int],
) -> bool: ...Return whether this set contains another set or not.
This function is defined explicitly at hikari.internal.enums.Flag.is_superset. Visit that link to view the full documentation!def isdisjoint(
self: _T,
other: Union[_T, int],
) -> bool: ...Return whether two sets have a intersection or not …
This function is defined explicitly at hikari.internal.enums.Flag.is_disjoint. Visit that link to view the full documentation!def issubset(
self: _T,
other: Union[_T, int],
) -> bool: ...Return whether another set contains this set or not …
This function is defined explicitly at hikari.internal.enums.Flag.is_subset. Visit that link to view the full documentation!def issuperset(
self: _T,
other: Union[_T, int],
) -> bool: ...Return whether this set contains another set or not.
This function is defined explicitly at hikari.internal.enums.Flag.is_superset. Visit that link to view the full documentation!def none(
self: _T,
*flags: _T,
) -> bool: ...Check if none of the given flags are part of this value …
This function is defined explicitly at hikari.internal.enums.Flag.none. Visit that link to view the full documentation!def split(
self: _T,
) -> Sequence[~_T]: ...Return a list of all defined atomic values for this flag …
This function is defined explicitly at hikari.internal.enums.Flag.split. Visit that link to view the full documentation!def symmetric_difference(
self: _T,
other: Union[_T, int],
) -> ~_T: ...Return a set with the symmetric differences of two flag sets …
This function is defined explicitly at hikari.internal.enums.Flag.symmetric_difference. Visit that link to view the full documentation!def symmetricdifference(
self: _T,
other: Union[_T, int],
) -> ~_T: ...Return a set with the symmetric differences of two flag sets …
This function is defined explicitly at hikari.internal.enums.Flag.symmetric_difference. Visit that link to view the full documentation!def union(
self: _T,
other: Union[_T, int],
) -> ~_T: ...Return a combination of all flags in this set and the other set …
This function is defined explicitly at hikari.internal.enums.Flag.union. Visit that link to view the full documentation!class GuildVerificationLevel (
value: Any,
): ...Represents the level of verification of a guild.
class GuildVerificationLevel(int, enums.Enum):
"""Represents the level of verification of a guild."""
NONE = 0
"""Unrestricted."""
LOW = 1
"""Must have a verified email on their account."""
MEDIUM = 2
"""Must have been registered on Discord for more than 5 minutes."""
HIGH = 3
"""Must also be a member of the guild for longer than 10 minutes."""
VERY_HIGH = 4
"""Must have a verified phone number."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const HIGH = 3Must also be a member of the guild for longer than 10 minutes.
const LOW = 1Must have a verified email on their account.
const MEDIUM = 2Must have been registered on Discord for more than 5 minutes.
const NONE = 0Unrestricted.
const VERY_HIGH = 4Must have a verified phone number.
class GuildWidget (
*,
app: traits.RESTAware,
channel_id: Optional[snowflakes.Snowflake],
is_enabled: bool,
): ...Represents a guild widget.
Method generated by attrs for class GuildWidget.
class GuildWidget:
"""Represents a guild widget."""
app: traits.RESTAware = attr.field(
repr=False, eq=False, hash=False, metadata={attr_extensions.SKIP_DEEP_COPY: True}
)
"""The client application that models may use for procedures."""
channel_id: typing.Optional[snowflakes.Snowflake] = attr.field(repr=True)
"""The ID of the channel the invite for this embed targets, if enabled."""
is_enabled: bool = attr.field(repr=True)
"""Whether this embed is enabled."""
async def fetch_channel(self) -> typing.Optional[channels_.GuildChannel]:
"""Fetch the widget channel.
This will be `builtins.None` if not set.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The requested channel.
You can check the type of the channel by
using `builtins.isinstance`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.channel_id:
return None
widget_channel = await self.app.rest.fetch_channel(self.channel_id)
assert isinstance(widget_channel, channels_.GuildChannel)
return widget_channelproperty channel_id : Optional[Snowflake]The ID of the channel the invite for this embed targets, if enabled.
property is_enabled : boolWhether this embed is enabled.
async def fetch_channel() -> Optional[GuildChannel]: ...Fetch the widget channel.
This will be None if not set.
Optional[GuildChannel]The requested channel.
You can check the type of the channel by
using isinstance.
UnauthorizedErrorForbiddenErrorREAD_MESSAGES permission in the channel.NotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_channel(self) -> typing.Optional[channels_.GuildChannel]:
"""Fetch the widget channel.
This will be `builtins.None` if not set.
Returns
-------
typing.Optional[hikari.channels.GuildChannel]
The requested channel.
You can check the type of the channel by
using `builtins.isinstance`.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are missing the `READ_MESSAGES` permission in the channel.
hikari.errors.NotFoundError
If the channel is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if not self.channel_id:
return None
widget_channel = await self.app.rest.fetch_channel(self.channel_id)
assert isinstance(widget_channel, channels_.GuildChannel)
return widget_channelclass Integration (
*,
account: IntegrationAccount,
id: snowflakes.Snowflake,
name: str,
type: Union[IntegrationType, str],
guild_id: snowflakes.Snowflake,
expire_behavior: Union[IntegrationExpireBehaviour, int, None],
expire_grace_period: Optional[datetime.timedelta],
is_enabled: bool,
is_syncing: Optional[bool],
is_emojis_enabled: Optional[bool],
is_revoked: Optional[bool],
last_synced_at: Optional[datetime.datetime],
role_id: Optional[snowflakes.Snowflake],
user: Optional[users.User],
subscriber_count: Optional[int],
application: Optional[IntegrationApplication],
): ...Represents a guild integration object.
Method generated by attrs for class Integration.
class Integration(PartialIntegration):
"""Represents a guild integration object."""
guild_id: snowflakes.Snowflake = attr.field()
"""The ID of the guild this integration belongs to."""
expire_behavior: typing.Union[IntegrationExpireBehaviour, int, None] = attr.field(eq=False, hash=False, repr=False)
"""How members should be treated after their connected subscription expires.
This will not be enacted until after `GuildIntegration.expire_grace_period`
passes.
!!! note
This will always be `builtins.None` for Discord integrations.
"""
expire_grace_period: typing.Optional[datetime.timedelta] = attr.field(eq=False, hash=False, repr=False)
"""How many days users with expired subscriptions are given until
`GuildIntegration.expire_behavior` is enacted out on them.
!!! note
This will always be `builtins.None` for Discord integrations.
"""
is_enabled: bool = attr.field(eq=False, hash=False, repr=True)
"""Whether this integration is enabled."""
is_syncing: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether this integration is syncing subscribers/emojis."""
is_emojis_enabled: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether users under this integration are allowed to use it's custom emojis."""
is_revoked: typing.Optional[bool] = attr.field(eq=False, hash=False, repr=False)
"""Whether the integration has been revoked."""
last_synced_at: typing.Optional[datetime.datetime] = attr.field(eq=False, hash=False, repr=False)
"""The datetime of when this integration's subscribers were last synced."""
role_id: typing.Optional[snowflakes.Snowflake] = attr.field(eq=False, hash=False, repr=False)
"""The ID of the managed role used for this integration's subscribers."""
user: typing.Optional[users.User] = attr.field(eq=False, hash=False, repr=False)
"""The user this integration belongs to."""
subscriber_count: typing.Optional[int] = attr.field(eq=False, hash=False, repr=False)
"""The number of subscribers this integration has."""
application: typing.Optional[IntegrationApplication] = attr.field(eq=False, hash=False, repr=False)
"""The bot/OAuth2 application associated with this integration.
!!! note
This is only available for Discord integrations.
"""A partial representation of an integration, found in audit logs …
Mixin for a class that enforces uniqueness by a snowflake ID.
Helper class that provides a standard way to create an ABC using inheritance.
property account : IntegrationAccountThe account connected to this integration.
property application : Optional[IntegrationApplication]The bot/OAuth2 application associated with this integration.
Note
This is only available for Discord integrations.
property created_at : datetime.datetimeWhen the object was created.
property expire_behavior : Union[IntegrationExpireBehaviour, int, None]How members should be treated after their connected subscription expires.
This will not be enacted until after GuildIntegration.expire_grace_period
passes.
Note
This will always be None for Discord integrations.
property expire_grace_period : Optional[datetime.timedelta]How many days users with expired subscriptions are given until
GuildIntegration.expire_behavior is enacted out on them.
Note
This will always be None for Discord integrations.
property guild_id : snowflakes.SnowflakeThe ID of the guild this integration belongs to.
property id : snowflakes.SnowflakeThe ID of this entity.
property is_emojis_enabled : Optional[bool]Whether users under this integration are allowed to use it's custom emojis.
property is_enabled : boolWhether this integration is enabled.
property is_revoked : Optional[bool]Whether the integration has been revoked.
property is_syncing : Optional[bool]Whether this integration is syncing subscribers/emojis.
property last_synced_at : Optional[datetime.datetime]The datetime of when this integration's subscribers were last synced.
property role_id : Optional[snowflakes.Snowflake]The ID of the managed role used for this integration's subscribers.
property subscriber_count : Optional[int]The number of subscribers this integration has.
property type : Union[IntegrationType, str]The type of this integration.
property user : Optional[users.User]The user this integration belongs to.
class IntegrationAccount (
*,
id: str,
name: str,
): ...An account that's linked to an integration.
Method generated by attrs for class IntegrationAccount.
class IntegrationAccount:
"""An account that's linked to an integration."""
id: str = attr.field(hash=True, repr=True)
"""The string ID of this (likely) third party account."""
name: str = attr.field(eq=False, hash=False, repr=True)
"""The name of this account."""
def __str__(self) -> str:
return self.nameclass IntegrationApplication (
*,
id: snowflakes.Snowflake,
name: str,
description: Optional[str],
icon_hash: Optional[str],
bot: Optional[users.User],
): ...An application that's linked to an integration.
Method generated by attrs for class IntegrationApplication.
class IntegrationApplication(PartialApplication):
"""An application that's linked to an integration."""
bot: typing.Optional[users.User] = attr.field(eq=False, hash=False, repr=False)
"""The bot associated with this application."""A partial representation of a Discord application …
Mixin for a class that enforces uniqueness by a snowflake ID.
Helper class that provides a standard way to create an ABC using inheritance.
property created_at : datetime.datetimeWhen the object was created.
property description : Optional[str]The description of this application, if any.
def make_icon_url(
*,
ext: str = 'png',
size: int = 4096,
) -> Optional[files.URL]: ...
Inherited from:
PartialApplication.make_icon_url
Generate the icon URL for this application.
ext : strpng.
Supports png, jpeg, jpg and webp.size : int4096.
Can be any power of two between 16 and 4096.ValueErrorclass IntegrationExpireBehaviour (
value: Any,
): ...Behavior for expiring integration subscribers.
class IntegrationExpireBehaviour(int, enums.Enum):
"""Behavior for expiring integration subscribers."""
REMOVE_ROLE = 0
"""Remove the role."""
KICK = 1
"""Kick the subscriber."""int([x]) -> integer int(x, base=10) -> integer …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const KICK = 1Kick the subscriber.
const REMOVE_ROLE = 0Remove the role.
class IntegrationType (
value: Any,
): ...The integration type.
class IntegrationType(str, enums.Enum):
"""The integration type."""
TWITCH = "twitch"
YOUTUBE = "youtube"
DISCORD_BOT = "discord"str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str …
Clone of Python's enum.Enum implementation …
property valueReturn the value of the enum member.
const DISCORD_BOT = 'discord'const TWITCH = 'twitch'const YOUTUBE = 'youtube'class Member (
*,
guild_id: snowflakes.Snowflake,
is_deaf: undefined.UndefinedOr[bool],
is_mute: undefined.UndefinedOr[bool],
is_pending: undefined.UndefinedOr[bool],
joined_at: datetime.datetime,
nickname: Optional[str],
premium_since: Optional[datetime.datetime],
raw_communication_disabled_until: Optional[datetime.datetime],
role_ids: Sequence[snowflakes.Snowflake],
user: users.User,
guild_avatar_hash: Optional[str],
): ...Used to represent a guild bound member.
Method generated by attrs for class Member.
class Member(users.User):
"""Used to represent a guild bound member."""
guild_id: snowflakes.Snowflake = attr.field(repr=True)
"""The ID of the guild this member belongs to."""
is_deaf: undefined.UndefinedOr[bool] = attr.field(repr=False)
"""`builtins.True` if this member is deafened in the current voice channel.
This will be `hikari.undefined.UNDEFINED` if it's state is
unknown.
"""
is_mute: undefined.UndefinedOr[bool] = attr.field(repr=False)
"""`builtins.True` if this member is muted in the current voice channel.
This will be `hikari.undefined.UNDEFINED` if it's state is unknown.
"""
is_pending: undefined.UndefinedOr[bool] = attr.field(repr=False)
"""Whether the user has passed the guild's membership screening requirements.
This will be `hikari.undefined.UNDEFINED` if it's state is unknown.
"""
joined_at: datetime.datetime = attr.field(repr=True)
"""The datetime of when this member joined the guild they belong to."""
nickname: typing.Optional[str] = attr.field(repr=True)
"""This member's nickname.
This will be `builtins.None` if not set.
"""
premium_since: typing.Optional[datetime.datetime] = attr.field(repr=False)
"""The datetime of when this member started "boosting" this guild.
Will be `builtins.None` if the member is not a premium user.
"""
raw_communication_disabled_until: typing.Optional[datetime.datetime] = attr.field(repr=False)
"""The datetime when this member's timeout will expire.
Will be `builtins.None` if the member is not timed out.
!!! note
The datetime might be in the past, so it is recommended to use
`communication_disabled_until` method to check if the member is timed
out at the time of the call.
"""
role_ids: typing.Sequence[snowflakes.Snowflake] = attr.field(repr=False)
"""A sequence of the IDs of the member's current roles."""
# This is technically optional, since UPDATE MEMBER and MESSAGE CREATE
# events do not inject the user into the member payload, but specify it
# separately. However, to get around this inconsistency, we force the
# entity factory to always provide the user object in these cases, so we
# can assume this is always set, and thus we are always able to get info
# such as the ID of the user this member represents.
user: users.User = attr.field(repr=True)
"""This member's corresponding user object."""
guild_avatar_hash: typing.Optional[str] = attr.field(eq=False, hash=False, repr=False)
"""Hash of the member's guild avatar guild if set, else `builtins.None`.
!!! note
This takes precedence over `Member.avatar_hash`.
"""
@property
def app(self) -> traits.RESTAware:
"""Return the app that is bound to the user object."""
return self.user.app
@property
def avatar_hash(self) -> typing.Optional[str]:
return self.user.avatar_hash
@property
def avatar_url(self) -> typing.Optional[files.URL]:
return self.user.avatar_url
@property
def guild_avatar_url(self) -> typing.Optional[files.URL]:
"""Guild Avatar URL for the user, if they have one set.
May be `builtins.None` if no guild avatar is set. In this case, you
should use `avatar_hash` or `default_avatar_url` instead.
"""
return self.make_guild_avatar_url()
@property
def default_avatar_url(self) -> files.URL:
return self.user.default_avatar_url
@property
def display_avatar_url(self) -> files.URL:
return self.make_guild_avatar_url() or super().display_avatar_url
@property
def banner_hash(self) -> typing.Optional[str]:
return self.user.banner_hash
@property
def banner_url(self) -> typing.Optional[files.URL]:
return self.user.banner_url
@property
def accent_color(self) -> typing.Optional[colors.Color]:
return self.user.accent_color
@property
def discriminator(self) -> str:
return self.user.discriminator
@property
def display_name(self) -> str:
"""Return the member's display name.
If the member has a nickname, this will return that nickname.
Otherwise, it will return the username instead.
Returns
-------
builtins.str
The member display name.
See Also
--------
Nickname: `Member.nickname`
Username: `Member.username`
"""
return self.nickname if isinstance(self.nickname, str) else self.username
@property
def flags(self) -> users.UserFlag:
return self.user.flags
@property
def id(self) -> snowflakes.Snowflake:
return self.user.id
@property
def is_bot(self) -> bool:
return self.user.is_bot
@property
def is_system(self) -> bool:
return self.user.is_system
@property
def mention(self) -> str:
return self.user.mention
def communication_disabled_until(self) -> typing.Optional[datetime.datetime]:
"""Return when the timeout for this member ends.
Unlike `raw_communication_disabled_until`, this will always be
`builtins.None` if the member is not currently timed out.
!!! note
The output of this function can depend based on when
the function is called.
"""
if (
self.raw_communication_disabled_until is not None
and self.raw_communication_disabled_until > time.utc_datetime()
):
return self.raw_communication_disabled_until
return None
def get_guild(self) -> typing.Optional[Guild]:
"""Return the guild associated with this member.
Returns
-------
typing.Optional[hikari.guilds.Guild]
The linked guild object or `builtins.None` if it's not cached.
"""
if not isinstance(self.user.app, traits.CacheAware):
return None
return self.user.app.cache.get_guild(self.guild_id)
def get_presence(self) -> typing.Optional[presences_.MemberPresence]:
"""Get the cached presence for this member, if known.
Presence info includes user status and activities.
This requires the `GUILD_PRESENCES` intent to be enabled.
Returns
-------
typing.Optional[hikari.presences.MemberPresence]
The member presence, or `builtins.None` if not known.
"""
if not isinstance(self.user.app, traits.CacheAware):
return None
return self.user.app.cache.get_presence(self.guild_id, self.user.id)
def get_roles(self) -> typing.Sequence[Role]:
"""Return the roles the user has.
This will be empty if the roles are missing from the cache.
Returns
-------
typing.Sequence[hikari.guilds.Role]
The roles the users has.
"""
roles: typing.List[Role] = []
if not isinstance(self.user.app, traits.CacheAware):
return roles
for role_id in self.role_ids:
if role := self.user.app.cache.get_role(role_id):
roles.append(role)
return roles
def get_top_role(self) -> typing.Optional[Role]:
"""Return the highest role the member has.
Returns
-------
typing.Optional[hikari.guilds.Role]
`builtins.None` if the cache is missing the roles information or
the highest role the user has.
"""
roles = sorted(self.get_roles(), key=lambda r: r.position, reverse=True)
try:
return next(iter(roles))
except StopIteration:
return None
@property
def username(self) -> str:
return self.user.username
def make_avatar_url(self, *, ext: typing.Optional[str] = None, size: int = 4096) -> typing.Optional[files.URL]:
return self.user.make_avatar_url(ext=ext, size=size)
def make_guild_avatar_url(
self, *, ext: typing.Optional[str] = None, size: int = 4096
) -> typing.Optional[files.URL]:
"""Generate the guild specific avatar url for this member, if set.
If no guild avatar is set, this returns `builtins.None`. You can then
use the `make_avatar_url` to get their global custom avatar or
`default_avatar_url` if they have no custom avatar set.
Parameters
----------
ext : typing.Optional[builtins.str]
The ext to use for this URL, defaults to `png` or `gif`.
Supports `png`, `jpeg`, `jpg`, `webp` and `gif` (when
animated). Will be ignored for default avatars which can only be
`png`.
If `builtins.None`, then the correct default extension is
determined based on whether the icon is animated or not.
size : builtins.int
The size to set for the URL, defaults to `4096`.
Can be any power of two between 16 and 4096.
Will be ignored for default avatars.
Returns
-------
typing.Optional[hikari.files.URL]
The URL to the avatar, or `builtins.None` if not present.
Raises
------
builtins.ValueError
If `size` is not a power of two or not between 16 and 4096.
"""
if self.guild_avatar_hash is None:
return None
if ext is None:
if self.guild_avatar_hash.startswith("a_"):
ext = "gif"
else:
ext = "png"
return routes.CDN_MEMBER_AVATAR.compile_to_file(
urls.CDN_URL,
guild_id=self.guild_id,
user_id=self.id,
hash=self.guild_avatar_hash,
size=size,
file_format=ext,
)
async def fetch_self(self) -> Member:
"""Fetch an up-to-date view of this member from the API.
Returns
-------
hikari.guilds.Member
An up-to-date view of this member.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the member is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
return await self.user.app.rest.fetch_member(self.guild_id, self.user.id)
async def fetch_dm_channel(self) -> channels_.DMChannel:
return await self.user.fetch_dm_channel()
async def fetch_roles(self) -> typing.Sequence[Role]:
"""Fetch an up-to-date view of this member's roles from the API.
Returns
-------
typing.Sequence[hikari.guilds.Role]
An up-to-date view of this member's roles.
Raises
------
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the member is not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
fetched_roles = await self.app.rest.fetch_roles(self.guild_id)
return [role for role in fetched_roles if role.id in self.role_ids]
async def ban(
self,
*,
delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Ban this member from this guild.
Other Parameters
----------------
delete_message_days : hikari.undefined.UndefinedNoneOr[builtins.int]
If provided, the number of days to delete messages for.
This must be between 0 and 7.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.ban_user(
self.guild_id, self.user.id, delete_message_days=delete_message_days, reason=reason
)
async def unban(
self,
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Unban this member from the guild.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.unban_user(self.guild_id, self.user.id, reason=reason)
async def kick(
self,
*,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Kick this member from this guild.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `KICK_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.kick_user(self.guild_id, self.user.id, reason=reason)
async def add_role(
self, role: snowflakes.SnowflakeishOr[PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED
) -> None:
"""Add a role to the member.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]
The role to add. This may be the object or the
ID of an existing role.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.ForbiddenError
If you are missing the `MANAGE_ROLES` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild, user or role are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.add_role_to_member(self.guild_id, self.user.id, role, reason=reason)
async def remove_role(
self, role: snowflakes.SnowflakeishOr[PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED
) -> None:
"""Remove a role from the member.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]
The role to remove. This may be the object or the
ID of an existing role.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.ForbiddenError
If you are missing the `MANAGE_ROLES` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild, user or role are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.remove_role_from_member(self.guild_id, self.user.id, role, reason=reason)
async def edit(
self,
*,
nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED,
nick: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED,
roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[PartialRole]] = undefined.UNDEFINED,
mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
voice_channel: undefined.UndefinedNoneOr[
snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]
] = undefined.UNDEFINED,
communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> Member:
"""Edit the member.
Other Parameters
----------------
nickname : hikari.undefined.UndefinedNoneOr[builtins.str]
If provided, the new nick for the member. If `builtins.None`,
will remove the members nick.
Requires the `MANAGE_NICKNAMES` permission.
nick : hikari.undefined.UndefinedNoneOr[builtins.str]
Deprecated alias for `nickname`.
roles : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]
If provided, the new roles for the member.
Requires the `MANAGE_ROLES` permission.
mute : hikari.undefined.UndefinedOr[builtins.bool]
If provided, the new server mute state for the member.
Requires the `MUTE_MEMBERS` permission.
deaf : hikari.undefined.UndefinedOr[builtins.bool]
If provided, the new server deaf state for the member.
Requires the `DEAFEN_MEMBERS` permission.
voice_channel : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]]
If provided, `builtins.None` or the object or the ID of
an existing voice channel to move the member to.
If `builtins.None`, will disconnect the member from voice.
Requires the `MOVE_MEMBERS` permission and the `CONNECT`
permission in the original voice channel and the target
voice channel.
!!! note
If the member is not in a voice channel, this will
take no effect.
communication_disabled_until : hikari.undefined.UndefinedNoneOr[datetime.datetime]
If provided, the datetime when the timeout (disable communication)
of the member expires, up to 28 days in the future, or `builtins.None`
to remove the timeout from the member.
Requires the `MODERATE_MEMBERS` permission.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.guilds.Member
Object of the member that was updated.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing a permission to do an action.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or the user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if nick is not undefined.UNDEFINED:
deprecation.warn_deprecated("nick", alternative="nickname")
nickname = nick
return await self.user.app.rest.edit_member(
self.guild_id,
self.user.id,
nickname=nickname,
roles=roles,
mute=mute,
deaf=deaf,
voice_channel=voice_channel,
communication_disabled_until=communication_disabled_until,
reason=reason,
)
def __str__(self) -> str:
return str(self.user)
def __hash__(self) -> int:
return hash(self.user)
def __eq__(self, other: object) -> bool:
return self.user == otherModel of the member who triggered an interaction …
Interface for any user-like object …
A partial interface for a user …
Mixin for a class that enforces uniqueness by a snowflake ID.
Helper class that provides a standard way to create an ABC using inheritance.
property accent_color : Optional[colors.Color]The custom banner color for the user, if set else None.
The official client will decide the default color if not set.
property accent_colour : Optional[colors.Color]Alias for the accent_color field.
property avatar_hash : Optional[str]Avatar hash for the user, if they have one, otherwise None.
property avatar_url : Optional[files.URL]Avatar URL for the user, if they have one set.
May be None if no custom avatar is set. In this case, you
should use default_avatar_url instead.
property created_at : datetime.datetimeWhen the object was created.
property default_avatar_url : files.URLDefault avatar URL for this user.
property discriminator : strDiscriminator for the user.
property display_avatar_url : files.URLDisplay avatar URL for this user.
property display_name : strReturn the member's display name.
If the member has a nickname, this will return that nickname. Otherwise, it will return the username instead.
strproperty guild_avatar_hash : Optional[str]Hash of the member's guild avatar guild if set, else None.
Note
This takes precedence over avatar_hash.
property guild_avatar_url : Optional[files.URL]Guild Avatar URL for the user, if they have one set.
May be None if no guild avatar is set. In this case, you
should use avatar_hash or default_avatar_url instead.
property guild_id : snowflakes.SnowflakeThe ID of the guild this member belongs to.
property id : SnowflakeReturn the ID of this entity.
Snowflakeproperty is_deaf : undefined.UndefinedOr[bool]True if this member is deafened in the current voice channel.
This will be UNDEFINED if it's state is
unknown.
property is_mute : undefined.UndefinedOr[bool]True if this member is muted in the current voice channel.
This will be UNDEFINED if it's state is unknown.
property is_pending : undefined.UndefinedOr[bool]Whether the user has passed the guild's membership screening requirements.
This will be UNDEFINED if it's state is unknown.
property joined_at : datetime.datetimeThe datetime of when this member joined the guild they belong to.
property mention : strReturn a raw mention string for the given user.
>>> some_user.mention
'<@123456789123456789>'
strproperty raw_communication_disabled_until : Optional[datetime.datetime]The datetime when this member's timeout will expire.
Will be None if the member is not timed out.
Note
The datetime might be in the past, so it is recommended to use
communication_disabled_until method to check if the member is timed
out at the time of the call.
property role_ids : Sequence[snowflakes.Snowflake]A sequence of the IDs of the member's current roles.
property user : users.UserThis member's corresponding user object.
async def add_role(
role: snowflakes.SnowflakeishOr[PartialRole],
*,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...Add a role to the member.
role : SnowflakeishOr[PartialRole]reason : UndefinedOr[str]ForbiddenErrorMANAGE_ROLES permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def add_role(
self, role: snowflakes.SnowflakeishOr[PartialRole], *, reason: undefined.UndefinedOr[str] = undefined.UNDEFINED
) -> None:
"""Add a role to the member.
Parameters
----------
role : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialRole]
The role to add. This may be the object or the
ID of an existing role.
Other Parameters
----------------
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.ForbiddenError
If you are missing the `MANAGE_ROLES` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild, user or role are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.add_role_to_member(self.guild_id, self.user.id, role, reason=reason)async def ban(
*,
delete_message_days: undefined.UndefinedOr[int] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> None: ...Ban this member from this guild.
delete_message_days : UndefinedNoneOr[int]reason : UndefinedOr[str]BadRequestErrorForbiddenErrorBAN_MEMBERS permission.UnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def ban(
self,
*,
delete_message_days: undefined.UndefinedOr[int] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> None:
"""Ban this member from this guild.
Other Parameters
----------------
delete_message_days : hikari.undefined.UndefinedNoneOr[builtins.int]
If provided, the number of days to delete messages for.
This must be between 0 and 7.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing the `BAN_MEMBERS` permission.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
await self.user.app.rest.ban_user(
self.guild_id, self.user.id, delete_message_days=delete_message_days, reason=reason
)def communication_disabled_until() -> Optional[datetime.datetime]: ...Return when the timeout for this member ends.
Unlike raw_communication_disabled_until, this will always be
None if the member is not currently timed out.
Note
The output of this function can depend based on when the function is called.
def communication_disabled_until(self) -> typing.Optional[datetime.datetime]:
"""Return when the timeout for this member ends.
Unlike `raw_communication_disabled_until`, this will always be
`builtins.None` if the member is not currently timed out.
!!! note
The output of this function can depend based on when
the function is called.
"""
if (
self.raw_communication_disabled_until is not None
and self.raw_communication_disabled_until > time.utc_datetime()
):
return self.raw_communication_disabled_until
return Noneasync def edit(
*,
nickname: undefined.UndefinedNoneOr[str] = UNDEFINED,
nick: undefined.UndefinedNoneOr[str] = UNDEFINED,
roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[PartialRole]] = UNDEFINED,
mute: undefined.UndefinedOr[bool] = UNDEFINED,
deaf: undefined.UndefinedOr[bool] = UNDEFINED,
voice_channel: undefined.UndefinedNoneOr[snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]] = UNDEFINED,
communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = UNDEFINED,
reason: undefined.UndefinedOr[str] = UNDEFINED,
) -> Member: ...Edit the member.
nickname : UndefinedNoneOr[str]If provided, the new nick for the member. If None,
will remove the members nick.
Requires the MANAGE_NICKNAMES permission.
nick : UndefinedNoneOr[str]nickname.roles : UndefinedOr[SnowflakeishSequence[PartialRole]]If provided, the new roles for the member.
Requires the MANAGE_ROLES permission.
mute : UndefinedOr[bool]If provided, the new server mute state for the member.
Requires the MUTE_MEMBERS permission.
deaf : UndefinedOr[bool]If provided, the new server deaf state for the member.
Requires the DEAFEN_MEMBERS permission.
voice_channel : UndefinedOr[SnowflakeishOr[GuildVoiceChannel]]]If provided, None or the object or the ID of
an existing voice channel to move the member to.
If None, will disconnect the member from voice.
Requires the MOVE_MEMBERS permission and the CONNECT
permission in the original voice channel and the target
voice channel.
Note
If the member is not in a voice channel, this will take no effect.
communication_disabled_until : UndefinedNoneOr[datetime.datetime]If provided, the datetime when the timeout (disable communication)
of the member expires, up to 28 days in the future, or None
to remove the timeout from the member.
Requires the MODERATE_MEMBERS permission.
reason : UndefinedOr[str]MemberBadRequestErrorForbiddenErrorUnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def edit(
self,
*,
nickname: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED,
nick: undefined.UndefinedNoneOr[str] = undefined.UNDEFINED,
roles: undefined.UndefinedOr[snowflakes.SnowflakeishSequence[PartialRole]] = undefined.UNDEFINED,
mute: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
deaf: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
voice_channel: undefined.UndefinedNoneOr[
snowflakes.SnowflakeishOr[channels_.GuildVoiceChannel]
] = undefined.UNDEFINED,
communication_disabled_until: undefined.UndefinedNoneOr[datetime.datetime] = undefined.UNDEFINED,
reason: undefined.UndefinedOr[str] = undefined.UNDEFINED,
) -> Member:
"""Edit the member.
Other Parameters
----------------
nickname : hikari.undefined.UndefinedNoneOr[builtins.str]
If provided, the new nick for the member. If `builtins.None`,
will remove the members nick.
Requires the `MANAGE_NICKNAMES` permission.
nick : hikari.undefined.UndefinedNoneOr[builtins.str]
Deprecated alias for `nickname`.
roles : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishSequence[hikari.guilds.PartialRole]]
If provided, the new roles for the member.
Requires the `MANAGE_ROLES` permission.
mute : hikari.undefined.UndefinedOr[builtins.bool]
If provided, the new server mute state for the member.
Requires the `MUTE_MEMBERS` permission.
deaf : hikari.undefined.UndefinedOr[builtins.bool]
If provided, the new server deaf state for the member.
Requires the `DEAFEN_MEMBERS` permission.
voice_channel : hikari.undefined.UndefinedOr[hikari.snowflakes.SnowflakeishOr[hikari.channels.GuildVoiceChannel]]]
If provided, `builtins.None` or the object or the ID of
an existing voice channel to move the member to.
If `builtins.None`, will disconnect the member from voice.
Requires the `MOVE_MEMBERS` permission and the `CONNECT`
permission in the original voice channel and the target
voice channel.
!!! note
If the member is not in a voice channel, this will
take no effect.
communication_disabled_until : hikari.undefined.UndefinedNoneOr[datetime.datetime]
If provided, the datetime when the timeout (disable communication)
of the member expires, up to 28 days in the future, or `builtins.None`
to remove the timeout from the member.
Requires the `MODERATE_MEMBERS` permission.
reason : hikari.undefined.UndefinedOr[builtins.str]
If provided, the reason that will be recorded in the audit logs.
Maximum of 512 characters.
Returns
-------
hikari.guilds.Member
Object of the member that was updated.
Raises
------
hikari.errors.BadRequestError
If any of the fields that are passed have an invalid value.
hikari.errors.ForbiddenError
If you are missing a permission to do an action.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.NotFoundError
If the guild or the user are not found.
hikari.errors.RateLimitTooLongError
Raised in the event that a rate limit occurs that is
longer than `max_rate_limit` when making a request.
hikari.errors.RateLimitedError
Usually, Hikari will handle and retry on hitting
rate-limits automatically. This includes most bucket-specific
rate-limits and global rate-limits. In some rare edge cases,
however, Discord implements other undocumented rules for
rate-limiting, such as limits per attribute. These cannot be
detected or handled normally by Hikari due to their undocumented
nature, and will trigger this exception if they occur.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
if nick is not undefined.UNDEFINED:
deprecation.warn_deprecated("nick", alternative="nickname")
nickname = nick
return await self.user.app.rest.edit_member(
self.guild_id,
self.user.id,
nickname=nickname,
roles=roles,
mute=mute,
deaf=deaf,
voice_channel=voice_channel,
communication_disabled_until=communication_disabled_until,
reason=reason,
)async def fetch_dm_channel() -> DMChannel: ...
Inherited from:
User.fetch_dm_channel
Fetch the DM channel for this user.
DMChannelUnauthorizedErrorNotFoundErrorRateLimitTooLongErrormax_rate_limit when making a request.RateLimitedErrorInternalServerErrorasync def fetch_dm_channel(self) -> channels_.DMChannel:
return await self.user.fetch_dm_channel()