Package discord4j.core.util

Class MentionUtil

java.lang.Object

discord4j.core.util.MentionUtil

public final class MentionUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVERYONE	The raw mention for notifying all users in a channel.
static final String	HERE	The raw mention for notifying all online users in a channel.

Method Summary

Modifier and Type	Method	Description
static String	forChannel(Snowflake id)	Gets a raw mention for a Channel.
static String	forRole(Snowflake id)	Gets a raw mention for a Role.
static String	forUser(Snowflake id)	Gets a raw mention for a User.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EVERYONE

public static final String EVERYONE

The raw mention for notifying all users in a channel.

The use of this mention requires the Permission.MENTION_EVERYONE permission, as well as being permitted by the "allowed mentions" of any messages being sent.

See Also:

• Permission.MENTION_EVERYONE
• AllowedMentions
• Constant Field Values

HERE

public static final String HERE

The raw mention for notifying all online users in a channel.

The use of this mention requires the Permission.MENTION_EVERYONE permission, as well as being permitted by the "allowed mentions" of any messages being sent.

See Also:

• Permission.MENTION_EVERYONE
• AllowedMentions
• Constant Field Values

Method Details

forChannel

public static String forChannel(Snowflake id)

Gets a raw mention for a Channel.

This is the format utilized to directly mention another channel.

Parameters:

id - The id of the channel to mention.

Returns:

The raw mention.

forRole

public static String forRole(Snowflake id)

Gets a raw mention for a Role.

The use of this mention requires being permitted by the "allowed mentions" of any messages being sent.

This is the format utilized to directly mention another role (assuming the role exists in context of the mention).

Parameters:

id - The id of the role to mention.

Returns:

The raw mention.

forUser

public static String forUser(Snowflake id)

Gets a raw mention for a User.

The use of this mention requires being permitted by the "allowed mentions" of any messages being sent.

This is the format utilized to directly mention another user (assuming the user exists in context of the mention).

Parameters:

id - The id of the user to mention.

Returns:

The raw mention.