Index

A B C D E G H I L M O R S V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AccessToken - Class in discord4j.oauth2.object

Access token details for a single OAuth2 authorized client.

AccessToken(AccessTokenData) - Constructor for class discord4j.oauth2.object.AccessToken

ACTIVITIES_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows retrieving data from list of user's game activities.

ACTIVITIES_WRITE - Enum constant in enum class discord4j.oauth2.Scope

Allows updating user's activity.

addRedirectUri(String) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Add the given redirect URI to the list of URIs this server should receive requests from; must be a URI defined in the OAuth2 section of the Discord developer portal of the Discord application associated with the resulting server.

addScope(Scope) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Add the given scope to the list of scopes that the exchanged access token will grant.

APPLICATIONS_BUILDS_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows reading build data for user's applications.

APPLICATIONS_BUILDS_UPLOAD - Enum constant in enum class discord4j.oauth2.Scope

Allows uploading builds for user's applications.

APPLICATIONS_COMMANDS - Enum constant in enum class discord4j.oauth2.Scope

Allows using slash commands in user's selected guild.

APPLICATIONS_COMMANDS_PERMISSIONS_UPDATE - Enum constant in enum class discord4j.oauth2.Scope

Allows your app to update permissions for its commands in a guild a user has permissions to.

APPLICATIONS_COMMANDS_UPDATE - Enum constant in enum class discord4j.oauth2.Scope

Allows updating slash commands using an AccessToken exchanged via a client credentials grant.

APPLICATIONS_ENTITLEMENTS - Enum constant in enum class discord4j.oauth2.Scope

Allows reading entitlements for user's applications.

APPLICATIONS_STORE_UPDATE - Enum constant in enum class discord4j.oauth2.Scope

Allows reading and updating store data for user's applications.

apply(HttpServerRequest, HttpServerResponse) - Method in class discord4j.oauth2.DiscordOAuth2Server.OAuth2ServerHandler

asString(Scope, Scope...) - Static method in enum class discord4j.oauth2.Scope

Construct a string from the values for each supplied Scope.

B

BOT - Enum constant in enum class discord4j.oauth2.Scope

Joins a bot to user's selected guild.

build() - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Create the OAuth2Server

builder() - Static method in class discord4j.oauth2.DiscordOAuth2Server

Initialize a new builder.

builder(RestClient) - Static method in class discord4j.oauth2.DiscordOAuth2Server

Builder(RestClient) - Constructor for class discord4j.oauth2.DiscordOAuth2Server.Builder

C

clientId(long) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Set the client ID of the Discord application associated with the resulting server.

clientSecret(String) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Set the client secret of the Discord application associated with the resulting server.

CONNECTIONS - Enum constant in enum class discord4j.oauth2.Scope

Allows retrieving user's linked third-party accounts.

createFromCode(RestClient, AuthorizationCodeGrantRequest) - Static method in class discord4j.oauth2.DiscordOAuth2Client

Create an OAuth2 client by completing an authorization code grant flow.

createFromCredentials(RestClient, ClientCredentialsGrantRequest) - Static method in class discord4j.oauth2.DiscordOAuth2Client

Create an OAuth2 client by performing a client credentials flow.

createFromToken(RestClient, long, String, AccessTokenData) - Static method in class discord4j.oauth2.DiscordOAuth2Client

Create an OAuth2 client with the raw AccessTokenData returned from OAuth2Service.exchangeAuthorizationCode(AuthorizationCodeGrantRequest).

D

discord4j.oauth2 - package discord4j.oauth2

discord4j.oauth2.object - package discord4j.oauth2.object

discord4j.oauth2.service - package discord4j.oauth2.service

DiscordOAuth2Client - Class in discord4j.oauth2

A client registration capable of making requests to the Discord API on behalf of a single user using their OAuth2 access token.

DiscordOAuth2ResponseHandler - Interface in discord4j.oauth2

An I/O handler to customize the response given by a DiscordOAuth2Server after a login process is completed.

DiscordOAuth2Server - Class in discord4j.oauth2

A simple server capable of exchanging an OAuth2 authorization code received by the frontend via a query parameter for an AccessToken encoded as JSON.

DiscordOAuth2Server.Builder - Class in discord4j.oauth2

Builder suited for creating an OAuth2Server.

DiscordOAuth2Server.OAuth2ServerHandler - Class in discord4j.oauth2

DiscordOAuth2SuccessHandler - Interface in discord4j.oauth2

An interface to work with authorized users within a DiscordOAuth2Server.

DM_CHANNELS_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows your app to see information about the user's DMs and group DMs.

E

EMAIL - Enum constant in enum class discord4j.oauth2.Scope

Allows retrieving user's email and email verification status.

exchange(DiscordWebRequest, Class<T>) - Method in class discord4j.oauth2.DiscordOAuth2Client

Execute a given DiscordWebRequest on behalf of a user and mapping the response to the given type, using the credentials stored under this client.

exchangeAuthorizationCode(AuthorizationCodeGrantRequest) - Method in class discord4j.oauth2.service.OAuth2Service

exchangeClientCredentials(ClientCredentialsGrantRequest) - Method in class discord4j.oauth2.service.OAuth2Service

G

GDM_JOIN - Enum constant in enum class discord4j.oauth2.Scope

Allows joining user to a group DM.

getAccessToken() - Method in class discord4j.oauth2.DiscordOAuth2Client

Return the current access token for this client.

getAccessToken() - Method in class discord4j.oauth2.object.AccessToken

Return the OAuth2 access token.

getApplicationCommandPermissions(long, long, long) - Method in class discord4j.oauth2.DiscordOAuth2Client

Fetches permissions for a specific command for your application in a guild.

getAuthorizationInfo() - Method in class discord4j.oauth2.DiscordOAuth2Client

Returns info about the current authorization.

getCurrentUser() - Method in class discord4j.oauth2.DiscordOAuth2Client

Returns the user object of the requesting account.

getCurrentUserGuildMember(long) - Method in class discord4j.oauth2.DiscordOAuth2Client

Returns a member object from the current user in the given guild.

getCurrentUserGuilds(Map<String, Object>) - Method in class discord4j.oauth2.DiscordOAuth2Client

Returns a list of partial guild objects the requesting account is a member of.

getData() - Method in class discord4j.oauth2.object.AccessToken

Return the raw data object for this token

getGuild() - Method in class discord4j.oauth2.object.AccessToken

Return information about the guild to which your bot was added, available when authorizing a user with a BOT scope.

getHttpServer() - Method in class discord4j.oauth2.DiscordOAuth2Server

Gets the configured HttpServer.

getObjectMapper() - Method in class discord4j.oauth2.DiscordOAuth2Client

Return the Jackson ObjectMapper tied to this instance for JSON handling purposes.

getRefreshToken() - Method in class discord4j.oauth2.object.AccessToken

Return the OAuth2 refresh token, if available.

getScopes() - Method in class discord4j.oauth2.object.AccessToken

Return the OAuth2 scopes in this access token.

getUserConnections() - Method in class discord4j.oauth2.DiscordOAuth2Client

Return a list of ConnectionData objects.

getValue() - Method in enum class discord4j.oauth2.Scope

getWebhook() - Method in class discord4j.oauth2.object.AccessToken

Return webhook information if this client was authorized using a WEBHOOK_INCOMING scope.

GUILDS - Enum constant in enum class discord4j.oauth2.Scope

Allows retrieving partial data from list of user's guilds.

GUILDS_JOIN - Enum constant in enum class discord4j.oauth2.Scope

Allows joining user to a guild.

GUILDS_MEMBERS_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows returning user's member information in a guild.

H

handle(DiscordOAuth2Client, HttpServerRequest, HttpServerResponse) - Method in interface discord4j.oauth2.DiscordOAuth2ResponseHandler

Handle an incoming request to provide a response after an OAuth2 login is completed.

hasExpired() - Method in class discord4j.oauth2.object.AccessToken

Return whether this token has expired according to the token expires_in field and this object creation date.

httpServer(HttpServer) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Set the HttpServer this OAuth2 server should use to handle HTTP requests.

I

IDENTIFY - Enum constant in enum class discord4j.oauth2.Scope

Allows retrieving user's data excluding email and verified.

L

loginPath(String) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Override the route path this server uses to register the authorization handler.

M

MESSAGES_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows reading all messages from user's local Discord client via RPC.

modifyApplicationCommandPermissions(long, long, long, ApplicationCommandPermissionsRequest) - Method in class discord4j.oauth2.DiscordOAuth2Client

Edits command permissions for a specific command for your application in a guild and returns a guild application command permissions object.

O

OAuth2ServerHandler() - Constructor for class discord4j.oauth2.DiscordOAuth2Server.OAuth2ServerHandler

OAuth2Service - Class in discord4j.oauth2.service

OAuth2Service(Router) - Constructor for class discord4j.oauth2.service.OAuth2Service

objectMapper(ObjectMapper) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Set the ObjectMapper this server should use to encode JSON responses.

of(String) - Static method in enum class discord4j.oauth2.Scope

Constructs a Scope from the given value.

onAuthSuccess(DiscordOAuth2Client, String) - Method in interface discord4j.oauth2.DiscordOAuth2SuccessHandler

Invoked once a user completes an authorization code grant request for your OAuth2 application.

onAuthSuccess(DiscordOAuth2SuccessHandler) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Add a handler to be called once authorization succeeds allowing a DiscordOAuth2Client to be saved.

R

refreshToken(TokenRefreshRequest) - Method in class discord4j.oauth2.service.OAuth2Service

RELATIONSHIPS_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows retrieving user's friends and implicit relationships.

requiresDiscordApproval() - Method in enum class discord4j.oauth2.Scope

Gets whether this Scope requires approval from Discord to use.

responseHandler(DiscordOAuth2ResponseHandler) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Add a handler called once an OAuth2 login completes, allowing to transform the response sent by the server.

revokeToken(TokenRevokeRequest) - Method in class discord4j.oauth2.service.OAuth2Service

ROLE_CONNECTIONS_WRITE - Enum constant in enum class discord4j.oauth2.Scope

Allows your app to update a user's connection and metadata for the app.

route(Consumer<HttpServerRoutes>) - Method in class discord4j.oauth2.DiscordOAuth2Server.Builder

Set the route customization for the reactor-netty HTTP server.

RPC - Enum constant in enum class discord4j.oauth2.Scope

Allows control of user's local Discord client via RPC.

RPC_ACTIVITIES_WRITE - Enum constant in enum class discord4j.oauth2.Scope

for local rpc server access, this allows you to control a user's local Discord client.

RPC_NOTIFICATIONS_READ - Enum constant in enum class discord4j.oauth2.Scope

Allows receiving notifications from user's local Discord client via RPC.

RPC_VOICE_READ - Enum constant in enum class discord4j.oauth2.Scope

For local rpc server access, this allows you to read a user's voice settings and listen for voice events.

RPC_VOICE_WRITE - Enum constant in enum class discord4j.oauth2.Scope

For local rpc server access, this allows you to update a user's voice settings.

S

Scope - Enum Class in discord4j.oauth2

A permission granted to an AccessToken which grants access to an associated user-specific resource.

SESSION_KEY - Static variable in class discord4j.oauth2.DiscordOAuth2Server

V

valueOf(String) - Static method in enum class discord4j.oauth2.Scope

Returns the enum constant of this class with the specified name.

values() - Static method in enum class discord4j.oauth2.Scope

Returns an array containing the constants of this enum class, in the order they are declared.

VOICE - Enum constant in enum class discord4j.oauth2.Scope

Allows your app to connect to voice on user's behalf and see all the voice members.

W

WEBHOOK_INCOMING - Enum constant in enum class discord4j.oauth2.Scope

Generates a webhook which can be used to execute the webhook in user's selected channel.

withAuthorizedClient(DiscordWebRequest) - Method in class discord4j.oauth2.DiscordOAuth2Client

Prepare a given DiscordWebRequest on behalf of a user, using the credentials stored under this client.

A B C D E G H I L M O R S V W
All Classes and Interfaces|All Packages|Constant Field Values