curious.dataclasses.member

Wrappers for Member objects (Users with guilds).

Classes

Member(client, **kwargs) A member represents somebody who is inside a guild.
MemberRoleContainer(member) Represents the roles of a Member.
Nickname(parent, value) Represents the nickname of a Member.
class curious.dataclasses.member.Member(client, **kwargs)[source]

Bases: curious.dataclasses.bases.Dataclass

A member represents somebody who is inside a guild.

Inspects the stack to ensure we’re being called correctly.

_copy()[source]

Copies a member object.

await ban(delete_message_days=7)[source]

Bans this member from the guild.

Parameters:delete_message_days (int) – The number of days of messages to delete.
colour
Return type:int
Returns:The computed colour of this user.
game
Return type:Game
Returns:The current Game this member is playing.
guild
Return type:Guild
Returns:The Guild associated with this member.
guild_permissions
Return type:Permissions
Returns:The calculated guild permissions for a member.
await kick()[source]

Kicks this member from the guild.

mention
Return type:str
Returns:A string that mentions this member.
name
Return type:str
Returns:The computed display name of this user.
nickname

Represents a member’s nickname.

Getter:A _Nickname for this member.
Setter:Coerces a string nickname into a _Nickname. Do not use.
Return type:Nickname
await send(content, *args, **kwargs)[source]

Sends a message to a member in DM.

This is a shortcut for User.send().

snowflake_timestamp
Return type:datetime
Returns:The timestamp of the snowflake.
status
Return type:Status
Returns:The current Status of this member.
top_role
Return type:Role
Returns:This member’s top-most Role.
user
Return type:User
Returns:The underlying User for this member.
voice
Return type:VoiceState
Returns:The VoiceState associated with this member.
class curious.dataclasses.member.MemberRoleContainer(member: curious.dataclasses.member.Member)[source]

Bases: collections.abc.Sequence

Represents the roles of a Member.

await add(*roles)[source]

Adds roles to this member.

Parameters:roles (Role) – The Role objects to add to this member’s role list.
count(value) → integer -- return number of occurrences of value
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

await remove(*roles)[source]

Removes roles from this member.

Parameters:roles (Role) – The roles to remove.
top_role
Return type:Role
Returns:The top Role for this member.
class curious.dataclasses.member.Nickname(parent: curious.dataclasses.member.Member, value: str)[source]

Bases: object

Represents the nickname of a Member.

await reset()[source]

Resets a member’s nickname.

Return type:Nickname
await set(new_nickname)[source]

Sets the nickname of the username.

Parameters:new_nickname (str) – The new nickname of this user. If None, will reset the nickname.
Return type:Nickname