Class SocketForumChannel

Represents a forum channel in a guild.

Inheritance

Object

SocketEntity<UInt64>

SocketChannel

SocketGuildChannel

SocketForumChannel

Implements

IEntity<UInt64>

IForumChannel

IMentionable

INestedChannel

IIntegrationChannel

IGuildChannel

IChannel

ISnowflakeEntity

IEntity<UInt64>

IDeletable

Inherited Members

SocketGuildChannel.Guild

SocketGuildChannel.Name

SocketGuildChannel.Position

SocketGuildChannel.Flags

SocketGuildChannel.PermissionOverwrites

SocketGuildChannel.Users

SocketGuildChannel.ModifyAsync(Action<GuildChannelProperties>, RequestOptions)

SocketGuildChannel.DeleteAsync(RequestOptions)

SocketGuildChannel.GetPermissionOverwrite(IUser)

SocketGuildChannel.GetPermissionOverwrite(IRole)

SocketGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)

SocketGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)

SocketGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)

SocketGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)

SocketGuildChannel.GetUser(UInt64)

SocketGuildChannel.ToString()

SocketGuildChannel.IGuildChannel.Guild

SocketChannel.CreatedAt

SocketEntity<UInt64>.Id

Namespace: Discord.WebSocket

Assembly: Discord.Net.WebSocket.dll

Syntax

public class SocketForumChannel : SocketGuildChannel, IEntity<ulong>, IForumChannel, IMentionable, INestedChannel, IIntegrationChannel, IGuildChannel, IChannel, ISnowflakeEntity, IEntity<ulong>, IDeletable

Properties

Category

Gets the parent (category) of this channel in the guild's channel list.

Declaration

public ICategoryChannel Category { get; }

Property Value

Type	Description
ICategoryChannel	An ICategoryChannel representing the parent of this channel; null if none is set.

CategoryId

Declaration

public ulong? CategoryId { get; }

Property Value

Type	Description
Nullable<UInt64>

DefaultAutoArchiveDuration

Gets the default archive duration for a newly created post.

Declaration

public ThreadArchiveDuration DefaultAutoArchiveDuration { get; }

Property Value

Type	Description
ThreadArchiveDuration

DefaultLayout

Gets the rule used to display posts in a forum channel.

Declaration

public ForumLayout DefaultLayout { get; }

Property Value

Type	Description
ForumLayout

DefaultReactionEmoji

Gets the emoji to show in the add reaction button on a thread in a forum channel

Declaration

public IEmote DefaultReactionEmoji { get; }

Property Value

Type	Description
IEmote

Remarks

If the emoji is Emote only the Id will be populated. Use GetEmoteAsync(UInt64, RequestOptions) to get the emoji.

DefaultSlowModeInterval

Declaration

public int DefaultSlowModeInterval { get; }

Property Value

Type	Description
Int32

DefaultSortOrder

Declaration

public ForumSortOrder? DefaultSortOrder { get; }

Property Value

Type	Description
Nullable<ForumSortOrder>

IsNsfw

Declaration

public bool IsNsfw { get; }

Property Value

Type	Description
Boolean

Mention

Declaration

public string Mention { get; }

Property Value

Type	Description
String

Tags

Declaration

public IReadOnlyCollection<ForumTag> Tags { get; }

Property Value

Type	Description
IReadOnlyCollection<ForumTag>

ThreadCreationInterval

Declaration

public int ThreadCreationInterval { get; }

Property Value

Type	Description
Int32

Topic

Declaration

public string Topic { get; }

Property Value

Type	Description
String

Methods

CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

Declaration

public virtual async Task<IInviteMetadata> CreateInviteAsync(int? maxAge, int? maxUses = null, bool isTemporary = false, bool isUnique = false, RequestOptions options = null)

Parameters

Type	Name	Description
Nullable<Int32>	maxAge
Nullable<Int32>	maxUses
Boolean	isTemporary
Boolean	isUnique
RequestOptions	options

Returns

Type	Description
Task<IInviteMetadata>

CreateInviteToApplicationAsync(DefaultApplications, Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

Declaration

public virtual async Task<IInviteMetadata> CreateInviteToApplicationAsync(DefaultApplications application, int? maxAge, int? maxUses = null, bool isTemporary = false, bool isUnique = false, RequestOptions options = null)

Parameters

Type	Name	Description
DefaultApplications	application
Nullable<Int32>	maxAge
Nullable<Int32>	maxUses
Boolean	isTemporary
Boolean	isUnique
RequestOptions	options

Returns

Type	Description
Task<IInviteMetadata>

CreateInviteToApplicationAsync(UInt64, Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

Declaration

public virtual async Task<IInviteMetadata> CreateInviteToApplicationAsync(ulong applicationId, int? maxAge, int? maxUses = null, bool isTemporary = false, bool isUnique = false, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	applicationId
Nullable<Int32>	maxAge
Nullable<Int32>	maxUses
Boolean	isTemporary
Boolean	isUnique
RequestOptions	options

Returns

Type	Description
Task<IInviteMetadata>

CreateInviteToStreamAsync(IUser, Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

Declaration

public virtual Task<IInviteMetadata> CreateInviteToStreamAsync(IUser user, int? maxAge, int? maxUses = null, bool isTemporary = false, bool isUnique = false, RequestOptions options = null)

Parameters

Type	Name	Description
IUser	user
Nullable<Int32>	maxAge
Nullable<Int32>	maxUses
Boolean	isTemporary
Boolean	isUnique
RequestOptions	options

Returns

Type	Description
Task<IInviteMetadata>

CreatePostAsync(String, ThreadArchiveDuration, Nullable<Int32>, String, Embed, RequestOptions, AllowedMentions, MessageComponent, ISticker[], Embed[], MessageFlags, ForumTag[])

Declaration

public Task<RestThreadChannel> CreatePostAsync(string title, ThreadArchiveDuration archiveDuration = default(ThreadArchiveDuration), int? slowmode = null, string text = null, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags), ForumTag[] tags = null)

Parameters

Type	Name	Description
String	title
ThreadArchiveDuration	archiveDuration
Nullable<Int32>	slowmode
String	text
Embed	embed
RequestOptions	options
AllowedMentions	allowedMentions
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags
ForumTag[]	tags

Returns

Type	Description
Task<RestThreadChannel>

CreatePostWithFileAsync(String, FileAttachment, ThreadArchiveDuration, Nullable<Int32>, String, Embed, RequestOptions, AllowedMentions, MessageComponent, ISticker[], Embed[], MessageFlags, ForumTag[])

Declaration

public Task<RestThreadChannel> CreatePostWithFileAsync(string title, FileAttachment attachment, ThreadArchiveDuration archiveDuration = default(ThreadArchiveDuration), int? slowmode = null, string text = null, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags), ForumTag[] tags = null)

Parameters

Type	Name	Description
String	title
FileAttachment	attachment
ThreadArchiveDuration	archiveDuration
Nullable<Int32>	slowmode
String	text
Embed	embed
RequestOptions	options
AllowedMentions	allowedMentions
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags
ForumTag[]	tags

Returns

Type	Description
Task<RestThreadChannel>

CreatePostWithFileAsync(String, Stream, String, ThreadArchiveDuration, Nullable<Int32>, String, Embed, RequestOptions, Boolean, AllowedMentions, MessageComponent, ISticker[], Embed[], MessageFlags, ForumTag[])

Declaration

public async Task<RestThreadChannel> CreatePostWithFileAsync(string title, Stream stream, string filename, ThreadArchiveDuration archiveDuration = default(ThreadArchiveDuration), int? slowmode = null, string text = null, Embed embed = null, RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags), ForumTag[] tags = null)

Parameters

Type	Name	Description
String	title
Stream	stream
String	filename
ThreadArchiveDuration	archiveDuration
Nullable<Int32>	slowmode
String	text
Embed	embed
RequestOptions	options
Boolean	isSpoiler
AllowedMentions	allowedMentions
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags
ForumTag[]	tags

Returns

Type	Description
Task<RestThreadChannel>

CreatePostWithFileAsync(String, String, ThreadArchiveDuration, Nullable<Int32>, String, Embed, RequestOptions, Boolean, AllowedMentions, MessageComponent, ISticker[], Embed[], MessageFlags, ForumTag[])

Declaration

public async Task<RestThreadChannel> CreatePostWithFileAsync(string title, string filePath, ThreadArchiveDuration archiveDuration = default(ThreadArchiveDuration), int? slowmode = null, string text = null, Embed embed = null, RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags), ForumTag[] tags = null)

Parameters

Type	Name	Description
String	title
String	filePath
ThreadArchiveDuration	archiveDuration
Nullable<Int32>	slowmode
String	text
Embed	embed
RequestOptions	options
Boolean	isSpoiler
AllowedMentions	allowedMentions
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags
ForumTag[]	tags

Returns

Type	Description
Task<RestThreadChannel>

CreatePostWithFilesAsync(String, IEnumerable<FileAttachment>, ThreadArchiveDuration, Nullable<Int32>, String, Embed, RequestOptions, AllowedMentions, MessageComponent, ISticker[], Embed[], MessageFlags, ForumTag[])

Declaration

public Task<RestThreadChannel> CreatePostWithFilesAsync(string title, IEnumerable<FileAttachment> attachments, ThreadArchiveDuration archiveDuration = default(ThreadArchiveDuration), int? slowmode = null, string text = null, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags), ForumTag[] tags = null)

Parameters

Type	Name	Description
String	title
IEnumerable<FileAttachment>	attachments
ThreadArchiveDuration	archiveDuration
Nullable<Int32>	slowmode
String	text
Embed	embed
RequestOptions	options
AllowedMentions	allowedMentions
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags
ForumTag[]	tags

Returns

Type	Description
Task<RestThreadChannel>

CreateWebhookAsync(String, Stream, RequestOptions)

Creates a webhook in this channel.

Declaration

public Task<RestWebhook> CreateWebhookAsync(string name, Stream avatar = null, RequestOptions options = null)

Parameters

Type	Name	Description
String	name	The name of the webhook.
Stream	avatar	The avatar of the webhook.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task<RestWebhook>	A task that represents the asynchronous creation operation. The task result contains the newly created webhook.

GetActiveThreadsAsync(RequestOptions)

Gets a collection of active threads within this channel.

Declaration

public Task<IReadOnlyCollection<RestThreadChannel>> GetActiveThreadsAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task<IReadOnlyCollection<RestThreadChannel>>	A task that represents an asynchronous get operation for retrieving the threads. The task result contains a collection of active threads.

GetInvitesAsync(RequestOptions)

Declaration

public virtual async Task<IReadOnlyCollection<IInviteMetadata>> GetInvitesAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
Task<IReadOnlyCollection<IInviteMetadata>>

GetJoinedPrivateArchivedThreadsAsync(Nullable<Int32>, Nullable<DateTimeOffset>, RequestOptions)

Declaration

public Task<IReadOnlyCollection<RestThreadChannel>> GetJoinedPrivateArchivedThreadsAsync(int? limit = null, DateTimeOffset? before = null, RequestOptions options = null)

Parameters

Type	Name	Description
Nullable<Int32>	limit
Nullable<DateTimeOffset>	before
RequestOptions	options

Returns

Type	Description
Task<IReadOnlyCollection<RestThreadChannel>>

GetPrivateArchivedThreadsAsync(Nullable<Int32>, Nullable<DateTimeOffset>, RequestOptions)

Declaration

public Task<IReadOnlyCollection<RestThreadChannel>> GetPrivateArchivedThreadsAsync(int? limit = null, DateTimeOffset? before = null, RequestOptions options = null)

Parameters

Type	Name	Description
Nullable<Int32>	limit
Nullable<DateTimeOffset>	before
RequestOptions	options

Returns

Type	Description
Task<IReadOnlyCollection<RestThreadChannel>>

GetPublicArchivedThreadsAsync(Nullable<Int32>, Nullable<DateTimeOffset>, RequestOptions)

Declaration

public Task<IReadOnlyCollection<RestThreadChannel>> GetPublicArchivedThreadsAsync(int? limit = null, DateTimeOffset? before = null, RequestOptions options = null)

Parameters

Type	Name	Description
Nullable<Int32>	limit
Nullable<DateTimeOffset>	before
RequestOptions	options

Returns

Type	Description
Task<IReadOnlyCollection<RestThreadChannel>>

GetWebhookAsync(UInt64, RequestOptions)

Creates a webhook in this channel.

Declaration

public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	id
RequestOptions	options

Returns

Type	Description
Task<RestWebhook>	A task that represents the asynchronous creation operation. The task result contains the newly created webhook.

GetWebhooksAsync(RequestOptions)

Creates a webhook in this channel.

Declaration

public Task<IReadOnlyCollection<RestWebhook>> GetWebhooksAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
Task<IReadOnlyCollection<RestWebhook>>	A task that represents the asynchronous creation operation. The task result contains the newly created webhook.

ModifyAsync(Action<ForumChannelProperties>, RequestOptions)

Declaration

public virtual Task ModifyAsync(Action<ForumChannelProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
Action<ForumChannelProperties>	func
RequestOptions	options

Returns

Type	Description
Task

SyncPermissionsAsync(RequestOptions)

Declaration

public virtual Task SyncPermissionsAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
Task

Implements

IEntity<TId>

IForumChannel

IMentionable

INestedChannel

IIntegrationChannel

IGuildChannel

IChannel

ISnowflakeEntity

IEntity<TId>

IDeletable