Interface ApplicationTeam

All Superinterfaces:
ISnowflake

public interface ApplicationTeam extends ISnowflake
Meta-data for the team of an application.
See Also:
  • Field Details

  • Method Details

    • getOwner

      @Nullable default TeamMember getOwner()
      Searches for the TeamMember in getMembers() that has the same user id as getOwnerIdLong().
      Its possible although unlikely that the owner of the team is not a member, in that case this will be null.
      Returns:
      Possibly-null TeamMember who owns the team
    • getOwnerId

      @Nonnull default String getOwnerId()
      The id for the user who owns this team.
      Returns:
      The owner id
    • getOwnerIdLong

      long getOwnerIdLong()
      The id for the user who owns this team.
      Returns:
      The owner id
    • getIconId

      @Nullable String getIconId()
      The id hash for the icon of this team.
      Returns:
      The icon id, or null if no icon is applied
      See Also:
    • getIconUrl

      @Nullable default String getIconUrl()
      The url for the icon of this team.
      Returns:
      The icon url, or null if no icon is applied
    • getMembers

      @Nonnull List<TeamMember> getMembers()
      Returns:
      Immutable list of team members
    • isMember

      default boolean isMember(@Nonnull User user)
      Check whether getMember(User) returns null for the provided user.
      Parameters:
      user - The user to check
      Returns:
      True, if the provided user is a member of this team
      Throws:
      IllegalArgumentException - If provided with null
    • getMember

      @Nullable default TeamMember getMember(@Nonnull User user)
      Retrieves the TeamMember instance for the provided user. If the user is not a member of this team, null is returned.
      Parameters:
      user - The user for the team member
      Returns:
      The TeamMember for the user or null
      Throws:
      IllegalArgumentException - If provided with null
    • getMemberById

      @Nullable default TeamMember getMemberById(@Nonnull String userId)
      Retrieves the TeamMember instance for the provided user id. If the user is not a member of this team, null is returned.
      Parameters:
      userId - The user id for the team member
      Returns:
      The TeamMember for the user or null
      Throws:
      IllegalArgumentException - If provided with null
    • getMemberById

      @Nullable default TeamMember getMemberById(long userId)
      Retrieves the TeamMember instance for the provided user id. If the user is not a member of this team, null is returned.
      Parameters:
      userId - The user id for the team member
      Returns:
      The TeamMember for the user or null