Package net.dv8tion.jda.api.entities.channel.unions

Interface ChannelUnion

All Superinterfaces:
Channel, Formattable, IMentionable, ISnowflake
public interface ChannelUnion extends Channel
A union representing all channel types that implement Channel.
This class extends Channel and primarily acts as a discovery tool for developers to discover some common interfaces that a Channel could be cast to.
This interface represents the follow concrete channel types:

  • Method Details

    • asPrivateChannel

      @Nonnull PrivateChannel asPrivateChannel()
      Casts this union to a PrivateChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 PrivateChannel channel = union.asPrivateChannel();
 PrivateChannel channel2 = (PrivateChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.PRIVATE to validate whether you can call this method in addition to normal instanceof checks: channel instanceof PrivateChannel
      Returns:
      The channel as a PrivateChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a PrivateChannel.

    • asTextChannel

      @Nonnull TextChannel asTextChannel()
      Casts this union to a TextChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 TextChannel channel = union.asTextChannel();
 TextChannel channel2 = (TextChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.TEXT to validate whether you can call this method in addition to normal instanceof checks: channel instanceof TextChannel
      Returns:
      The channel as a TextChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a TextChannel.

    • asNewsChannel

      @Nonnull NewsChannel asNewsChannel()
      Casts this union to a NewsChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 NewsChannel channel = union.asNewsChannel();
 NewsChannel channel2 = (NewsChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.NEWS to validate whether you can call this method in addition to normal instanceof checks: channel instanceof NewsChannel
      Returns:
      The channel as a NewsChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a NewsChannel.

    • asThreadChannel

      @Nonnull ThreadChannel asThreadChannel()
      Casts this union to a ThreadChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 ThreadChannel channel = union.asThreadChannel();
 ThreadChannel channel2 = (ThreadChannel) union;
      You can use Channel.getType().isThread() to validate whether you can call this method in addition to normal instanceof checks: channel instanceof ThreadChannel
      Returns:
      The channel as a ThreadChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a ThreadChannel.

    • asVoiceChannel

      @Nonnull VoiceChannel asVoiceChannel()
      Casts this union to a VoiceChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 VoiceChannel channel = union.asVoiceChannel();
 VoiceChannel channel2 = (VoiceChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.VOICE to validate whether you can call this method in addition to normal instanceof checks: channel instanceof VoiceChannel
      Returns:
      The channel as a VoiceChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a VoiceChannel.

    • asStageChannel

      @Nonnull StageChannel asStageChannel()
      Casts this union to a StageChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 StageChannel channel = union.asStageChannel();
 StageChannel channel2 = (StageChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.STAGE to validate whether you can call this method in addition to normal instanceof checks: channel instanceof StageChannel
      Returns:
      The channel as a StageChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a StageChannel.

    • asForumChannel

      @Nonnull ForumChannel asForumChannel()
      Casts this union to a ForumChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 ForumChannel channel = union.asForumChannel();
 ForumChannel channel2 = (ForumChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.FORUM to validate whether you can call this method in addition to normal instanceof checks: channel instanceof ForumChannel
      Returns:
      The channel as a ForumChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a ForumChannel.

    • asMediaChannel

      @Nonnull MediaChannel asMediaChannel()
      Casts this union to a MediaChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 MediaChannel channel = union.asMediaChannel();
 MediaChannel channel2 = (MediaChannel) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.MEDIA to validate whether you can call this method in addition to normal instanceof checks: channel instanceof MediaChannel
      Returns:
      The channel as a MediaChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a MediaChannel.

    • asCategory

      @Nonnull Category asCategory()
      Casts this union to a Category. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 Category channel = union.asCategory();
 Category channel2 = (Category) union;
      You can use Channel.getType() to see if the channel is of type ChannelType.CATEGORY to validate whether you can call this method in addition to normal instanceof checks: channel instanceof Category
      Returns:
      The channel as a Category
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a Category.

    • asMessageChannel

      @Nonnull MessageChannel asMessageChannel()
      Casts this union to a MessageChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 MessageChannel channel = union.asMessageChannel();
 MessageChannel channel2 = (MessageChannel) union;
      You can use Channel.getType().isMessage() to validate whether you can call this method in addition to normal instanceof checks: channel instanceof MessageChannel
      Returns:
      The channel as a MessageChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a MessageChannel.

    • asGuildChannel

      @Nonnull GuildChannel asGuildChannel()
      Casts this union to a GuildChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 GuildChannel channel = union.asGuildChannel();
 GuildChannel channel2 = (GuildChannel) union;
      You can use Channel.getType()isGuild() to validate whether you can call this method in addition to normal instanceof checks: channel instanceof GuildChannel
      Returns:
      The channel as a GuildChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a GuildChannel.

    • asGuildMessageChannel

      @Nonnull GuildMessageChannel asGuildMessageChannel()
      Casts this union to a GuildMessageChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 GuildMessageChannel channel = union.asGuildMessageChannel();
 GuildMessageChannel channel2 = (GuildMessageChannel) union;
      You can use Channel.getType().isGuild() and Channel.getType().isMessage() to validate whether you can call this method in addition to normal instanceof checks: channel instanceof GuildMessageChannel
      Returns:
      The channel as a GuildMessageChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a GuildMessageChannel.

    • asAudioChannel

      @Nonnull AudioChannel asAudioChannel()
      Casts this union to a AudioChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 AudioChannel channel = union.asAudioChannel();
 AudioChannel channel2 = (AudioChannel) union;
      You can use Channel.getType().isAudio() to validate whether you can call this method in addition to normal instanceof checks: channel instanceof AudioChannel
      Returns:
      The channel as a AudioChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a AudioChannel.

    • asThreadContainer

      IThreadContainer asThreadContainer()
      Casts this union to a IThreadContainer. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 IThreadContainer channel = union.asThreadContainer();
 IThreadContainer channel2 = (IThreadContainer) union;
      You can use channel instanceof IThreadContainer to validate whether you can call this method.
      Returns:
      The channel as a IThreadContainer
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a IThreadContainer.

    • asStandardGuildChannel

      @Nonnull StandardGuildChannel asStandardGuildChannel()
      Casts this union to a StandardGuildChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 StandardGuildChannel channel = union.asStandardGuildChannel();
 StandardGuildChannel channel2 = (StandardGuildChannel) union;
      Returns:
      The channel as a StandardGuildChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a StandardGuildChannel.

    • asStandardGuildMessageChannel

      @Nonnull StandardGuildMessageChannel asStandardGuildMessageChannel()
      Casts this union to a StandardGuildMessageChannel. This method exists for developer discoverability.

      Note: This is effectively equivalent to using the cast operator: 

      
 //These are the same!
 StandardGuildMessageChannel channel = union.asStandardGuildMessageChannel();
 StandardGuildMessageChannel channel2 = (StandardGuildMessageChannel) union;
      Returns:
      The channel as a StandardGuildMessageChannel
      Throws:
      IllegalStateException - If the channel represented by this union is not actually a StandardGuildMessageChannel.