Package net.dv8tion.jda.api.entities
Enum TeamMember.RoleType
- All Implemented Interfaces:
Serializable
,Comparable<TeamMember.RoleType>
- Enclosing interface:
- TeamMember
The role in the team.
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAdmins have similar access as owners, except they cannot take destructive actions on the team or team-owned apps.Members which can access information about team-owned apps, like the client secret or public key.Owners are the most permissible role, and can take destructive, irreversible actions like deleting team-owned apps or the team itself.Members which can access information about a team and any team-owned apps.Placeholder for future types -
Method Summary
Modifier and TypeMethodDescriptionstatic TeamMember.RoleType
Resolves the provided key to the correct RoleType.getKey()
The key for this role that is used in the API.static TeamMember.RoleType
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.
-
Enum Constant Details
-
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
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.
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
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
Placeholder for future types
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getKey
The key for this role that is used in the API.- Returns:
- The key for this role
-
fromKey
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
-