Package discord4j.core.object.entity.channel

Class UnknownChannel

java.lang.Object

discord4j.core.object.entity.channel.UnknownChannel

All Implemented Interfaces:

DiscordObject, Channel, Entity

public class UnknownChannel
extends Object

A Channel implementation representing an unsupported or not implemented channel type. Use getData() to retrieve entity information and Channel.getRestChannel() to obtain an instance to perform REST API operations on this channel.

Nested Class Summary

Nested classes/interfaces inherited from interface discord4j.core.object.entity.channel.Channel

Channel.Type

Constructor Summary

Constructors

Constructor	Description
UnknownChannel(GatewayDiscordClient gateway, discord4j.discordjson.json.ChannelData data)	Constructs an UnknownChannel with an associated GatewayDiscordClient and Discord data.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	delete(String reason)	Requests to delete this channel while optionally specifying a reason.
boolean	equals(Object obj)
GatewayDiscordClient	getClient()	Returns the GatewayDiscordClient that created this object.
Snowflake	getId()	Gets the Snowflake that uniquely identifies this entity.
RestChannel	getRestChannel()	Return a RestChannel handle to execute REST API operations on this entity.
Channel.Type	getType()	Gets the type of channel.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface discord4j.core.object.entity.channel.Channel

delete, getMention

Constructor Detail

UnknownChannel

public UnknownChannel(GatewayDiscordClient gateway,
                      discord4j.discordjson.json.ChannelData data)

Constructs an UnknownChannel with an associated GatewayDiscordClient and Discord data.

Parameters:

gateway - The GatewayDiscordClient associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

Method Detail

toString

public String toString()

getClient

public final GatewayDiscordClient getClient()

Description copied from interface: DiscordObject

Returns the GatewayDiscordClient that created this object. Methods in it are exclusively based on the entity cache or Store in use. Refer to calling getClient().rest() to access a DiscordClient that is capable of requesting entities directly from the REST API.

Specified by:

getClient in interface DiscordObject

Returns:

The GatewayDiscordClient associated to this object.

getId

public final Snowflake getId()

Description copied from interface: Entity

Gets the Snowflake that uniquely identifies this entity.

Specified by:

getId in interface Entity

Returns:

The Snowflake that uniquely identifies this entity.

getRestChannel

public RestChannel getRestChannel()

Description copied from interface: Channel

Return a RestChannel handle to execute REST API operations on this entity.

Specified by:

getRestChannel in interface Channel

getType

public final Channel.Type getType()

Description copied from interface: Channel

Gets the type of channel.

Specified by:

getType in interface Channel

Returns:

The type of channel.

delete

public final Mono<Void> delete(@Nullable
                               String reason)

Description copied from interface: Channel

Requests to delete this channel while optionally specifying a reason.

Specified by:

delete in interface Channel

Parameters:

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the channel has been deleted. If an error is received, it is emitted through the Mono.

equals

public final boolean equals(@Nullable
                            Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object