Package com.mewna.catnip.entity.channel

Interface GuildChannel

All Superinterfaces:
Channel, Entity, GuildEntity, HasGuild, HasName, HasParentChannel, Snowflake, Timestamped
All Known Subinterfaces:
Category, NewsChannel, StageChannel, StoreChannel, TextChannel, ThreadChannel, VoiceChannel
All Known Implementing Classes:
CategoryImpl, NewsChannelImpl, StageChannelImpl, StoreChannelImpl, TextChannelImpl, ThreadChannelImpl, VoiceChannelImpl
public interface GuildChannel extends GuildEntity, Channel, HasName, HasParentChannel
A channel in a guild.
Since:
9/12/18
Author:
natanbc

  • Method Details

    • position

      @CheckReturnValue int position()
      Returns:
      The position of the channel.

    • overrides

      @Nonnull @CheckReturnValue List<PermissionOverride> overrides()
      Returns:
      The permission overrides set on this channel. Will never be null, but may be empty.

    • isDM

      @CheckReturnValue default boolean isDM()
      Specified by:
      isDM in interface Channel
      Returns:
      Whether or not this channel is a DM; see Channel.isUserDM() and Channel.isGroupDM() for more.

    • isGroupDM

      @CheckReturnValue default boolean isGroupDM()
      Specified by:
      isGroupDM in interface Channel
      Returns:
      Whether or not this channel is a group DM with at least 1 other user.

    • isUserDM

      default boolean isUserDM()
      Specified by:
      isUserDM in interface Channel
      Returns:
      Whether or not this channel is a DM with a single user.

    • isGuild

      @CheckReturnValue default boolean isGuild()
      Specified by:
      isGuild in interface Channel
      Returns:
      Whether or not this channel is in a guild.

    • createInvite

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Single<CreatedInvite> createInvite(@Nullable InviteCreateOptions options, @Nullable String reason)
      Creates a new invite to this channel.
      Parameters:
      options - The options to set on the invite.
      reason - The reason that will be visible in audit log
      Returns:
      A Observable that completes when the invite is created.

    • createInvite

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Single<CreatedInvite> createInvite(@Nullable InviteCreateOptions options)
      Creates a new invite to this channel.
      Parameters:
      options - The options to set on the invite.
      Returns:
      A Observable that completes when the invite is created.

    • createInvite

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Single<CreatedInvite> createInvite()
      Creates a new invite to this channel.
      Returns:
      A Observable that completes when the invite is created.

    • fetchInvites

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Observable<CreatedInvite> fetchInvites()
      The list of all invites to this channel. Will never be null, but may be empty.
      Returns:
      A Observable that completes when the invite is created.

    • edit

      @Nonnull @CheckReturnValue default GuildChannel.ChannelEditFields edit()
      Edit this channel.
      Returns:
      A channel editor that can complete the editing.

    • delete

      @Nonnull @CheckReturnValue default io.reactivex.rxjava3.core.Single<Channel> delete()
      Description copied from interface: Channel
      Deletes the channel. This operation cannot be undone.
      Specified by:
      delete in interface Channel
      Returns:
      A Observable that is completed when the channel is deleted.