Package net.dv8tion.jda.api.requests.restaction

Class GuildAction.ChannelData

java.lang.Object

net.dv8tion.jda.api.requests.restaction.GuildAction.ChannelData

All Implemented Interfaces:

SerializableData

Enclosing interface:

GuildAction

public static class GuildAction.ChannelData
extends Object
implements SerializableData

GuildChannel information used for the creation of Channels within the construction of a Guild via GuildAction.

Use with GuildAction.addChannel(ChannelData).

Constructor Summary

Constructors

Constructor	Description
ChannelData(ChannelType type, String name)	Constructs a data object containing information on a GuildChannel to be used in the construction of a Guild!

Method Summary

Modifier and Type	Method	Description
GuildAction.ChannelData	addPermissionOverride(GuildAction.RoleData role, long allow, long deny)	Adds a PermissionOverride to this channel with the provided RoleData! Use GuildAction.newRole() to retrieve an instance of RoleData.
GuildAction.ChannelData	addPermissionOverride(GuildAction.RoleData role, Collection<Permission> allow, Collection<Permission> deny)	Adds a PermissionOverride to this channel with the provided RoleData! Use GuildAction.newRole() to retrieve an instance of RoleData.
GuildAction.ChannelData	setBitrate(Integer bitrate)	Sets the bitrate for this channel.
GuildAction.ChannelData	setNSFW(Boolean nsfw)	Sets the whether this channel should be marked NSFW.
GuildAction.ChannelData	setPosition(Integer position)	Sets the position for this channel.
GuildAction.ChannelData	setTopic(String topic)	Sets the topic for this channel.
GuildAction.ChannelData	setUserlimit(Integer userlimit)	Sets the userlimit for this channel.
DataObject	toData()	Serialized DataObject for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelData

public ChannelData(ChannelType type,
                   String name)

Constructs a data object containing information on a GuildChannel to be used in the construction of a Guild!

Parameters:

type - The ChannelType of the resulting GuildChannel
This may be of type TEXT or VOICE!

name - The name of the channel. This must be alphanumeric with underscores for type TEXT

Throws:

IllegalArgumentException -

• If provided with an invalid ChannelType
• If the provided name is null or blank
• If the provided name is not between 2-100 characters long
• If the type is TEXT and the provided name is not alphanumeric with underscores

Method Detail

setTopic

@Nonnull
public GuildAction.ChannelData setTopic(@Nullable
                                        String topic)

Sets the topic for this channel.
These are only relevant to channels of type TEXT.

Parameters:

topic - The topic for the channel

Returns:

This ChannelData instance for chaining convenience

Throws:

IllegalArgumentException - If the provided topic is bigger than 1024 characters

setNSFW

@Nonnull
public GuildAction.ChannelData setNSFW(@Nullable
                                       Boolean nsfw)

Sets the whether this channel should be marked NSFW.
These are only relevant to channels of type TEXT.

Parameters:

nsfw - Whether this channel should be marked NSFW

Returns:

This ChannelData instance for chaining convenience

setBitrate

@Nonnull
public GuildAction.ChannelData setBitrate(@Nullable
                                          Integer bitrate)

Sets the bitrate for this channel.
These are only relevant to channels of type VOICE.

Parameters:

bitrate - The bitrate for the channel (8000-96000)

Returns:

This ChannelData instance for chaining convenience

Throws:

IllegalArgumentException - If the provided bitrate is not between 8000-96000

setUserlimit

@Nonnull
public GuildAction.ChannelData setUserlimit(@Nullable
                                            Integer userlimit)

Sets the userlimit for this channel.
These are only relevant to channels of type VOICE.

Parameters:

userlimit - The userlimit for the channel (0-99)

Returns:

This ChannelData instance for chaining convenience

Throws:

IllegalArgumentException - If the provided userlimit is not between 0-99

setPosition

@Nonnull
public GuildAction.ChannelData setPosition(@Nullable
                                           Integer position)

Sets the position for this channel.

Parameters:

position - The position for the channel

Returns:

This ChannelData instance for chaining convenience

addPermissionOverride

@Nonnull
public GuildAction.ChannelData addPermissionOverride(@Nonnull
                                                     GuildAction.RoleData role,
                                                     long allow,
                                                     long deny)

Adds a PermissionOverride to this channel with the provided RoleData!
Use GuildAction.newRole() to retrieve an instance of RoleData.

Parameters:

role - The target role

allow - The permissions to grant in the override

deny - The permissions to deny in the override

Returns:

This ChannelData instance for chaining convenience

Throws:

IllegalArgumentException -

• If the provided role is null
• If the provided allow value is negative or exceeds maximum permissions
• If the provided deny value is negative or exceeds maximum permissions

addPermissionOverride

@Nonnull
public GuildAction.ChannelData addPermissionOverride(@Nonnull
                                                     GuildAction.RoleData role,
                                                     @Nullable
                                                     Collection<Permission> allow,
                                                     @Nullable
                                                     Collection<Permission> deny)

Adds a PermissionOverride to this channel with the provided RoleData!
Use GuildAction.newRole() to retrieve an instance of RoleData.

Parameters:

role - The target role

allow - The permissions to grant in the override

deny - The permissions to deny in the override

Returns:

This ChannelData instance for chaining convenience

Throws:

IllegalArgumentException -

• If the provided role is null
• If any permission is null

toData

@Nonnull
public DataObject toData()

Description copied from interface: SerializableData

Serialized DataObject for this object.

Specified by:

toData in interface SerializableData

Returns:

DataObject