Skip to content

~.member

Member Events

MemberEvent dataclass

MemberEvent()

Bases: WaveEvent

Base member event implementation.

member instance-attribute

member: hikari.Member

The member that this event references.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

MemberDeafEvent dataclass

MemberDeafEvent()

Bases: MemberEvent

Dispatched when a member in a voice channel deafens/undeafens (themself/server).

is_deaf instance-attribute

is_deaf: bool

If the member is deafened.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberJoinEvent dataclass

MemberJoinEvent()

Bases: MemberEvent

Dispatched when a member joins a voice channel.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberLeaveEvent dataclass

MemberLeaveEvent()

Bases: MemberEvent

Dispatched when a member leaves a voice channel.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberMoveEvent dataclass

MemberMoveEvent()

Bases: MemberEvent

Dispatched when a member moves voice channels.

old_channel_id instance-attribute

old_channel_id: hikari.Snowflake

The ID of the channel that was left.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberMuteEvent dataclass

MemberMuteEvent()

Bases: MemberEvent

Dispatched when a member in a voice channel mutes/unmutes (themself/server).

is_mute instance-attribute

is_mute: bool

If the member is muted.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberSpeechEvent dataclass

MemberSpeechEvent()

Bases: MemberEvent

Dispatched when a member in a voice channel finishes speaking and you wish to handle their voice packets.

audio instance-attribute

audio: list[bytes]

The Opus audio emitted from this member.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberStartSpeakingEvent dataclass

MemberStartSpeakingEvent()

Bases: MemberEvent

Dispatched when a member in a voice channel begins speaking.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.

MemberStopSpeakingEvent dataclass

MemberStopSpeakingEvent()

Bases: MemberEvent

Dispatched when a member in a voice channel stops speaking.

channel_id instance-attribute

channel_id: hikari.Snowflake

The ID of the channel.

guild_id instance-attribute

guild_id: hikari.Snowflake

The ID of the guild the channel is in.

member instance-attribute

member: hikari.Member

The member that this event references.