PermissionOverrideBuilder class

Builder for manipulating PermissionsOverrides. Created from existing override or manually by passing type and id of enttiy.

Inheritance

Constructors

PermissionOverrideBuilder(int type, Snowflake id)
Create empty permission builder.
PermissionOverrideBuilder.from(int type, Snowflake id, Permissions permissions)
Create builder manually from known data. Id is id of entity. type can be either 0 for role or 1 for member.
PermissionOverrideBuilder.of(SnowflakeEntity entity)
Create PermissionsOverrides for given entity. Entity have to be either Role or Member

Properties

addReactions bool?
Allows to add reactions.
read / writeinherited
administrator bool?
True if user is administrator.
read / writeinherited
attachFiles bool?
True if user can attach files in messages.
read / writeinherited
banMembers bool?
True if user can ban members.
read / writeinherited
changeNickname bool?
True if user can change nick.
read / writeinherited
connect bool?
True if user can connect to voice channel.
read / writeinherited
createInstantInvite bool?
True if user can create InstantInvite.
read / writeinherited
createPrivateThreads bool?
Allows for creating and participating in private threads.
read / writeinherited
createPublicThreads bool?
Allows for creating and participating in threads.
read / writeinherited
deafenMembers bool?
True if user can deafen members.
read / writeinherited
True if user can send links in messages.
read / writeinherited
hashCode int
The hash code for this object.
read-onlyinherited
id Snowflake
Id of entity of permission override.
final
kickMembers bool?
True if user can kick members.
read / writeinherited
manageChannels bool?
True if user can manager channels.
read / writeinherited
manageEmojisAndStickers bool?
Allows management and editing of emojis & stickers.
read / writeinherited
manageEvents bool?
Allows for creating, editing, and deleting scheduled events.
read / writeinherited
manageGuild bool?
True if user can manager guilds.
read / writeinherited
manageMessages bool?
True if user can manage messages.
read / writeinherited
manageNicknames bool?
True if user can manager others nicknames.
read / writeinherited
manageRoles bool?
True if user can manage server's roles.
read / writeinherited
manageThreads bool?
Allows for deleting and archiving threads, and viewing all private threads.
read / writeinherited
manageWebhooks bool?
True if user can manage webhooks.
read / writeinherited
mentionEveryone bool?
True if user can mention everyone.
read / writeinherited
moderateMembers bool?
Allows for timing out users to prevent them from sending or reacting to messages in chat and threads, and from speaking in voice and stage channels.
read / writeinherited
moveMembers bool?
True if user can move members.
read / writeinherited
muteMembers bool?
True if user can mute members.
read / writeinherited
prioritySpeaker bool?
Allows for using priority speaker in a voice channel.
read / writeinherited
raw int?
The raw permission code.
read / writeinherited
readMessageHistory bool?
True if user can read messages history.
read / writeinherited
requestToSpeak bool?
Allows for requesting to speak in stage channels. (This permission is under active development and may be changed or removed.).
read / writeinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
sendMessages bool?
True if user can send messages.
read / writeinherited
sendMessagesInThreads bool?
True if user can send messages in threads.
read / writeinherited
sendTtsMessages bool?
True if user can send TTF messages.
read / writeinherited
speak bool?
True if user can speak.
read / writeinherited
stream bool?
Allows the user to go live.
read / writeinherited
type int
Type of permission override either role or member
final
useExternalEmojis bool?
True if user can use external emojis.
read / writeinherited
useExternalStickers bool?
Allows the usage of custom stickers from other servers.
read / writeinherited
useSlashCommands bool?
Allows members to use application commands, including slash commands and context menu commands.
read / writeinherited
useVad bool?
Allows for using voice-activity-detection in a voice channel.
read / writeinherited
viewAuditLog bool?
Allow to view audit logs.
read / writeinherited
viewChannel bool?
Allow viewing channels (OLD READ_MESSAGES)
read / writeinherited
viewGuildInsights bool?
Allows for viewing guild insights.
read / writeinherited

Methods

build() RawApiMap
Returns built response for api
override
calculatePermissionValue() int
Calculates permission int.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited