Package discord4j.oauth2
Enum Class Scope
- All Implemented Interfaces:
Serializable,Comparable<Scope>,Constable
A permission granted to an
AccessToken which grants access to an associated user-specific resource.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAllows retrieving data from list of user's game activities.Allows updating user's activity.Allows reading build data for user's applications.Allows uploading builds for user's applications.Allows using slash commands in user's selected guild.Allows your app to update permissions for its commands in a guild a user has permissions to.Allows updating slash commands using anAccessTokenexchanged via a client credentials grant.Allows reading entitlements for user's applications.Allows reading and updating store data for user's applications.Joins a bot to user's selected guild.Allows retrieving user's linked third-party accounts.Allows your app to see information about the user's DMs and group DMs.Allows retrieving user's email and email verification status.Allows joining user to a group DM.Allows retrieving partial data from list of user's guilds.Allows joining user to a guild.Allows returning user's member information in a guild.Allows reading all messages from user's local Discord client via RPC.Allows retrieving user's friends and implicit relationships.Allows your app to update a user's connection and metadata for the app.Allows control of user's local Discord client via RPC.for local rpc server access, this allows you to control a user's local Discord client.Allows receiving notifications from user's local Discord client via RPC.For local rpc server access, this allows you to read a user's voice settings and listen for voice events.For local rpc server access, this allows you to update a user's voice settings.Allows your app to connect to voice on user's behalf and see all the voice members.Generates a webhook which can be used to execute the webhook in user's selected channel. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringConstruct a string from the values for each suppliedScope.getValue()static ScopeConstructs aScopefrom the given value.booleanGets whether thisScoperequires approval from Discord to use.static ScopeReturns the enum constant of this class with the specified name.static Scope[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ACTIVITIES_READ
Allows retrieving data from list of user's game activities. -
ACTIVITIES_WRITE
Allows updating user's activity. -
APPLICATIONS_BUILDS_READ
Allows reading build data for user's applications. -
APPLICATIONS_BUILDS_UPLOAD
Allows uploading builds for user's applications. -
APPLICATIONS_COMMANDS
Allows using slash commands in user's selected guild. -
APPLICATIONS_COMMANDS_UPDATE
Allows updating slash commands using anAccessTokenexchanged via a client credentials grant. -
APPLICATIONS_COMMANDS_PERMISSIONS_UPDATE
Allows your app to update permissions for its commands in a guild a user has permissions to. -
APPLICATIONS_ENTITLEMENTS
Allows reading entitlements for user's applications. -
APPLICATIONS_STORE_UPDATE
Allows reading and updating store data for user's applications. -
BOT
Joins a bot to user's selected guild. -
CONNECTIONS
Allows retrieving user's linked third-party accounts. -
DM_CHANNELS_READ
Allows your app to see information about the user's DMs and group DMs. -
EMAIL
Allows retrieving user's email and email verification status. -
GDM_JOIN
Allows joining user to a group DM. -
GUILDS
Allows retrieving partial data from list of user's guilds. -
GUILDS_JOIN
Allows joining user to a guild. -
GUILDS_MEMBERS_READ
Allows returning user's member information in a guild. -
IDENTIFY
-
MESSAGES_READ
Allows reading all messages from user's local Discord client via RPC. Also allows reading messages from user's channels that have been created by the Discord application associated with theAccessTokenof thisScope. -
RELATIONSHIPS_READ
Allows retrieving user's friends and implicit relationships. -
ROLE_CONNECTIONS_WRITE
Allows your app to update a user's connection and metadata for the app. -
RPC
Allows control of user's local Discord client via RPC. -
RPC_ACTIVITIES_WRITE
for local rpc server access, this allows you to control a user's local Discord client. -
RPC_NOTIFICATIONS_READ
Allows receiving notifications from user's local Discord client via RPC. -
RPC_VOICE_READ
For local rpc server access, this allows you to read a user's voice settings and listen for voice events. -
RPC_VOICE_WRITE
For local rpc server access, this allows you to update a user's voice settings. -
VOICE
Allows your app to connect to voice on user's behalf and see all the voice members. -
WEBHOOK_INCOMING
Generates a webhook which can be used to execute the webhook in user's selected channel.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-
getValue
-
requiresDiscordApproval
public boolean requiresDiscordApproval()Gets whether thisScoperequires approval from Discord to use.- Returns:
- Whether this
Scoperequires approval from Discord to use.
-
of
Constructs aScopefrom the given value.- Parameters:
value- The value to construct aScopefrom.- Returns:
- The
Scopefrom the given value.
-
asString
Construct a string from the values for each suppliedScope.- Parameters:
first- a scope to includerest- the remaining scopes to include- Returns:
- a string concatenation of each scope supplied, separated by a space
-