Package net.dv8tion.jda.api.entities

Class RoleConnectionMetadata

java.lang.Object

net.dv8tion.jda.api.entities.RoleConnectionMetadata

All Implemented Interfaces:

SerializableData

public class RoleConnectionMetadata
extends Object
implements SerializableData

A metadata record used for role connections.

See Also:

• Configuring App Metadata for Linked Roles
• Role.RoleTags.isLinkedRole()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RoleConnectionMetadata.MetadataType	The type of metadata.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_DESCRIPTION_LENGTH	The maximum length a description can be (200)
static final int	MAX_KEY_LENGTH	The maximum length a key can be (50)
static final int	MAX_NAME_LENGTH	The maximum length a name can be (100)
static final int	MAX_RECORDS	The maximum number of records that can be configured (5)

Constructor Summary

Constructors

Constructor	Description
RoleConnectionMetadata(RoleConnectionMetadata.MetadataType type, String name, String key, String description)	Creates a new RoleConnectionMetadata instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static RoleConnectionMetadata	fromData(DataObject data)	Parses a RoleConnectionMetadata from a DataObject.
String	getDescription()	The description of the metadata.
LocalizationMap	getDescriptionLocalizations()	The localizations of this record's description for various languages.
String	getKey()	The key of the metadata.
String	getName()	The display name of the metadata.
LocalizationMap	getNameLocalizations()	The localizations of this record's name for various languages.
RoleConnectionMetadata.MetadataType	getType()	The type of the metadata.
int	hashCode()
RoleConnectionMetadata	setDescriptionLocalization(DiscordLocale locale, String description)	Sets a language-specific localization of this record's description.
RoleConnectionMetadata	setDescriptionLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this record's description.
RoleConnectionMetadata	setNameLocalization(DiscordLocale locale, String name)	Sets a language-specific localization of this record's name.
RoleConnectionMetadata	setNameLocalizations(Map<DiscordLocale,String> map)	Sets multiple language-specific localizations of this record's name.
DataObject	toData()	Serialized DataObject for this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

The maximum length a name can be (100)

See Also:

• Constant Field Values

MAX_DESCRIPTION_LENGTH

public static final int MAX_DESCRIPTION_LENGTH

The maximum length a description can be (200)

See Also:

• Constant Field Values

MAX_KEY_LENGTH

public static final int MAX_KEY_LENGTH

The maximum length a key can be (50)

See Also:

• Constant Field Values

MAX_RECORDS

public static final int MAX_RECORDS

The maximum number of records that can be configured (5)

See Also:

• Constant Field Values

Constructor Details

RoleConnectionMetadata

public RoleConnectionMetadata(@Nonnull
 RoleConnectionMetadata.MetadataType type,
 @Nonnull
 String name,
 @Nonnull
 String key,
 @Nonnull
 String description)

Creates a new RoleConnectionMetadata instance.

Parameters:

type - The RoleConnectionMetadata.MetadataType

name - The display name of the metadata

key - The key of the metadata (to update the value later)

description - The description of the metadata

Throws:

IllegalArgumentException -

• If null is provided
• If the provided name is empty or more than 100 characters long
• If the provided key is empty or more than 50 characters long
• If the provided description is empty or more than 200 characters long
• If the provided type is RoleConnectionMetadata.MetadataType.UNKNOWN
• If the provided key contains any characters other than a-z, 0-9, or _

Method Details

getType

@Nonnull
public RoleConnectionMetadata.MetadataType getType()

The type of the metadata.

Returns:

The type, or RoleConnectionMetadata.MetadataType.UNKNOWN if unknown

getName

@Nonnull
public String getName()

The display name of the metadata.

Returns:

The display name

getKey

@Nonnull
public String getKey()

The key of the metadata.

Returns:

The key

getDescription

@Nonnull
public String getDescription()

The description of the metadata.

Returns:

The description

getNameLocalizations

@Nonnull
public LocalizationMap getNameLocalizations()

The localizations of this record's name for various languages.

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized name

getDescriptionLocalizations

@Nonnull
public LocalizationMap getDescriptionLocalizations()

The localizations of this record's description for various languages.

Returns:

The LocalizationMap containing the mapping from DiscordLocale to the localized description

setNameLocalization

@Nonnull
public RoleConnectionMetadata setNameLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String name)

Sets a language-specific localization of this record's name.

This change will not take effect in Discord until you update the role connection metadata using JDA.updateRoleConnectionMetadata(Collection).

Parameters:

locale - The locale to associate the translated name with

name - The translated name to put

Returns:

This updated record instance

Throws:

IllegalArgumentException -

• If the locale is null
• If the name is null
• If the locale is DiscordLocale.UNKNOWN
• If the provided name is empty or more than 100 characters long

setNameLocalizations

@Nonnull
public RoleConnectionMetadata setNameLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Sets multiple language-specific localizations of this record's name.

This change will not take effect in Discord until you update the role connection metadata using JDA.updateRoleConnectionMetadata(Collection).

Parameters:

map - The map from which to transfer the translated names

Returns:

This updated record instance

Throws:

IllegalArgumentException -

• If the map is null
• If the map contains an DiscordLocale.UNKNOWN key
• If the map contains a name which is empty or more than 100 characters long

setDescriptionLocalization

@Nonnull
public RoleConnectionMetadata setDescriptionLocalization(@Nonnull
 DiscordLocale locale,
 @Nonnull
 String description)

Sets a language-specific localization of this record's description.

This change will not take effect in Discord until you update the role connection metadata using JDA.updateRoleConnectionMetadata(Collection).

Parameters:

locale - The locale to associate the translated description with

description - The translated description to put

Returns:

This updated record instance

Throws:

IllegalArgumentException -

• If the locale is null
• If the description is null
• If the locale is DiscordLocale.UNKNOWN
• If the provided description is empty or more than 200 characters long

setDescriptionLocalizations

@Nonnull
public RoleConnectionMetadata setDescriptionLocalizations(@Nonnull
 Map<DiscordLocale,String> map)

Sets multiple language-specific localizations of this record's description.

This change will not take effect in Discord until you update the role connection metadata using JDA.updateRoleConnectionMetadata(Collection).

Parameters:

map - The map from which to transfer the translated descriptions

Returns:

This updated record instance

Throws:

IllegalArgumentException -

• If the map is null
• If the map contains an DiscordLocale.UNKNOWN key
• If the map contains a description which is empty or more than 200 characters long

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject

fromData

@Nonnull
public static RoleConnectionMetadata fromData(@Nonnull
 DataObject data)

Parses a RoleConnectionMetadata from a DataObject.
This is the reverse of toData().

Parameters:

data - The data object to parse values from#

Returns:

The parsed metadata instance

Throws:

IllegalArgumentException - If the provided data object is null

ParsingException - If the provided data does not have a valid int type value