Package net.draycia.carbon.api.users

Interface Party

@DefaultQualifier(org.checkerframework.checker.nullness.qual.NonNull.class) public interface Party
Reference to a chat party.
Since:
3.0.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMember(UUID id)
    Add a user to this party.
    void
    disband()
    Disband this party.
    UUID
    id()
    Get the unique id of this party.
    Set<UUID>
    members()
    Get a snapshot of the current party members.
    Component
    name()
    Get the name of this party.
    void
    removeMember(UUID id)
    Remove a user from this party.

  • Method Details

    • name

      Component name()
      Get the name of this party.
      Returns:
      party name
      Since:
      3.0.0

    • id

      UUID id()
      Get the unique id of this party.
      Returns:
      party id
      Since:
      3.0.0

    • members

      Set<UUID> members()
      Get a snapshot of the current party members.
      Returns:
      party members
      Since:
      3.0.0

    • addMember

      void addMember(UUID id)
      Add a user to this party. They will automatically be removed from their previous party if necessary.
      Parameters:
      id - user id
      Since:
      3.0.0

    • removeMember

      void removeMember(UUID id)
      Remove a user from this party.
      Parameters:
      id - user id
      Since:
      3.0.0

    • disband

      void disband()
      Disband this party. Will remove all members and delete persistent data.
      Since:
      3.0.0