Package net.dv8tion.jda.api.entities

Enum TeamMember.RoleType

java.lang.Object
java.lang.Enum<TeamMember.RoleType>
net.dv8tion.jda.api.entities.TeamMember.RoleType
All Implemented Interfaces:
Serializable, Comparable<TeamMember.RoleType>
Enclosing interface:
TeamMember
public static enum TeamMember.RoleType extends Enum<TeamMember.RoleType>
The role in the team.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADMIN
    Admins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps.
    DEVELOPER
    Members which can access information about team-owned apps, like the client secret or public key.
    OWNER
    Owners are the most permissible role, and can take destructive, irreversible actions like deleting team-owned apps or the team itself.
    READ_ONLY
    Members which can access information about a team and any team-owned apps.
    UNKNOWN
    Placeholder for future types

  • Method Summary

    Modifier and Type
    Method
    Description
    static TeamMember.RoleType
    fromKey(String key)
    Resolves the provided key to the correct RoleType.
    String
    getKey()
    The key for this role that is used in the API.
    static TeamMember.RoleType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static TeamMember.RoleType[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • OWNER

      public static final TeamMember.RoleType OWNER
      Owners are the most permissible role, and can take destructive, irreversible actions like deleting team-owned apps or the team itself.

      Teams are limited to one owner.

    • ADMIN

      public static final TeamMember.RoleType ADMIN
      Admins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps.

    • DEVELOPER

      public static final TeamMember.RoleType DEVELOPER
      Members which can access information about team-owned apps, like the client secret or public key.
      They can also take limited actions on team-owned apps, like configuring interaction endpoints or resetting the bot token.
      Members with the Developer role cannot manage the team or its members, or take destructive actions on team-owned apps.

    • READ_ONLY

      public static final TeamMember.RoleType READ_ONLY
      Members which can access information about a team and any team-owned apps.
      Some examples include getting the IDs of applications and exporting payout records.
      Members can also invite bots associated with team-owned apps that are marked private.

    • UNKNOWN

      public static final TeamMember.RoleType UNKNOWN
      Placeholder for future types

  • Method Details

    • values

      public static TeamMember.RoleType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static TeamMember.RoleType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getKey

      @Nonnull public String getKey()
      The key for this role that is used in the API.
      Returns:
      The key for this role

    • fromKey

      @Nonnull public static TeamMember.RoleType fromKey(@Nonnull String key)
      Resolves the provided key to the correct RoleType.

      Note: OWNER will never be returned, check the team owner ID instead.

      Parameters:
      key - The key to resolve
      Returns:
      The RoleType, or UNKNOWN