Announcement

public interface Announcement

Represents a broadcast announcement that is sent to one or more channels.

Create instances via the static factory methods of(Component, Iterable) or of(Component, ChatChannel...).

Method Summary

Modifier and Type

Method

Description

@NotNull Iterable<ChatChannel>

channels()

Returns the channels this announcement will be broadcast to.

static Announcement

fromConfigField(AnnouncementsSettings.Announcement announcementField)

Creates an announcement from its configuration-file representation.

@NotNull Component

message()

Returns the message component that will be sent.

static Announcement

of(@NotNull Component message, @NotNull Iterable<ChatChannel> channels)

Creates a new announcement targeting the given channels.

static Announcement

of(@NotNull Component message, @NotNull ChatChannel... channels)

Creates a new announcement targeting the given channels.

Method Details
- of
  
  static Announcement of(@NotNull @NotNull Component message, @NotNull @NotNull Iterable<ChatChannel> channels)
  
  Creates a new announcement targeting the given channels.
  
  Parameters:
  
  message - the message to broadcast
  
  channels - the channels to send the message to
  
  Returns:
  
  a new announcement instance
- of
  
  static Announcement of(@NotNull @NotNull Component message, @NotNull @NotNull ChatChannel... channels)
  
  Creates a new announcement targeting the given channels.
  
  Parameters:
  
  message - the message to broadcast
  
  channels - the channels to send the message to
  
  Returns:
  
  a new announcement instance
- fromConfigField
  
  static Announcement fromConfigField(AnnouncementsSettings.Announcement announcementField)
  
  Creates an announcement from its configuration-file representation.
  
  Parameters:
  
  announcementField - the config section representing this announcement
  
  Returns:
  
  a new announcement instance
- channels
  
  @NotNull @NotNull Iterable<ChatChannel> channels()
  
  Returns the channels this announcement will be broadcast to.
  
  Returns:
  
  the target channels
- message
  
  @NotNull @NotNull Component message()
  
  Returns the message component that will be sent.
  
  Returns:
  
  the announcement message