TextGuildChannel class Null safety

Inheritance
Implemented types

Properties

channelType ChannelType
Type of this channel
read / write, final, late, inherited
client Nyxx
Reference to client
final, inherited
createdAt DateTime
Gets creation timestamp included in Snowflake
read-only, inherited
fileUploadLimit Future<int>
File upload limit for channel in bytes.
read-only, override
guild Cacheable<Snowflake, Guild>
Id of Guild that the channel is in.
read / write, final, late, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
id Snowflake
ID of entity as Snowflake
final, inherited
isNsfw bool
Indicates if channel is nsfw
read / write, final, late, inherited
mention String
The channel's mention string.
read-only
messageCache MessageCache
A collection of messages sent to this channel.
final, late
name String
The channel"s name.
read / write, final, late, inherited
parentChannel Cacheable<Snowflake, GuildChannel>?
Id of parent channel
read / write, final, late, inherited
permissionOverrides List<PermissionsOverrides>
Permission override for channel
read / write, final, late, inherited
position int
Relative position of channel in context of channel list
read / write, final, late, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
slowModeThreshold int
Channel's slow mode rate limit in seconds. This must be between 0 and 120.
read / write, final, late
topic String?
The channel's topic.
read / write, final, late
url String
Returns url to this channel.
read-only

Methods

bulkRemoveMessages(Iterable<SnowflakeEntity> messages) Future<void>
Bulk removes many messages by its ids. messages is list of messages ids to delete. [...]
override
createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason}) Future<Invite>
Creates new Invite for Channel and returns it"s instance [...]
inherited
createWebhook(String name, {File? avatarFile, String? auditReason}) Future<Webhook>
Creates a webhook for channel. Valid file types for avatarFile are jpeg, gif and png. [...]
deleteChannelPermission(SnowflakeEntity entity, {String? auditReason}) Future<void>
Deletes permission overwrite for given User or Role entity Throws if entity isn't User or Role
inherited
dispose() Future<void>
Perform cleanup
inherited
downloadMessages({int limit = 50, Snowflake? after, Snowflake? around, Snowflake? before}) Stream<Message>
Gets several Message objects from API. Only one of after, before, around can be specified, otherwise, it will throw. [...]
override
edit({String? name, String? topic, int? position, int? slowModeThreshold}) Future<TextGuildChannel>
Edits the channel.
editChannelPermissionOverrides(PermissionOverrideBuilder permissionBuilder, {String? auditReason}) Future<void>
Allows to edit or set channel permission overrides.
inherited
editChannelPermissions(PermissionsBuilder perms, SnowflakeEntity entity, {String? auditReason}) Future<void>
Allows to set or edit permissions for channel. id can be either User or Role Throws if id isn't User or Role
inherited
effectivePermissionForRole(Role role) Future<Permissions>
Returns effective permissions for role to this channel including channel overrides.
inherited
effectivePermissions(Member member) Future<Permissions>
Returns effective permissions for member to this channel including channel overrides.
inherited
fetchChannelInvites() Stream<InviteWithMeta>
Fetches and returns all channel"s Invites [...]
inherited
fetchMessage(Snowflake messageId) Future<Message>
Returns Message downloaded from API
override
getMessage(Snowflake id) Future<Message?>
Returns Message with given id from CACHE
override
getPinnedMessages() Stream<Message>
Returns pinned Messages for channel.
getWebhooks() Stream<Webhook>
Gets all of the webhooks for this channel.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
sendMessage({dynamic content, EmbedBuilder? embed, List<AttachmentBuilder>? files, bool? tts, AllowedMentions? allowedMentions, MessageBuilder? builder, ReplyBuilder? replyBuilder}) Future<Message>
Sends message to channel. Performs toString() on thing passed to content. Allows to send embeds with embed field. [...]
override
startTyping() Future<void>
Starts typing.
override
startTypingLoop() → void
Loops startTyping until stopTypingLoop is called.
override
stopTypingLoop() → void
Stops a typing loop if one is running.
override
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited