TextGuildChannel class

Inheritance

• Object
• SnowflakeEntity
• IChannel
• MinimalGuildChannel
• GuildChannel
• TextGuildChannel

Implemented types

• TextChannel
• Mentionable

Properties

channelType ↔ ChannelType

Type of this channel

late, final, inherited

client → INyxx

Reference to client

final, inherited

createdAt → DateTime

Gets creation timestamp included in Snowflake

no setter, inherited

fileUploadLimit → Future<int>

File upload limit for channel in bytes.

no setter, override

guild ↔ Cacheable<Snowflake, Guild>

Id of Guild that the channel is in.

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → Snowflake

ID of entity as Snowflake

final, inherited

isNsfw ↔ bool

Indicates if channel is nsfw

late, final, inherited

mention → String

The channel's mention string.

no setter, override

messageCache → MessageCache

A collection of messages sent to this channel.

late, final

name ↔ String

The channel's name.

late, final, inherited

parentChannel ↔ Cacheable<Snowflake, GuildChannel>?

Id of parent channel

late, final, inherited

permissionOverrides ↔ List<PermissionsOverrides>

Permission override for channel

late, final, inherited

position ↔ int

Relative position of channel in context of channel list

late, final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

slowModeThreshold ↔ int

Channel's slow mode rate limit in seconds. This must be between 0 and 120.

late, final

topic ↔ String?

The channel's topic.

late, final

url → String

Returns url to this channel.

no setter

Methods

bulkRemoveMessages(Iterable<SnowflakeEntity> messages) → Future<void>

Bulk removes many messages by its ids. messages is list of messages ids to delete.

override

createAndGetThread(ThreadBuilder builder) → Future<ThreadChannel>

Creates a thread in a message

createInvite({int? maxAge, int? maxUses, bool? temporary, bool? unique, String? auditReason}) → Future<Invite>

Creates new Invite for IChannel and returns it"s instance

inherited

createThread(ThreadBuilder builder) → Future<ThreadPreviewChannel>

Creates a thread in a channel, that only retrieves a ThreadPreviewChannel

createWebhook(String name, {AttachmentBuilder? avatarAttachment, String? auditReason}) → Future<Webhook>

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<Message>

Gets several Message objects from API. Only one of after, before, around can be specified, otherwise, it will throw.

override

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(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

fetchActiveThreads() → Future<ThreadListResultWrapper>

Fetches all active threads in this channel

fetchChannelInvites() → Stream<InviteWithMeta>

Fetches and returns all channel"s Invites

inherited

fetchJoinedPrivateArchivedThreads({DateTime? before, int? limit}) → Future<ThreadListResultWrapper>

Fetches joined private and archived thread channels

fetchMessage(Snowflake messageId) → Future<Message>

Returns Message downloaded from API

override

fetchPinnedMessages() → Stream<Message>

Returns pinned Messages for channel.

override

fetchPrivateArchivedThreads({DateTime? before, int? limit}) → Future<ThreadListResultWrapper>

Fetches private, archived thread channels

fetchPublicArchivedThreads({DateTime? before, int? limit}) → Future<ThreadListResultWrapper>

Fetches public, archives thread channels

getMessage(Snowflake id) → Message?

Returns Message with given id from CACHE

override

getWebhooks() → Stream<Webhook>

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<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