discord4j.core.event.domain

Class InviteDeleteEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.InviteDeleteEvent

public class InviteDeleteEvent
extends Event

Dispatched when an invite to a channel is deleted.

This event is dispatched by Discord.

See Also:

Invite Delete

Constructor Summary

Constructors

Constructor and Description
InviteDeleteEvent(GatewayDiscordClient client, ShardInfo shardInfo, Long guildId, long channelId, String code)

Method Summary

Modifier and Type	Method and Description
Snowflake	getChannelId() Gets the Snowflake ID of the Channel where the invite was deleted.
String	getCode() Gets the invite code (unique ID).
Mono<Guild>	getGuild() Requests to retrieve the Guild that had an invite deleted in this event.
Optional<Snowflake>	getGuildId() Gets the Snowflake ID of the Guild involved in the event, if present.
String	toString()

Methods inherited from class discord4j.core.event.domain.Event

getClient, getShardInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InviteDeleteEvent

public InviteDeleteEvent(GatewayDiscordClient client,
                         ShardInfo shardInfo,
                         Long guildId,
                         long channelId,
                         String code)

Method Detail

getGuildId

public Optional<Snowflake> getGuildId()

Gets the Snowflake ID of the Guild involved in the event, if present.

Returns:

The ID of the guild involved, if present.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the Guild that had an invite deleted in this event.

Returns:

A Mono where, upon successful completion, emits the Guild involved in the event. If an error is received, it is emitted through the Mono.

getChannelId

public Snowflake getChannelId()

Gets the Snowflake ID of the Channel where the invite was deleted.

Returns:

The ID of the channel involved.

getCode

public final String getCode()

Gets the invite code (unique ID).

Returns:

The invite code (unique ID).

toString

public String toString()

Overrides:

toString in class Object