Interface ChannelCategory

    • Method Detail

      • getType

        default ChannelType getType​()
        Description copied from interface: Channel
        Gets the type of the channel.
        Specified by:
        getType in interface Channel
        Returns:
        The type of the channel.
      • getChannels

        List<ServerChannel> getChannels​()
        Gets a list with all channels which this category contains.
        Returns:
        A list with all channels which this category contains.
      • getVisibleChannels

        default List<ServerChannel> getVisibleChannels​(User user)
        Gets a sorted (by position) list with all channels in this category the given user can see.
        Parameters:
        user - The user to check.
        Returns:
        The visible channels in the category.
      • canSeeAll

        default boolean canSeeAll​(User user)
        Checks if the given user can see all channels in this category.
        Parameters:
        user - The user to check.
        Returns:
        Whether the given user can see all channels in this category or not.
      • canYouSeeAll

        default boolean canYouSeeAll​()
        Checks if the user of the connected account can see all channels in this category.
        Returns:
        Whether the user of the connected account can see all channels in this category or not.
      • isNsfw

        boolean isNsfw​()
        Checks is the category is "not safe for work".
        Returns:
        Whether the category is "not safe for work" or not.
      • addCategorizable

        default CompletableFuture<Void> addCategorizable​(Categorizable categorizable)
        Adds a categorizable to this category.
        Parameters:
        categorizable - The categorizable to add.
        Returns:
        A future to check if the update was successful.
      • removeCategorizable

        default CompletableFuture<Void> removeCategorizable​(Categorizable categorizable)
        Removes a categorizable from this category.
        Parameters:
        categorizable - The categorizable to remove.
        Returns:
        A future to check if the update was successful.
      • getCurrentCachedInstance

        default Optional<ChannelCategory> getCurrentCachedInstance​()
        Description copied from interface: UpdatableFromCache
        Gets an updated instance of this entity from the cache. This is for example necessary if an instance got invalid by a reconnect to Discord which invalidates all existing instances which means they do not get any further updates from Discord applied. Due to that, references to instances should usually not be held for an extended period of time. If they are, this method can be used to retrieve the current instance from the cache, that gets updates from Discord, in case this one was invalidated.

        This method returns the currently cached entity, or an empty Optional if the entity is not cached any longer, for example because it was deleted or the message was thrown out of the cache.

        Specified by:
        getCurrentCachedInstance in interface Channel
        Specified by:
        getCurrentCachedInstance in interface ServerChannel
        Specified by:
        getCurrentCachedInstance in interface UpdatableFromCache
        Returns:
        The current cached instance.
      • getLatestInstance

        default CompletableFuture<ChannelCategory> getLatestInstance​()
        Description copied from interface: Updatable
        Gets an updated instance of this entity from the cache or from Discord directly. This is for example necessary if an instance got invalid by a reconnect to Discord which invalidates all existing instances which means they do not get any further updates from Discord applied. Due to that, references to instances should usually not be held for an extended period of time. If they are, this method can be used to retrieve the current instance from the cache if present or from Discord directly.

        This method returns the currently cached entity if present, or request the entity from Discord if it is not cached or not permanently cached. If the entity is a fully cached entity and is not in the cache any longer, for example because it was deleted or the message was thrown out of the cache, the CompletableFuture completes exceptionally with a NoSuchElementException. If a request to Discord is made, the according remote call exception will be used to complete the CompletableFuture exceptionally.

        Specified by:
        getLatestInstance in interface Channel
        Specified by:
        getLatestInstance in interface ServerChannel
        Specified by:
        getLatestInstance in interface Updatable<T extends DiscordEntity>
        Specified by:
        getLatestInstance in interface UpdatableFromCache
        Returns:
        The current cached instance.