ITextGuildChannel class abstract

Implemented types

Constructors

ITextGuildChannel()

Properties

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

Methods

bulkRemoveMessages(Iterable<IMessage> messages) Future<void>
Bulk removes many referenced messages. Where messages is list of messages to delete.
inherited
createAndGetThread(ThreadBuilder builder) Future<IThreadChannel>
Creates a thread in a message
createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason}) Future<IInvite>
Creates new IInvite for IChannel and returns it's instance.
inherited
createThread(ThreadBuilder builder) Future<IThreadPreviewChannel>
Creates a thread in a channel, that only retrieves a ThreadPreviewChannel
createWebhook(String name, {AttachmentBuilder? avatarAttachment, String? auditReason}) Future<IWebhook>
Creates a webhook for channel. Valid file types for avatarFile are jpeg, gif and png.
delete() Future<void>
Deletes channel if guild channel or closes DM if DM channel
inherited
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<IMessage>
Gets several IMessage objects from API.
inherited
edit<T extends GuildChannel>(ChannelBuilder builder, {String? auditReason}) Future<T>
Edits channel
inherited
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(IRole role) Future<IPermissions>
Returns effective permissions for role to this channel including channel overrides.
inherited
effectivePermissions(IMember member) Future<IPermissions>
Returns effective permissions for member to this channel including channel overrides.
inherited
fetchChannelInvites() Stream<IInviteWithMeta>
Fetches and returns all channel's Invites
inherited
fetchJoinedPrivateArchivedThreads({DateTime? before, int? limit}) Future<IThreadListResultWrapper>
Fetches joined private and archived thread channels
fetchMessage(Snowflake id) Future<IMessage>
Returns IMessage downloaded from API
inherited
fetchPinnedMessages() Stream<IMessage>
Returns pinned IMessages for channel.
inherited
fetchPrivateArchivedThreads({DateTime? before, int? limit}) Future<IThreadListResultWrapper>
Fetches private, archived thread channels
fetchPublicArchivedThreads({DateTime? before, int? limit}) Future<IThreadListResultWrapper>
Fetches public, archives thread channels
getMessage(Snowflake id) IMessage?
Returns Message with given id from CACHE
inherited
getWebhooks() Stream<IWebhook>
Gets all of the webhooks for this channel.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendMessage(MessageBuilder builder) Future<IMessage>
Sends message to channel. Allows to send embeds with MessageBuilder.embed() method.
inherited
startTyping() Future<void>
Starts typing.
inherited
startTypingLoop() → void
Loops startTyping until stopTypingLoop is called.
inherited
stopTypingLoop() → void
Stops a typing loop if one is running.
inherited
toString() String
A string representation of this object.
inherited

Operators

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