Interface ServerVoiceChannel

    • 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.
      • getBitrate

        int getBitrate​()
        Gets the bitrate (int bits) of the channel.
        Returns:
        The bitrate of the channel.
      • getUserLimit

        Optional<Integer> getUserLimit​()
        Gets the user limit of the channel.
        Returns:
        The user limit.
      • getConnectedUserIds

        Collection<Long> getConnectedUserIds​()
        Gets the ids of the users that are connected to this server voice channel.
        Returns:
        The ids of the users that are connected to this server voice channel.
      • getConnectedUsers

        Collection<User> getConnectedUsers​()
        Gets the users that are connected to this server voice channel.
        Returns:
        The users that are connected to this server voice channel.
      • isConnected

        boolean isConnected​(long userId)
        Checks whether the user with the given id is connected to this channel.
        Parameters:
        userId - The id of the user to check.
        Returns:
        Whether the user with the given id is connected to this channel or not.
      • isConnected

        default boolean isConnected​(User user)
        Checks whether the given user is connected to this channel.
        Parameters:
        user - The user to check.
        Returns:
        Whether the given user is connected to this channel or not.
      • updateBitrate

        default CompletableFuture<Void> updateBitrate​(int bitrate)
        Updates the bitrate of the channel.

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

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

        default CompletableFuture<Void> updateUserLimit​(int userLimit)
        Updates the user limit of the channel.

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

        Parameters:
        userLimit - The new user limit of the channel.
        Returns:
        A future to check if the update was successful.
      • removeUserLimit

        default CompletableFuture<Void> removeUserLimit​()
        Removes the user limit of the channel.

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

        Returns:
        A future to check if the update was successful.
      • getCurrentCachedInstance

        default Optional<ServerVoiceChannel> 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
        Specified by:
        getCurrentCachedInstance in interface VoiceChannel
        Returns:
        The current cached instance.
      • getLatestInstance

        default CompletableFuture<ServerVoiceChannel> 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
        Specified by:
        getLatestInstance in interface VoiceChannel
        Returns:
        The current cached instance.