Class ForumGuildThread
- Namespace
- NetCord
- Assembly
- NetCord.dll
Represents a GuildThread within a ForumGuildChannel, acquired via CreateForumGuildThreadAsync(ulong, ForumGuildThreadProperties, RestRequestProperties?, CancellationToken).
public class ForumGuildThread : PublicGuildThread, IEquatable<Entity>, IJsonModel<JsonChannel>, IInteractionChannel, IGuildChannel, INamedChannel, IEntity, ISpanFormattable, IFormattable, ICloneable- Inheritance
-
ForumGuildThread
- Implements
- Inherited Members
Remarks
Threads within a forum are typically acquired as PublicGuildThread objects.
Constructors
ForumGuildThread(JsonChannel, RestClient)
Represents a GuildThread within a ForumGuildChannel, acquired via CreateForumGuildThreadAsync(ulong, ForumGuildThreadProperties, RestRequestProperties?, CancellationToken).
public ForumGuildThread(JsonChannel jsonModel, RestClient client)Parameters
jsonModelJsonChannelclientRestClient
Remarks
Threads within a forum are typically acquired as PublicGuildThread objects.
Properties
Message
The message embedded as the thread's starting point.
public RestMessage Message { get; }Property Value
Methods
DeleteAsync(RestRequestProperties?, CancellationToken)
Deletes a channel.
public Task<ForumGuildThread> DeleteAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)Parameters
propertiesRestRequestPropertiesOptional properties to customize the request, can be null.
cancellationTokenCancellationTokenA token that can be used to cancel the operation before it completes.
Returns
GetAsync(RestRequestProperties?, CancellationToken)
Retrieves a channel by its ID.
public Task<ForumGuildThread> GetAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)Parameters
propertiesRestRequestPropertiesOptional properties to customize the request, can be null.
cancellationTokenCancellationTokenA token that can be used to cancel the operation before it completes.
Returns
ModifyAsync(Action<GuildChannelOptions>, RestRequestProperties?, CancellationToken)
Modifies a guild channel's properties.
public Task<ForumGuildThread> ModifyAsync(Action<GuildChannelOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)Parameters
actionAction<GuildChannelOptions>An action delegate used to configure the updated channel options.
propertiesRestRequestPropertiesOptional properties to customize the request, can be null.
cancellationTokenCancellationTokenA token that can be used to cancel the operation before it completes.