Package org.javacord.api.entity.channel

Class ChannelCategoryBuilder

java.lang.Object

org.javacord.api.entity.channel.ServerChannelBuilder

org.javacord.api.entity.channel.ChannelCategoryBuilder

public class ChannelCategoryBuilder
extends ServerChannelBuilder

This class is used to create new channel categories.

Constructor Summary

Constructors

Constructor	Description
ChannelCategoryBuilder(Server server)	Creates a new channel category builder.

Method Summary

Modifier and Type	Method	Description
<T extends Permissionable & DiscordEntity> ChannelCategoryBuilder	addPermissionOverwrite(T permissionable, Permissions permissions)	Adds a permission overwrite for the given entity.
CompletableFuture<ChannelCategory>	create()	Creates the channel category.
<T extends Permissionable & DiscordEntity> ChannelCategoryBuilder	removePermissionOverwrite(T permissionable)	Removes a permission overwrite for the given entity.
ChannelCategoryBuilder	setAuditLogReason(String reason)	Sets the reason for this creation.
ChannelCategoryBuilder	setName(String name)	Sets the name of the channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelCategoryBuilder

public ChannelCategoryBuilder(Server server)

Creates a new channel category builder.

Parameters:

server - The server of the channel category.

Method Detail

setAuditLogReason

public ChannelCategoryBuilder setAuditLogReason(String reason)

Description copied from class: ServerChannelBuilder

Sets the reason for this creation. This reason will be visible in the audit log entry(s).

Overrides:

setAuditLogReason in class ServerChannelBuilder

Parameters:

reason - The reason for this update.

Returns:

The current instance in order to chain call methods.

setName

public ChannelCategoryBuilder setName(String name)

Description copied from class: ServerChannelBuilder

Sets the name of the channel.

Overrides:

setName in class ServerChannelBuilder

Parameters:

name - The name of the channel.

Returns:

The current instance in order to chain call methods.

addPermissionOverwrite

public <T extends Permissionable & DiscordEntity> ChannelCategoryBuilder addPermissionOverwrite(T permissionable,
                                                                                                Permissions permissions)

Description copied from class: ServerChannelBuilder

Adds a permission overwrite for the given entity.

Overrides:

addPermissionOverwrite in class ServerChannelBuilder

Type Parameters:

T - The type of entity to hold the permission, usually User or Role

Parameters:

permissionable - The entity whose permissions should be overwritten.

permissions - The permission overwrites.

Returns:

The current instance in order to chain call methods.

removePermissionOverwrite

public <T extends Permissionable & DiscordEntity> ChannelCategoryBuilder removePermissionOverwrite(T permissionable)

Description copied from class: ServerChannelBuilder

Removes a permission overwrite for the given entity.

Overrides:

removePermissionOverwrite in class ServerChannelBuilder

Type Parameters:

T - The type of entity to hold the permission, usually User or Role

Parameters:

permissionable - The entity which permission overwrite should be removed.

Returns:

The current instance in order to chain call methods.

create

public CompletableFuture<ChannelCategory> create()

Creates the channel category.

Returns:

The created channel category.