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

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