Member Utilities API Reference

toolbox.members.calculate_permissions(member: hikari.guilds.Member, channel: Optional[hikari.channels.PermissibleGuildChannel] = None) → hikari.permissions.Permissions[source]

Calculate the permissions of a member. If a channel is provided, channel overwrites will be taken into account.

Parameters

  • member (hikari.Member) – The member to calculate the permissions of.

  • channel (hikari.GuildChannel, optional) – The channel for permission overwrite calculations, by default None.

Returns

The calculated permissions.

Return type

hikari.Permissions

Raises

CacheFailureError – Some objects could not be resolved from cache to perform the operation.

toolbox.members.can_moderate(moderator: hikari.guilds.Member, member: hikari.guilds.Member, permissions: hikari.permissions.Permissions = <Permissions.NONE: 0>) → bool[source]

Returns True if “moderator” can execute moderation actions on “member”, also checks if “moderator” has “permissions”.

Parameters

  • moderator (hikari.Member) – The moderator to check.

  • member (hikari.Member) – The member to check.

  • permissions (hikari.Permissions) – The permissions moderator should have.

Returns

Whether “moderator” can execute moderation actions on “member”.

Return type

bool

Raises

CacheFailureError – Some objects could not be resolved from cache to perform the operation.

toolbox.members.get_member_color(member: hikari.guilds.Member) → hikari.colors.Color[source]

Retrieves the color of a member based on the top colored role.

Parameters

member (hikari.Member) – The member to get the color of.

Returns

The retrieved color object. If no color is found, it will return RGB(0, 0, 0).

Return type

hikari.Color

toolbox.members.get_possessive(user: hikari.users.User) → str[source]

Returns the possessive noun of a user or a member.

If a Member is passed, the display name is used to form the possessive noun when possible. In all other situations, the username is used instead.

Parameters

user (User) – The user or member to get the possessive noun of.

Returns

The possessive noun of the user or member.

Return type

str

toolbox.members.is_above(member1: hikari.guilds.Member, member2: hikari.guilds.Member) → bool[source]

Returns True if member1’s top role’s position is higher than member2’s.

Parameters

  • member1 (hikari.Member) – The first member to compare.

  • member2 (hikari.Member) – The second member to compare.

Returns

Whether member1’s top role’s position is higher than member2’s.

Return type

bool