Class GroupDMChannel

Namespace

NetCord

Assembly

NetCord.dll

Represents a text channel for private messages, with up to 10 users.

public class GroupDMChannel : DMChannel, IEquatable<Entity>, IJsonModel<JsonChannel>, IInteractionChannel, INamedChannel, IEntity, ISpanFormattable, IFormattable

Inheritance

object

Entity

ClientEntity

Channel

TextChannel

DMChannel

GroupDMChannel

Implements

IEquatable<Entity>

IJsonModel<JsonChannel>

IInteractionChannel

INamedChannel

IEntity

ISpanFormattable

IFormattable

Inherited Members

DMChannel.CreateFromJson(JsonChannel, RestClient)

DMChannel.Users

TextChannel.GetMessagesAsync(PaginationProperties<ulong>, RestRequestProperties)

TextChannel.GetMessagesAroundAsync(ulong, int?, RestRequestProperties, CancellationToken)

TextChannel.GetMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.SendMessageAsync(MessageProperties, RestRequestProperties, CancellationToken)

TextChannel.AddMessageReactionAsync(ulong, ReactionEmojiProperties, RestRequestProperties, CancellationToken)

TextChannel.DeleteCurrentUserMessageReactionAsync(ulong, ReactionEmojiProperties, RestRequestProperties, CancellationToken)

TextChannel.DeleteUserMessageReactionAsync(ulong, ReactionEmojiProperties, ulong, RestRequestProperties, CancellationToken)

TextChannel.GetMessageReactionsAsync(ulong, ReactionEmojiProperties, MessageReactionsPaginationProperties, RestRequestProperties)

TextChannel.DeleteAllMessageReactionsAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.DeleteAllMessageReactionsForEmojiAsync(ulong, ReactionEmojiProperties, RestRequestProperties, CancellationToken)

TextChannel.ModifyMessageAsync(ulong, Action<MessageOptions>, RestRequestProperties, CancellationToken)

TextChannel.DeleteMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.DeleteMessagesAsync(IEnumerable<ulong>, RestRequestProperties, CancellationToken)

TextChannel.TriggerTypingAsync(RestRequestProperties, CancellationToken)

TextChannel.EnterTypingScopeAsync(TypingScopeProperties, RestRequestProperties, CancellationToken)

TextChannel.EnterTypingScope(TypingScopeProperties, RestRequestProperties)

TextChannel.GetPinsAsync(PaginationProperties<DateTimeOffset>, RestRequestProperties, CancellationToken)

TextChannel.PinMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.UnpinMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.GetMessagePollAnswerVotersAsync(ulong, int, PaginationProperties<ulong>, RestRequestProperties)

TextChannel.EndMessagePollAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.LastMessageId

TextChannel.LastPin

Channel.ToString()

Channel.TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider)

Channel.CreateGoogleCloudPlatformStorageBucketsAsync(IEnumerable<GoogleCloudPlatformStorageBucketProperties>, RestRequestProperties, CancellationToken)

Channel.Id

Channel.Flags

Entity.Equals(object)

Entity.Equals(Entity)

Entity.GetHashCode()

Entity.ToString(string, IFormatProvider)

Entity.CreatedAt

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

GroupDMChannel(JsonChannel, RestClient)

Represents a text channel for private messages, with up to 10 users.

public GroupDMChannel(JsonChannel jsonModel, RestClient client)

Parameters

jsonModel JsonChannel

client RestClient

Properties

ApplicationId

The ID corresponding to the application managing the group channel, if any, otherwise null.

public ulong? ApplicationId { get; }

Property Value

ulong?

IconHash

The group channel's icon hash.

public string? IconHash { get; }

Property Value

string

Managed

Whether the group channel is managed by an application with GroupDMCreate set.

public bool Managed { get; }

Property Value

bool

Name

The group channel's name.

public string Name { get; }

Property Value

string

OwnerId

The ID corresponding to the group channel's owner.

public ulong OwnerId { get; }

Property Value

ulong

Methods

AddUserAsync(ulong, GroupDMChannelUserAddProperties, RestRequestProperties?, CancellationToken)

Adds a recipient to a group DM channel.

public Task AddUserAsync(ulong userId, GroupDMChannelUserAddProperties groupDMChannelUserAddProperties, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

userId ulong

The ID of the user to add.

groupDMChannelUserAddProperties GroupDMChannelUserAddProperties

Properties for adding the user, such as access tokens.

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task

DeleteAsync(RestRequestProperties?, CancellationToken)

Deletes a channel.

public Task<GroupDMChannel> DeleteAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<GroupDMChannel>

DeleteUserAsync(ulong, RestRequestProperties?, CancellationToken)

Removes a recipient from a group DM channel.

public Task DeleteUserAsync(ulong userId, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

userId ulong

The ID of the user to remove.

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task

GetAsync(RestRequestProperties?, CancellationToken)

Retrieves a channel by its ID.

public Task<GroupDMChannel> GetAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<GroupDMChannel>

ModifyAsync(Action<GroupDMChannelOptions>, RestRequestProperties?, CancellationToken)

Modifies a group DM channel's properties.

public Task<GroupDMChannel> ModifyAsync(Action<GroupDMChannelOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

action Action<GroupDMChannelOptions>

An action delegate used to configure the channel's updated properties.

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<GroupDMChannel>