Package org.javacord.api.entity.channel

Interface ServerChannel

    • Method Detail

      • getServer

        Server getServer()
        Gets the server of the channel.
        Returns:
        The server of the channel.

      • createInviteBuilder

        default InviteBuilder createInviteBuilder()
        Creates an invite builder for this channel.
        Returns:
        An invite builder for this channel.

      • getInvites

        java.util.concurrent.CompletableFuture<java.util.Collection<RichInvite>> getInvites()
        Gets the invites of the server.
        Returns:
        The invites of the server.

      • createUpdater

        default ServerChannelUpdater createUpdater()
        Create an updater for this channel.
        Returns:
        An updater for this channel.

      • updateName

        default java.util.concurrent.CompletableFuture<java.lang.Void> updateName​(java.lang.String name)
        Updates the name of the channel.

        If you want to update several settings at once, it's recommended to use the ServerChannelUpdater from createUpdater() which provides a better performance!

        Parameters:
        name - The new name of the channel.
        Returns:
        A future to check if the update was successful.

      • delete

        default java.util.concurrent.CompletableFuture<java.lang.Void> delete()
        Deletes the channel.
        Returns:
        A future to tell us if the deletion was successful.

      • delete

        java.util.concurrent.CompletableFuture<java.lang.Void> delete​(java.lang.String reason)
        Deletes the channel.
        Parameters:
        reason - The audit log reason for the deletion.
        Returns:
        A future to tell us if the deletion was successful.

      • getCurrentCachedInstance

        default java.util.Optional<? extends ServerChannel> 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 UpdatableFromCache
        Returns:
        The current cached instance.

      • getLatestInstance

        default java.util.concurrent.CompletableFuture<? extends ServerChannel> 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 Updatable
        Specified by:
        getLatestInstance in interface UpdatableFromCache
        Returns:
        The current cached instance.