IThreadChannel class abstract

Implemented types

Constructors

IThreadChannel()

Properties

appliedTags List<Snowflake>
The IDs of the set of tags that have been applied to a thread in a GUILD_FORUM channel
read-only
archiveAfter ThreadArchiveTime
Time after what thread will be archived
read-only
archiveAt DateTime
Date when thread was archived
read-only
archived bool
True if thread is archived
read-only
channelType ChannelType
Type of this channel
latefinalinherited
client INyxx
Reference to client
finalinherited
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.
latefinalinherited
hashCode int
The hash code for this object.
read-onlyinherited
id Snowflake
ID of entity as Snowflake
finalinherited
invitable bool
Whether non-moderators can add other non-moderators to a thread; only available on private threads
read-only
isNsfw bool
Indicates if channel is nsfw
latefinalinherited
memberCount int
Approximate member count
read-only
messageCache Map<Snowflake, IMessage>
A collection of messages sent to this channel.
read-onlyinherited
messageCount int
Approximate message count
read-only
name String
The channel's name.
latefinalinherited
owner Cacheable<Snowflake, IMember>
Owner of the thread
read-only
parentChannel Cacheable<Snowflake, GuildChannel>?
Id of parent channel
latefinalinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
totalMessagesSent int
Number of messages ever sent in a thread. It's similar to message_count on message creation, but will not decrement the number when a message is deleted
read-only

Methods

addThreadMember(SnowflakeEntity user) Future<void>
Adds user to ThreadChannel
bulkRemoveMessages(Iterable<IMessage> messages) Future<void>
Bulk removes many referenced messages. Where messages is list of messages to delete.
inherited
delete() Future<void>
Deletes channel if guild channel or closes DM if DM channel
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(ThreadBuilder builder) Future<ThreadChannel>
Edits this ThreadChannel and returns the edited ThreadChannel
fetchMember(Snowflake memberId, {bool withMembers = false}) Future<IThreadMember>
Fetches thread member from the API Returns IThreadMemberWithMember when withMembers set to true
fetchMembers({bool withMembers = false, Snowflake? after, int limit = 100}) Stream<IThreadMember>
Fetches from API current list of member that has access to that thread Returns IThreadMemberWithMember when withMembers set to true
fetchMessage(Snowflake id) Future<IMessage>
Returns IMessage downloaded from API
inherited
fetchPinnedMessages() Stream<IMessage>
Returns pinned IMessages for channel.
inherited
getMessage(Snowflake id) IMessage?
Returns Message with given id from CACHE
inherited
leaveThread() Future<void>
Leaves this thread channel
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeThreadMember(SnowflakeEntity user) Future<void>
Removes user from ThreadChannel
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