net.dv8tion.jda.api.entities.PermissionOverride Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.entities;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.entities.channel.unions.IPermissionContainerUnion;
import net.dv8tion.jda.api.requests.restaction.AuditableRestAction;
import net.dv8tion.jda.api.requests.restaction.PermissionOverrideAction;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.EnumSet;
/**
* Represents the specific {@link net.dv8tion.jda.api.entities.Member Member} or {@link net.dv8tion.jda.api.entities.Role Role}
* permission overrides that can be set for channels.
*
* @see net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer#upsertPermissionOverride(IPermissionHolder)
*
* @see net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer#getPermissionOverrides()
* @see net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer#getPermissionOverride(IPermissionHolder)
* @see net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer#getMemberPermissionOverrides()
* @see net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer#getRolePermissionOverrides()
*/
public interface PermissionOverride extends ISnowflake
{
/**
* This is the raw binary representation (as a base 10 long) of the permissions allowed by this override.
*
The long relates to the offsets used by each {@link net.dv8tion.jda.api.Permission Permission}.
*
* @return Never-negative long containing the binary representation of the allowed permissions of this override.
*/
long getAllowedRaw();
/**
* This is the raw binary representation (as a base 10 long) of the permissions not affected by this override.
*
The long relates to the offsets used by each {@link net.dv8tion.jda.api.Permission Permission}.
*
* @return Never-negative long containing the binary representation of the unaffected permissions of this override.
*/
long getInheritRaw();
/**
* This is the raw binary representation (as a base 10 long) of the permissions denied by this override.
*
The long relates to the offsets used by each {@link net.dv8tion.jda.api.Permission Permission}.
*
* @return Never-negative long containing the binary representation of the denied permissions of this override.
*/
long getDeniedRaw();
/**
* EnumSet of all {@link net.dv8tion.jda.api.Permission Permissions} that are specifically allowed by this override.
*
Changes to the returned set do not affect this entity directly.
*
* @return Possibly-empty set of allowed {@link net.dv8tion.jda.api.Permission Permissions}.
*/
@Nonnull
EnumSet getAllowed();
/**
* EnumSet of all {@link net.dv8tion.jda.api.Permission Permission} that are unaffected by this override.
*
Changes to the returned set do not affect this entity directly.
*
* @return Possibly-empty set of unaffected {@link net.dv8tion.jda.api.Permission Permissions}.
*/
@Nonnull
EnumSet getInherit();
/**
* EnumSet of all {@link net.dv8tion.jda.api.Permission Permissions} that are denied by this override.
*
Changes to the returned set do not affect this entity directly.
*
* @return Possibly-empty set of denied {@link net.dv8tion.jda.api.Permission Permissions}.
*/
@Nonnull
EnumSet getDenied();
/**
* The {@link net.dv8tion.jda.api.JDA JDA} instance that this PermissionOverride is related to.
*
* @return Never-null {@link net.dv8tion.jda.api.JDA JDA} instance.
*/
@Nonnull
JDA getJDA();
/**
* This method will return the {@link net.dv8tion.jda.api.entities.IPermissionHolder PermissionHolder} of this PermissionOverride.
* It can be used to get the general permissions of that PermissionHolder, no matter if it is a {@link net.dv8tion.jda.api.entities.Member Member} or a {@link net.dv8tion.jda.api.entities.Role Role}.
*
Similar to {@link #getMember()} this will return {@code null} if the member is not cached.
*
* To get the concrete Member or Role, use {@link PermissionOverride#getMember()} or {@link PermissionOverride#getRole()}!
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.IPermissionHolder IPermissionHolder} of this PermissionOverride.
*
* @see PermissionOverride#getRole()
* @see PermissionOverride#getMember()
*/
@Nullable
IPermissionHolder getPermissionHolder();
/**
* If this PermissionOverride is an override dealing with a {@link net.dv8tion.jda.api.entities.Member Member}, then
* this method will return the related {@link net.dv8tion.jda.api.entities.Member Member} if the member is currently cached.
*
Otherwise, this method returns {@code null}.
*
Basically: if {@link PermissionOverride#isMemberOverride()} returns {@code false} or the member is not cached, this returns {@code null}.
*
* @return Possibly-null related {@link net.dv8tion.jda.api.entities.Member Member}.
*/
@Nullable
Member getMember();
/**
* If this PermissionOverride is an override dealing with a {@link net.dv8tion.jda.api.entities.Role Role}, then
* this method will return the related {@link net.dv8tion.jda.api.entities.Role Role}.
*
Otherwise, this method returns {@code null}.
*
Basically: if {@link PermissionOverride#isRoleOverride()}
* returns {@code false}, this returns {@code null}.
*
* @return Possibly-null related {@link net.dv8tion.jda.api.entities.Role}.
*/
@Nullable
Role getRole();
/**
* The {@link net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer GuildChannel} that this PermissionOverride affects.
*
* @return Never-null related {@link net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer GuildChannel} that this override is part of.
*/
@Nonnull
IPermissionContainerUnion getChannel();
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} that the {@link GuildChannel GuildChannel}
* returned from {@link net.dv8tion.jda.api.entities.PermissionOverride#getChannel()} is a part of.
* By inference, this is the {@link net.dv8tion.jda.api.entities.Guild Guild} that this PermissionOverride is part of.
*
* @return Never-null related {@link net.dv8tion.jda.api.entities.Guild Guild}.
*/
@Nonnull
Guild getGuild();
/**
* Used to determine if this PermissionOverride relates to
* a specific {@link net.dv8tion.jda.api.entities.Member Member}.
*
* @return True if this override is a user override.
*/
boolean isMemberOverride();
/**
* Used to determine if this PermissionOverride relates to
* a specific {@link net.dv8tion.jda.api.entities.Role Role}.
*
* @return True if this override is a role override.
*/
boolean isRoleOverride();
/**
* Returns the {@link net.dv8tion.jda.api.requests.restaction.PermissionOverrideAction PermissionOverrideAction} to modify this PermissionOverride.
*
In the PermissionOverrideAction you can modify the permissions of the override.
* You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.api.requests.RestAction#queue() RestAction.queue()}.
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_PERMISSIONS Permission.MANAGE_PERMISSIONS}
*
* @return The PermissionOverrideAction of this override.
*/
@Nonnull
PermissionOverrideAction getManager();
/**
* Deletes this PermissionOverride.
*
*
Possible ErrorResponses include:
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_OVERRIDE}
*
If the the override was already deleted.
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
*
If the channel this override was a part of was already deleted
*
* - {@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
*
If we were removed from the Guild
*
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* if we don't have the permission to {@link net.dv8tion.jda.api.Permission#MANAGE_CHANNEL MANAGE_CHANNEL}
*
* @return {@link net.dv8tion.jda.api.requests.restaction.AuditableRestAction AuditableRestAction}
*/
@Nonnull
@CheckReturnValue
AuditableRestAction delete();
}