IForumChannel class abstract

Implemented types

Constructors

IForumChannel()

Properties

availableTags → List<IForumTag>
Tags available to assign to forum posts
no setter
channelType → ChannelType
Type of this channel
no setterinherited
client → INyxx
Reference to client
no setterinherited
createdAt → DateTime
Gets creation timestamp included in Snowflake
no setterinherited
defaultForumLayout → ForumLayout
The default forum layout view used to display posts in GUILD_FORUM channels. Defaults to 0, which indicates a layout view has not been set by a channel admin
no setter
defaultReactionEmoji → IEmoji?
The emoji to show in the add reaction button on a thread in a GUILD_FORUM channel
no setter
defaultSortOrder → ForumSortOrder?
The default sort order type used to order posts in GUILD_FORUM channels. Defaults to null, which indicates a preferred sort order hasn't been set by a channel admin
no setter
forumChannelFlags → IForumChannelTags
Channel flags
no setter
guild → Cacheable<Snowflake, IGuild>
Id of Guild that the channel is in.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → Snowflake
ID of entity as Snowflake
finalinherited
isNsfw → bool
Indicates if channel is nsfw
no setterinherited
mention → String
Mention string of entity
no setterinherited
name → String
The channel's name.
no setterinherited
parentChannel → Cacheable<Snowflake, GuildChannel>?
Id of parent channel
no setterinherited
permissionOverrides → List<IPermissionsOverrides>
Permission override for channel
no setterinherited
position → int
Relative position of channel in context of channel list
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

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(ForumThreadBuilder builder) → Future<IThreadChannel>
Creates a thread in a channel, that only retrieves a ThreadPreviewChannel
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
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
fetchPrivateArchivedThreads({DateTime? before, int? limit}) → Future<IThreadListResultWrapper>
Fetches private, archived thread channels
fetchPublicArchivedThreads({DateTime? before, int? limit}) → Future<IThreadListResultWrapper>
Fetches public, archives thread channels
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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