Package dev.unnm3d.redischat.chat.objects

Class Channel.ChannelBuilder

java.lang.Object
dev.unnm3d.redischat.api.objects.ChannelAudience.ChannelAudienceBuilder
dev.unnm3d.redischat.api.objects.Channel.ChannelBuilder
Enclosing class:
Channel
public static class Channel.ChannelBuilder extends ChannelAudience.ChannelAudienceBuilder

  • Constructor Details

    • ChannelBuilder

      public ChannelBuilder(String name)
      Constructs a new ChannelBuilder with the specified name.
      Parameters:
      name - The name of the channel.

  • Method Details

    • displayName

      public Channel.ChannelBuilder displayName(String displayName)
      Sets the display name of the channel.
      Parameters:
      displayName - The display name to set.
      Returns:
      The current instance of ChannelBuilder.

    • format

      public Channel.ChannelBuilder format(String format)
      Sets the format of the channel.
      Parameters:
      format - The format to set.
      Returns:
      The current instance of ChannelBuilder.

    • rateLimit

      public Channel.ChannelBuilder rateLimit(int rateLimit)
      Sets the rate limit of the channel.
      Parameters:
      rateLimit - The rate limit to set.
      Returns:
      The current instance of ChannelBuilder.

    • rateLimitPeriod

      public Channel.ChannelBuilder rateLimitPeriod(int rateLimitPeriod)
      Sets the rate limit period of the channel.
      Parameters:
      rateLimitPeriod - The rate limit period to set.
      Returns:
      The current instance of ChannelBuilder.

    • discordWebhook

      public Channel.ChannelBuilder discordWebhook(String discordWebhook)
      Sets the Discord webhook URL of the channel.
      Parameters:
      discordWebhook - The Discord webhook URL to set.
      Returns:
      The current instance of ChannelBuilder.

    • filtered

      public Channel.ChannelBuilder filtered(boolean filtered)
      Sets whether the channel is filtered.
      Parameters:
      filtered - True if the channel is filtered, false otherwise.
      Returns:
      The current instance of ChannelBuilder.

    • shownByDefault

      public Channel.ChannelBuilder shownByDefault(boolean shownByDefault)
      Sets whether the channel is shown by default.
      Parameters:
      shownByDefault - True if the channel is shown by default, false otherwise.
      Returns:
      The current instance of ChannelBuilder.

    • proximityDistance

      public Channel.ChannelBuilder proximityDistance(int proximityDistance)
      Sets the proximity distance of the channel.
      Overrides:
      proximityDistance in class ChannelAudience.ChannelAudienceBuilder
      Parameters:
      proximityDistance - The proximity distance to set.
      Returns:
      The current instance of ChannelBuilder.

    • permissionEnabled

      public Channel.ChannelBuilder permissionEnabled(boolean permissionEnabled)
      Sets whether permissions are enabled for the channel.
      Parameters:
      permissionEnabled - True if permissions are enabled, false otherwise.
      Returns:
      The current instance of ChannelBuilder.

    • permission

      public Channel.ChannelBuilder permission(String... permissions)
      Adds permissions to the channel.
      Overrides:
      permission in class ChannelAudience.ChannelAudienceBuilder
      Parameters:
      permissions - Varargs parameter representing the permissions to add.
      Returns:
      The current instance of ChannelBuilder.

    • permissions

      public Channel.ChannelBuilder permissions(List<String> permissions)
      Sets the permissions for the channel.
      Overrides:
      permissions in class ChannelAudience.ChannelAudienceBuilder
      Parameters:
      permissions - A list of permissions to set.
      Returns:
      The current instance of ChannelBuilder.

    • notificationSound

      public Channel.ChannelBuilder notificationSound(String notificationSound)
      Sets the notification sound of the channel.
      Parameters:
      notificationSound - The notification sound to set.
      Returns:
      The current instance of ChannelBuilder.

    • build

      public Channel build()
      Overrides:
      build in class ChannelAudience.ChannelAudienceBuilder

    • toString

      public String toString()
      Overrides:
      toString in class ChannelAudience.ChannelAudienceBuilder