Interface ApplicationManager

All Superinterfaces:

AuditableRestAction<Void>, Manager<ApplicationManager>, RestAction<Void>

public interface ApplicationManager
extends Manager<ApplicationManager>

Manager providing functionality to update one or more fields for the application associated with the bot.

See Also:

• JDA.getApplicationManager()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ApplicationManager.IntegrationTypeConfig	A config describing how the application is installed.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	COVER_IMAGE	Used to set cover image field
static final long	CUSTOM_INSTALL_URL	Used to set custom install url field
static final long	DESCRIPTION	Used to set description field
static final long	ICON	Used to set icon field
static final long	INSTALL_PARAMS	Used to set install params field
static final long	INTEGRATION_TYPES_CONFIG	Used to set integration types config field
static final long	INTERACTIONS_ENDPOINT_URL	Used to set interaction endpoint url field
static final long	TAGS	Used to set tags field

Fields inherited from interface AuditableRestAction

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
ApplicationManager	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
ApplicationManager	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
ApplicationManager	setCoverImage(Icon coverImage)	Sets the cover image of the application.
ApplicationManager	setCustomInstallUrl(String customInstallUrl)	Sets the custom install url for this application.
ApplicationManager	setDescription(String description)	Sets the description of the application.
ApplicationManager	setIcon(Icon icon)	Sets the icon of the application.
ApplicationManager	setInstallParams(ApplicationManager.IntegrationTypeConfig installParams)	Sets the default installation parameters of this application.
ApplicationManager	setIntegrationTypeConfig(Map<IntegrationType, ApplicationManager.IntegrationTypeConfig> config)	Sets the integration type config of this application.
ApplicationManager	setInteractionsEndpointUrl(String interactionsEndpointUrl)	Sets the interactions endpoint URL for this application.
ApplicationManager	setTags(Collection<String> tags)	Sets up to 5 unique tags for this application.

Methods inherited from interface AuditableRestAction

reason

Methods inherited from interface Manager

deadline, reset, setCheck, timeout

Methods inherited from interface RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Field Details

DESCRIPTION

static final long DESCRIPTION

Used to set description field

See Also:

• Constant Field Values

ICON

static final long ICON

Used to set icon field

See Also:

• Constant Field Values

COVER_IMAGE

static final long COVER_IMAGE

Used to set cover image field

See Also:

• Constant Field Values

INTERACTIONS_ENDPOINT_URL

static final long INTERACTIONS_ENDPOINT_URL

Used to set interaction endpoint url field

See Also:

• Constant Field Values

TAGS

static final long TAGS

Used to set tags field

See Also:

• Constant Field Values

CUSTOM_INSTALL_URL

static final long CUSTOM_INSTALL_URL

Used to set custom install url field

See Also:

• Constant Field Values

INSTALL_PARAMS

static final long INSTALL_PARAMS

Used to set install params field

See Also:

• Constant Field Values

INTEGRATION_TYPES_CONFIG

static final long INTEGRATION_TYPES_CONFIG

Used to set integration types config field

See Also:

• Constant Field Values

Method Details

reset

@Nonnull
@CheckReturnValue
ApplicationManager reset(long fields)

Resets the fields specified by the provided bit-flag pattern. You can specify a combination by using a bitwise OR concat of the flag constants.
Example: manager.reset(ApplicationManager.ICON | ApplicationManager.COVER_IMAGE);

Flag Constants:

• DESCRIPTION
• ICON
• COVER_IMAGE
• INTERACTIONS_ENDPOINT_URL
• TAGS
• CUSTOM_INSTALL_URL
• INSTALL_PARAMS
• INTEGRATION_TYPES_CONFIG

Specified by:

reset in interface Manager<ApplicationManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

ApplicationManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
ApplicationManager reset(@Nonnull
 long... fields)

Resets the fields specified by the provided bit-flag patterns.
Example: manager.reset(ApplicationManager.ICON, ApplicationManager.COVER_IMAGE);

Flag Constants:

• DESCRIPTION
• ICON
• COVER_IMAGE
• INTERACTIONS_ENDPOINT_URL
• TAGS
• CUSTOM_INSTALL_URL
• INSTALL_PARAMS
• INTEGRATION_TYPES_CONFIG

Specified by:

reset in interface Manager<ApplicationManager>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

ApplicationManager for chaining convenience

setDescription

@Nonnull
@CheckReturnValue
ApplicationManager setDescription(@Nonnull
 String description)

Sets the description of the application.

Parameters:

description - The new description (max 400 characters)

Returns:

ApplicationManager for chaining convenience

Throws:

IllegalArgumentException - If null is provided or the description is longer than 400

setIcon

@Nonnull
@CheckReturnValue
ApplicationManager setIcon(@Nullable
 Icon icon)

Sets the icon of the application.

Parameters:

icon - The new icon

Returns:

ApplicationManager for chaining convenience

setCoverImage

@Nonnull
@CheckReturnValue
ApplicationManager setCoverImage(@Nullable
 Icon coverImage)

Sets the cover image of the application.
This is used for rich presence.

Parameters:

coverImage - The new coverImage

Returns:

ApplicationManager for chaining convenience

setTags

@Nonnull
@CheckReturnValue
ApplicationManager setTags(@Nonnull
 Collection<String> tags)

Sets up to 5 unique tags for this application.

Parameters:

tags - Up to 5 tags (each max 20 characters)

Returns:

ApplicationManager for chaining convenience

Throws:

IllegalArgumentException - If more than 5 tags are provided, or if any of the tags is null, blank, empty, or longer than 20 characters

setInteractionsEndpointUrl

@Nonnull
@CheckReturnValue
ApplicationManager setInteractionsEndpointUrl(@Nullable
 String interactionsEndpointUrl)

Sets the interactions endpoint URL for this application.

CAUTION:This will cause JDA to no longer receive interactions through gateway events.

Parameters:

interactionsEndpointUrl - The interactions endpoint URL (max 2048 characters)

Returns:

ApplicationManager for chaining convenience

Throws:

IllegalArgumentException - If the provided URL is longer than 2048 characters

setCustomInstallUrl

@Nonnull
@CheckReturnValue
ApplicationManager setCustomInstallUrl(@Nullable
 String customInstallUrl)

Sets the custom install url for this application.

Parameters:

customInstallUrl - The custom install URL (max 2048 characters)

Returns:

ApplicationManager for chaining convenience

Throws:

IllegalArgumentException - If the provided URL is longer than 2048 characters

setInstallParams

@Nonnull
@CheckReturnValue
ApplicationManager setInstallParams(@Nullable
 ApplicationManager.IntegrationTypeConfig installParams)

Sets the default installation parameters of this application.

This is used if the application does not use a custom install URL. Configures which scopes and permissions should be applied to invite URLs of this application.

Parameters:

installParams - The default install parameters

Returns:

ApplicationManager for chaining convenience

See Also:

• ApplicationManager.IntegrationTypeConfig.of(Collection, Collection)

setIntegrationTypeConfig

@Nonnull
@CheckReturnValue
ApplicationManager setIntegrationTypeConfig(@Nullable
 Map<IntegrationType, ApplicationManager.IntegrationTypeConfig> config)

Sets the integration type config of this application.

This method accepts a map of the supported integration type to an ApplicationManager.IntegrationTypeConfig describing the installation parameters.

Parameters:

config - The config used for installing this application as integration.

Returns:

ApplicationManager for chaining convenience

Throws:

IllegalArgumentException - If the config contains null

See Also:

• ApplicationManager.IntegrationTypeConfig.of(Collection, Collection)