discord4j.core.object

Class ExtendedPermissionOverwrite

java.lang.Object

discord4j.core.object.PermissionOverwrite

discord4j.core.object.ExtendedPermissionOverwrite

All Implemented Interfaces:

DiscordObject

public final class ExtendedPermissionOverwrite
extends PermissionOverwrite
implements DiscordObject

A Discord permission overwrite.

See Also:

Overwrite Object

Nested Class Summary

Nested classes/interfaces inherited from class discord4j.core.object.PermissionOverwrite

PermissionOverwrite.Type

Constructor Summary

Constructors

Constructor and Description
ExtendedPermissionOverwrite(ServiceMediator serviceMediator, PermissionOverwriteBean data, long guildId, long channelId) Constructs a ExtendedPermissionOverwrite with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
Mono<Void>	delete() Requests to delete this permission overwrite.
Mono<Void>	delete(String reason) Requests to delete this permission overwrite while optionally specifying a reason.
Mono<GuildChannel>	getChannel() Requests to retrieve the channel associated to this overwrite.
Snowflake	getChannelId() Gets the ID of the channel associated to this overwrite.
DiscordClient	getClient() Gets the DiscordClient associated to this object.
Mono<Guild>	getGuild() Requests to retrieve the guild associated to this overwrite.
Snowflake	getGuildId() Gets the ID of the guild associated to this overwrite.
Mono<Role>	getRole() Requests to retrieve the role this overwrite is associated to, if present.
Mono<User>	getUser() Requests to retrieve the user this overwrite is associated to, if present.

Methods inherited from class discord4j.core.object.PermissionOverwrite

forMember, forRole, getAllowed, getDenied, getMemberId, getRoleId, getTargetId, getType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedPermissionOverwrite

public ExtendedPermissionOverwrite(ServiceMediator serviceMediator,
                                   PermissionOverwriteBean data,
                                   long guildId,
                                   long channelId)

Constructs a ExtendedPermissionOverwrite with an associated ServiceMediator and Discord data.

Parameters:

serviceMediator - The ServiceMediator associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

guildId - The ID of the guild associated to this overwrite.

channelId - The ID of the channel associated to this overwrite.

Method Detail

getClient

public DiscordClient getClient()

Description copied from interface: DiscordObject

Gets the DiscordClient associated to this object.

Specified by:

getClient in interface DiscordObject

Returns:

The DiscordClient associated to this object.

getRole

public Mono<Role> getRole()

Requests to retrieve the role this overwrite is associated to, if present.

Returns:

A Mono where, upon successful completion, emits the Role this overwrite is associated to, if present. If an error is received, it is emitted through the Mono.

getUser

public Mono<User> getUser()

Requests to retrieve the user this overwrite is associated to, if present.

Returns:

A Mono where, upon successful completion, emits the User this overwrite is associated to, if present. If an error is received, it is emitted through the Mono.

getGuildId

public Snowflake getGuildId()

Gets the ID of the guild associated to this overwrite.

Returns:

The ID of the guild associated to this overwrite.

getGuild

public Mono<Guild> getGuild()

Requests to retrieve the guild associated to this overwrite.

Returns:

A Mono where, upon successful completion, emits the Guild associated to this overwrite. If an error is received, it is emitted through the Mono.

getChannelId

public Snowflake getChannelId()

Gets the ID of the channel associated to this overwrite.

Returns:

The ID of the channel associated to this overwrite.

getChannel

public Mono<GuildChannel> getChannel()

Requests to retrieve the channel associated to this overwrite.

Returns:

A Mono where, upon successful completion, emits the GuildChannel associated to this overwrite. If an error is received, it is emitted through the Mono.

delete

public Mono<Void> delete()

Requests to delete this permission overwrite.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the permission overwrite has been deleted. If an error is received, it is emitted through the Mono.

delete

public Mono<Void> delete(@Nullable
                         String reason)

Requests to delete this permission overwrite while optionally specifying a reason.

Parameters:

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the permission overwrite has been deleted. If an error is received, it is emitted through the Mono.