Interface ServerLinks

Method Details

• getLink

  @Nullable @Nullable ServerLinks.ServerLink getLink(@NotNull @NotNull ServerLinks.Type type)

  Gets the link of a given type, if it exists.

  Parameters:

  type - link type

  Returns:

  link or null

• getLinks

  @NotNull @NotNull List<ServerLinks.ServerLink> getLinks()

  Gets an immutable list of all links.

  Returns:

  immutable list

• setLink

  @NotNull @NotNull ServerLinks.ServerLink setLink(@NotNull @NotNull ServerLinks.Type type, @NotNull @NotNull URI url)

  Adds the given link, overwriting the first link of the same type if already set.

  Parameters:

  type - link type

  url - link url

  Returns:

  the added link

• addLink

  @NotNull @NotNull ServerLinks.ServerLink addLink(@NotNull @NotNull ServerLinks.Type type, @NotNull @NotNull URI url)

  Adds the given link to the list of links.

  Parameters:

  type - link type

  url - link url

  Returns:

  the added link

• addLink

  @NotNull @NotNull ServerLinks.ServerLink addLink(@NotNull Component displayName, @NotNull @NotNull URI url)

  Adds the given link to the list of links.

  Parameters:

  displayName - link name / display text Component

  url - link url

  Returns:

  the added link

• addLink

  @Deprecated @NotNull @NotNull ServerLinks.ServerLink addLink(@NotNull @NotNull String displayName, @NotNull @NotNull URI url)

  Deprecated.

  in favour of addLink(net.kyori.adventure.text.Component, URI)

  Adds the given link to the list of links.

  Parameters:

  displayName - link name / display text

  url - link url

  Returns:

  the added link

• removeLink

  boolean removeLink(@NotNull @NotNull ServerLinks.ServerLink link)

  Removes the given link.

  Parameters:

  link - the link to remove

  Returns:

  if the link existed and was removed

• copy

  @NotNull @NotNull ServerLinks copy()

  Returns a copy of this link collection, unassociated from the server.

  Returns:

  copied links