PermissionsBuilder class

Builder for permissions.

Inheritance

• Object
• Builder
• PermissionsBuilder

Implementers

• PermissionOverrideBuilder

Constructors

PermissionsBuilder({bool? addReactions, bool? administrator, bool? attachFiles, bool? banMembers, bool? changeNickname, bool? connect, bool? createInstantInvite, bool? createPrivateThreads, bool? createPublicThreads, bool? deafenMembers, bool? embedLinks, bool? kickMembers, bool? manageChannels, bool? manageEmojisAndStickers, bool? manageEvents, bool? manageGuild, bool? manageMessages, bool? manageNicknames, bool? manageRoles, bool? manageThreads, bool? manageWebhooks, bool? mentionEveryone, bool? moderateMembers, bool? moveMembers, bool? muteMembers, bool? prioritySpeaker, bool? readMessageHistory, bool? sendMessages, bool? requestToSpeak, bool? sendMessagesInThreads, bool? sendTtsMessages, bool? speak, bool? stream, bool? useExternalEmojis, bool? useExternalStickers, bool? useSlashCommands, bool? useVad, bool? viewAuditLog, bool? viewChannel, bool? viewGuildInsights})

PermissionsBuilder.from(Permissions permissions)

Permission builder from existing Permissions object.

Properties

addReactions ↔ bool?

Allows to add reactions.

getter/setter pair

administrator ↔ bool?

True if user is administrator.

getter/setter pair

attachFiles ↔ bool?

True if user can attach files in messages.

getter/setter pair

banMembers ↔ bool?

True if user can ban members.

getter/setter pair

changeNickname ↔ bool?

True if user can change nick.

getter/setter pair

connect ↔ bool?

True if user can connect to voice channel.

getter/setter pair

createInstantInvite ↔ bool?

True if user can create InstantInvite.

getter/setter pair

createPrivateThreads ↔ bool?

Allows for creating and participating in private threads.

getter/setter pair

createPublicThreads ↔ bool?

Allows for creating and participating in threads.

getter/setter pair

deafenMembers ↔ bool?

True if user can deafen members.

getter/setter pair

embedLinks ↔ bool?

True if user can send links in messages.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

kickMembers ↔ bool?

True if user can kick members.

getter/setter pair

manageChannels ↔ bool?

True if user can manager channels.

getter/setter pair

manageEmojisAndStickers ↔ bool?

Allows management and editing of emojis & stickers.

getter/setter pair

manageEvents ↔ bool?

Allows for creating, editing, and deleting scheduled events.

getter/setter pair

manageGuild ↔ bool?

True if user can manager guilds.

getter/setter pair

manageMessages ↔ bool?

True if user can manage messages.

getter/setter pair

manageNicknames ↔ bool?

True if user can manager others nicknames.

getter/setter pair

manageRoles ↔ bool?

True if user can manage server's roles.

getter/setter pair

manageThreads ↔ bool?

Allows for deleting and archiving threads, and viewing all private threads.

getter/setter pair

manageWebhooks ↔ bool?

True if user can manage webhooks.

getter/setter pair

mentionEveryone ↔ bool?

True if user can mention everyone.

getter/setter pair

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 pair

moveMembers ↔ bool?

True if user can move members.

getter/setter pair

muteMembers ↔ bool?

True if user can mute members.

getter/setter pair

prioritySpeaker ↔ bool?

Allows for using priority speaker in a voice channel.

getter/setter pair

raw ↔ int?

The raw permission code.

getter/setter pair

readMessageHistory ↔ bool?

True if user can read messages history.

getter/setter pair

requestToSpeak ↔ bool?

Allows for requesting to speak in stage channels. (This permission is under active development and may be changed or removed.).

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sendMessages ↔ bool?

True if user can send messages.

getter/setter pair

sendMessagesInThreads ↔ bool?

True if user can send messages in threads.

getter/setter pair

sendTtsMessages ↔ bool?

True if user can send TTF messages.

getter/setter pair

speak ↔ bool?

True if user can speak.

getter/setter pair

stream ↔ bool?

Allows the user to go live.

getter/setter pair

useExternalEmojis ↔ bool?

True if user can use external emojis.

getter/setter pair

useExternalStickers ↔ bool?

Allows the usage of custom stickers from other servers.

getter/setter pair

useSlashCommands ↔ bool?

Allows members to use application commands, including slash commands and context menu commands.

getter/setter pair

useVad ↔ bool?

Allows for using voice-activity-detection in a voice channel.

getter/setter pair

viewAuditLog ↔ bool?

Allow to view audit logs.

getter/setter pair

viewChannel ↔ bool?

Allow viewing channels (OLD READ_MESSAGES)

getter/setter pair

viewGuildInsights ↔ bool?

Allows for viewing guild insights.

getter/setter pair

Methods

build() → RawApiMap

Returns built response for api

override

calculatePermissionValue() → int

Calculates permission int.

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