IForumChannel class Null safety

Implemented types

Constructors

IForumChannel()

Properties

availableTags List<IForumTag>
Tags available to assign to forum posts
read-only
channelType ChannelType
Type of this channel
read-only, inherited
client INyxx
Reference to client
read-only, inherited
createdAt DateTime
Gets creation timestamp included in Snowflake
read-only, inherited
defaultReactionEmoji IEmoji?
The emoji to show in the add reaction button on a thread in a GUILD_FORUM channel
read-only
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
read-only
forumChannelFlags IForumChannelTags
Channel flags
read-only
guild Cacheable<Snowflake, IGuild>
Id of Guild that the channel is in.
read-only, 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-only, inherited
mention String
Mention string of entity
read-only, inherited
name String
The channel's name.
read-only, inherited
parentChannel Cacheable<Snowflake, GuildChannel>?
Id of parent channel
read-only, inherited
permissionOverrides List<IPermissionsOverrides>
Permission override for channel
read-only, inherited
position int
Relative position of channel in context of channel list
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

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 non-existent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

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