GuildTextChannel class

ITextChannel in context of Guild.

Implemented types
Implementers

Constructors

GuildTextChannel()

Properties

client Nyxx
Reference to client instance
final, inherited
createdAt DateTime
Gets creation timestamp included in Snowflake
read-only, inherited
fileUploadLimit int
File upload limit for channel in bytes. If channel is CachelessGuildChannel returns default value.
read-only, inherited
guildId Snowflake
Id of Guild that the channel is in.
final, 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
iterator Iterator<Message>
Returns iterator for messages cache
read-only, inherited
mention String
The channel's mention string.
read-only
messages MessageCache
A collection of messages sent to this channel.
final, late, inherited
name String
The channel"s name.
read / write, final, late, inherited
onMessage Stream<MessageReceivedEvent>
Sent when a new message is received.
final, late, inherited
onTyping Stream<TypingEvent>
Emitted when user starts typing.
final, late, inherited
parentChannelId Snowflake
Id of parent channel
read / write, final, late, inherited
permissionOverrides List<PermissionsOverrides>
Returns list of CacheMember objects who can see this channel
read / write, final, late, inherited
pinsUpdated Stream<ChannelPinsUpdateEvent>
Emitted when channel pins are updated.
final, late, inherited
position int
The channel's position in the 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 slowmode 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
type ChannelType
The channel's type. https://discordapp.com/developers/docs/resources/channel#channel-object-channel-types
final, inherited
url String
Returns url to this channel.
read-only

Methods

bulkRemoveMessages(Iterable<Message> messagesIds) Future<void>
Bulk removes many messages by its ids. messagesIds is list of messages ids to delete. [...]
inherited
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. [...]
delete({String auditReason}) Future<void>
Deletes the channel. Throws if bot cannot perform operation
inherited
deleteChannelPermission(SnowflakeEntity id, {String auditReason}) Future<void>
Deletes permission overwrite for given User or Role id Throws if id isn't User or Role
inherited
dispose() Future<void>
Perform cleanup
inherited
edit({String name, String topic, int position, int slowModeThreshold}) Future<GuildTextChannel>
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 permissions for channel. entity can be either User or Role Throws if entity isn't User or Role
inherited
getChannelInvites() Stream<InviteWithMeta>
Fetches and returns all channel"s Invites [...]
inherited
getMessage(Snowflake id, {bool ignoreCache: false}) Future<Message>
Returns message with given id. Allows to force fetch message from api with ignoreCache property. By default it checks if message is in cache and fetches from api if not.
inherited
getMessages({int limit: 50, Snowflake after, Snowflake before, Snowflake around}) Stream<Message>
Gets several Message objects from API. Only one of after, before, around can be specified, otherwise, it will throw. [...]
inherited
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
send({dynamic content, List<AttachmentBuilder> files, EmbedBuilder embed, bool tts, AllowedMentions allowedMentions, MessageBuilder builder}) Future<Message>
Sends message to channel. Performs toString() on thing passed to content. Allows to send embeds with embed field. [...]
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
Returns mention to channel
override

Operators

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