ForumChannel
Signature
@Mixins(ThreadOnlyMethods, WebhookChannelMethods)export declare class ForumChannel extends BaseGuildChannelPrivate types
IChannelTypesInterface
interface IChannelTypes { GuildStageVoice: StageChannel; GuildMedia: MediaChannel; DM: DMChannel; GuildForum: ForumChannel; AnnouncementThread: ThreadChannel; PrivateThread: ThreadChannel; PublicThread: ThreadChannel; GuildDirectory: DirectoryChannel; GuildVoice: VoiceChannel; GuildText: TextGuildChannel; GuildCategory: CategoryChannel; GuildAnnouncement: NewsChannel;}Properties
25Methods
36memberPermissionsrolePermissionsoverwritesForguildsetPositionsetNamesetParentsetRatelimitPerUsersetNsfweditfetchdeletetoStringisStageisMediaisDMisForumisThreadisDirectoryisVoiceisTextGuildisCategoryisNewsisTextableisGuildTextableisNamedisGuildisThreadOnlyisthreadsetTagssetAutoArchiveDurationsetReactionEmojisetSortOrdersetThreadRateLimitsetTopic
Properties
type: ChannelType.GuildForum;guildId: string;invites: BaseGuildChannel["invites"];permissionOverwrites: BaseGuildChannel["permissionOverwrites"];urlGetterget url(): `https://discord.com/channels/${string}/${string}`;The URL to the channel
id: string;createdTimestampGetterget createdTimestamp(): number;Create a timestamp for the current object.
createdAtGetterget createdAt(): Date;createdAt gets the creation Date instace of the current object.
readonly client: UsingClient;flags?: ChannelFlags | undefined;name: string;position: number;parentId?: string | null | undefined;nsfw?: boolean | undefined;topic?: string | null | undefined;lastMessageId?: string | null | undefined;lastPinTimestamp?: string | null | undefined;rateLimitPerUser?: number | undefined;defaultAutoArchiveDuration?: ThreadAutoArchiveDuration | undefined;defaultThreadRateLimitPerUser?: number | undefined;availableTags: { id: string; name: string; moderated: boolean; emojiId: string | null; emojiName: string | null; }[];defaultReactionEmoji: { emojiId: string | null; emojiName: string | null; } | null;defaultSortOrder: SortOrderType | null;defaultForumLayout: ForumLayoutType;webhooks: WebhookChannelMethods["webhooks"];Methods
memberPermissions(member: GuildMember, checkAdmin?: boolean): Promise<PermissionsBitField>;rolePermissions(role: GuildRole, checkAdmin?: boolean): Promise<PermissionsBitField>;overwritesFor(member: GuildMember): Promise<{ everyone: { type: OverwriteType; id: string; deny: PermissionsBitField; allow: PermissionsBitField; guildId: string; } | undefined; roles: { type: OverwriteType; id: string; deny: PermissionsBitField; allow: PermissionsBitField; guildId: string; }[]; member: { type: OverwriteType; id: string; deny: PermissionsBitField; allow: PermissionsBitField; guildId: string; } | undefined;}>;guild(mode?: 'rest' | 'flow'): Promise<GuildStructure<'cached' | 'api'>>;guild(mode: 'cache'): ReturnCache<GuildStructure<'cached'> | undefined>;setPosition(position: number, reason?: string): Promise<this>;setName(name: string, reason?: string): Promise<this>;setParent(parent_id: string | null, reason?: string): Promise<this>;setRatelimitPerUser(rate_limit_per_user: number | null | undefined): Promise<this>;setNsfw(nsfw?: boolean, reason?: string): Promise<this>;edit(body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<this>;fetch(mode?: 'rest' | 'flow'): Promise<AllChannels>;fetch(mode: 'cache'): ReturnCache<AllChannels | undefined>;delete(reason?: string): Promise<this>;toString(): `<#${string}>`;Returns a string representation of an object.
isStage(): this is StageChannel;isMedia(): this is MediaChannel;isDM(): this is DMChannel;isForum(): this is ForumChannel;isThread(): this is ThreadChannel;isDirectory(): this is DirectoryChannel;isVoice(): this is VoiceChannel;isTextGuild(): this is TextGuildChannel;isCategory(): this is CategoryChannel;isNews(): this is NewsChannel;isTextable(): this is AllTextableChannels;isGuildTextable(): this is AllGuildTextableChannels;isNamed(): this is AllNamedChannels;isGuild(): this is AllGuildChannels | BaseGuildChannelStructure;isThreadOnly(): this is ForumChannel | MediaChannel;is<T extends (keyof IChannelTypes)[]>(channelTypes: T): this is IChannelTypes[T[number]];thread(body: ThreadOnlyCreateBodyRequest, reason?: string): Promise<ThreadChannelStructure>;Create a new thread.
Parameters
body- After name, at least one of the following properties must be provided: any content of `message` or `files`.
reason- The reason for creating the thread, shows up on audit logs.
Returns
A promise that resolves with the created thread.
setTags(tags: APIGuildForumTag[], reason?: string): Promise<this>;setAutoArchiveDuration(duration: ThreadAutoArchiveDuration, reason?: string): Promise<this>;setReactionEmoji(emoji: APIGuildForumDefaultReactionEmoji, reason?: string): Promise<this>;setSortOrder(sort: SortOrderType, reason?: string): Promise<this>;setThreadRateLimit(rate: number, reason?: string): Promise<this>;setTopic(topic: string | null, reason?: string): Promise<this>;