Package discord4j.core.event.domain.channel

Class NewsChannelUpdateEvent

java.lang.Object

discord4j.core.event.domain.Event

discord4j.core.event.domain.channel.ChannelEvent

discord4j.core.event.domain.channel.NewsChannelUpdateEvent

public class NewsChannelUpdateEvent
extends ChannelEvent

Dispatched when a NewsChannel is updated in a guild.

The NewsChannel may have been turned into a TextChannel.

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

This event is dispatched by Discord.

See Also:

Channel Update

Constructor Summary

Constructors

Constructor	Description
NewsChannelUpdateEvent(GatewayDiscordClient gateway, ShardInfo shardInfo, GuildMessageChannel current, NewsChannel old)

Method Summary

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

NewsChannelUpdateEvent

public NewsChannelUpdateEvent(GatewayDiscordClient gateway,
                              ShardInfo shardInfo,
                              GuildMessageChannel current,
                              @Nullable
                              NewsChannel old)

Method Detail

getCurrent

public GuildMessageChannel getCurrent()

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

Returns:

The current version of the updated NewsChannel.

getNewsChannel

public Optional<NewsChannel> getNewsChannel()

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

Returns:

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

getTextChannel

public Optional<TextChannel> getTextChannel()

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

Returns:

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

getOld

public Optional<NewsChannel> getOld()

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

Returns:

The old version of the updated NewsChannel, if present.

toString

public String toString()

Overrides:

toString in class Object