discord4j.rest.util

Class AllowedMentions

java.lang.Object

discord4j.rest.util.AllowedMentions

public class AllowedMentions
extends Object

A class for holding the allowed_mentions object with an built-in factory for default values. Also this class wraps the AllowedMentionsData JSON to a Discord4J class.

See Also:

Reference

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AllowedMentions.Builder A builder for creating AllowedMentions objects.
static class	AllowedMentions.Type An allowed mentions type, grouped into role mentions, user mentions and everyone mentions (includes @everyone and @here).

Method Summary

Modifier and Type	Method and Description
static AllowedMentions.Builder	builder() Create a builder for this AllowedMentions class.
static AllowedMentions.Builder	builder(AllowedMentions template) Copy an existing AllowedMentions object to a new builder.
AllowedMentions.Builder	mutate() Copy this AllowedMentions object to a new builder.
static AllowedMentions	suppressAll() Create an AllowedMentions object that will suppress all mentions.
static AllowedMentions	suppressEveryone() Create an AllowedMentions object that will suppress @everyone and @here mentions.
discord4j.discordjson.json.AllowedMentionsData	toData() Map this AllowedMentions object to a AllowedMentionsData JSON

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AllowedMentions.Builder builder()

Create a builder for this AllowedMentions class. Building this object without any configuration is equivalent to suppressing all mentions.

Returns:

A builder class for allowed mentions

builder

public static AllowedMentions.Builder builder(AllowedMentions template)

Copy an existing AllowedMentions object to a new builder.

Parameters:

template - the allowed mentions object to copy

Returns:

A builder class for allowed mentions

suppressAll

public static AllowedMentions suppressAll()

Create an AllowedMentions object that will suppress all mentions.

Returns:

A suppressing allowed mentions

suppressEveryone

public static AllowedMentions suppressEveryone()

Create an AllowedMentions object that will suppress @everyone and @here mentions.

Returns:

A suppressing allowed mentions

mutate

public AllowedMentions.Builder mutate()

Copy this AllowedMentions object to a new builder.

Returns:

A builder class for allowed mentions

toData

public discord4j.discordjson.json.AllowedMentionsData toData()

Map this AllowedMentions object to a AllowedMentionsData JSON

Returns:

JSON object