Package discord4j.core.event.domain.channel

Class TextChannelUpdateEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.channel.ChannelEvent

discord4j.core.event.domain.channel.TextChannelUpdateEvent

public class TextChannelUpdateEvent
extends ChannelEvent

Dispatched when a TextChannel is updated in a guild.

The TextChannel may have been turned into a NewsChannel.

The old text channel may not be present if channels are not stored.

This event is dispatched by Discord.

See Also:

Channel Update

Constructor Summary

Constructors

Constructor	Description
TextChannelUpdateEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, GuildMessageChannel current, TextChannel old)

Method Summary

Modifier and Type	Method	Description
GuildMessageChannel	getCurrent()	Gets the current, new version of the TextChannel that was updated in this event.
Optional<NewsChannel>	getNewsChannel()	Gets the current, new version of the TextChannel that was updated in this event as an optional value of a NewsChannel.
Optional<TextChannel>	getOld()	Gets the old version of the TextChannel that was updated in this event, if present.
Optional<TextChannel>	getTextChannel()	Gets the current, new version of the TextChannel that was updated in this event as an optional value of a TextChannel.
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

TextChannelUpdateEvent

public TextChannelUpdateEvent(GatewayDiscordClient gateway,
                              ShardInfo shardInfo,
                              GuildMessageChannel current,
                              @Nullable
                              TextChannel old)

Method Detail

getCurrent

public GuildMessageChannel getCurrent()

Gets the current, new version of the TextChannel that was updated in this event. The TextChannel may have been turned into a NewsChannel.

Returns:

The current version of the updated TextChannel.

getNewsChannel

public Optional<NewsChannel> getNewsChannel()

Gets the current, new version of the TextChannel that was updated in this event as an optional value of a NewsChannel.

Returns:

An optional value of a NewsChannel. Empty if the channel continued to be a TextChannel.

getTextChannel

public Optional<TextChannel> getTextChannel()

Gets the current, new version of the TextChannel that was updated in this event as an optional value of a TextChannel.

Returns:

An optional value of a TextChannel. Empty if the channel was changed to a NewsChannel.

getOld

public Optional<TextChannel> getOld()

Gets the old version of the TextChannel that was updated in this event, if present. This may not be available if TextChannels are not stored.

Returns:

The old version of the updated TextChannel, if present.

toString

public String toString()

Overrides:

toString in class Object