NetCord API Documentation

https://netcord.dev/docs/
Admin
NetCord provides .NET developers with comprehensive API documentation to build Discord bots. Explore...
Tokens:548,861
Snippets:6,538
Trust Score:5.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### StartAsync

Source: https://netcord.dev/docs/NetCord.Gateway.GatewayClient.html

Starts the GatewayClient.

```APIDOC
## StartAsync

### Description
Starts the GatewayClient.

### Method
StartAsync

### Signature
`public ValueTask StartAsync(PresenceProperties? presence = null, CancellationToken cancellationToken = default)`

### Parameters
- **presence** (PresenceProperties?) - Optional - The presence to set.
- **cancellationToken** (CancellationToken) - Optional - The cancellation token to cancel the operation.

### Returns
ValueTask
```

--------------------------------

### WithOAuth2InstallParams(ApplicationInstallParamsProperties?)

Source: https://netcord.dev/docs/NetCord.Rest.ApplicationIntegrationTypeConfigurationProperties.html

Sets additional installation params to apply to the specific install context. Returns the same instance for chaining.

```APIDOC
## WithOAuth2InstallParams(ApplicationInstallParamsProperties?)

### Description
Sets additional installation params to apply to the specific install context.

### Method
WithOAuth2InstallParams

### Parameters
- **oAuth2InstallParams** (ApplicationInstallParamsProperties?) - Optional - Additional installation params to apply.

### Returns
ApplicationIntegrationTypeConfigurationProperties - The current instance for chaining.
```

--------------------------------

### JsonApplicationInstallParams.Permissions Property

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonApplicationInstallParams.html

Gets or sets the permissions required for the application installation.

```APIDOC
## Permissions Property

### Description
Gets or sets the permissions required for the application installation.

### Property Value
`Permissions`

### JSON Property Name
`permissions`

### Syntax
```csharp
[JsonPropertyName("permissions")]
public Permissions Permissions { get; set; }
```

```

--------------------------------

### StartAsync(CancellationToken)

Source: https://netcord.dev/docs/NetCord.Gateway.Voice.VoiceClient.html

Starts the VoiceClient.

```APIDOC
## StartAsync(CancellationToken)

### Description
Starts the VoiceClient.

### Method
StartAsync

### Signature
public ValueTask StartAsync(CancellationToken cancellationToken = default)

### Parameters
- **cancellationToken** (CancellationToken) - Optional - The cancellation token.

### Returns
ValueTask
```

--------------------------------

### Scopes

Source: https://netcord.dev/docs/NetCord.ApplicationInstallParams.html

Gets the scopes to use when installing the application to the guild.

```APIDOC
## [PROPERTY] Scopes

### Description
Gets the scopes to use when installing the application to the guild.

### Property Value
IReadOnlyList<string>
```

--------------------------------

### WithCustomInstallUrl(string?)

Source: https://netcord.dev/docs/NetCord.Rest.CurrentApplicationOptions.html

Sets the application's default custom install URL if enabled, otherwise null.

```APIDOC
## WithCustomInstallUrl(string?)

### Description
Sets the application's default custom install URL if enabled, otherwise null.

### Method
WithCustomInstallUrl

### Parameters
- `customInstallUrl` (string) - Required - The custom install URL.

### Returns
CurrentApplicationOptions
```

--------------------------------

### JsonApplicationInstallParams.Scopes Property

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonApplicationInstallParams.html

Gets or sets the OAuth2 scopes required for the application installation.

```APIDOC
## Scopes Property

### Description
Gets or sets the OAuth2 scopes required for the application installation.

### Property Value
`string[]`

### JSON Property Name
`scopes`

### Syntax
```csharp
[JsonPropertyName("scopes")]
public string[] Scopes { get; set; }
```

```

--------------------------------

### Property: DefaultChannelIds

Source: https://netcord.dev/docs/NetCord.Rest.GuildOnboarding.html

Gets the channel IDs that users get opted into automatically.

```APIDOC
## Property: DefaultChannelIds

### Description
Channel Ids that users get opted into automatically.

### Property Value
- **Type**: IReadOnlyList<ulong>
- **Access**: Read-only

### Example
```csharp
IReadOnlyList<ulong> channelIds = onboarding.DefaultChannelIds;
```
```

--------------------------------

### JsonApplicationInstallParams Constructor

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonApplicationInstallParams.html

Initializes a new instance of the JsonApplicationInstallParams class.

```APIDOC
## JsonApplicationInstallParams()

### Description
Initializes a new instance of the JsonApplicationInstallParams class.

### Method
Constructor

### Signature
`public JsonApplicationInstallParams()`

```

--------------------------------

### Property: Mode

Source: https://netcord.dev/docs/NetCord.Rest.GuildOnboarding.html

Gets the current mode of onboarding.

```APIDOC
## Property: Mode

### Description
Current mode of onboarding.

### Property Value
- **Type**: GuildOnboardingMode
- **Access**: Read-only

### Example
```csharp
GuildOnboardingMode mode = onboarding.Mode;
```
```

--------------------------------

### ReadAsync Method

Source: https://netcord.dev/docs/NetCord.Services.ComponentInteractions.TypeReaders.GuidTypeReader-1.html

Reads and converts the input string to a GUID value asynchronously. This method is called by the component interaction framework to parse the user input into a GUID.

```APIDOC
## ReadAsync Method

### Description
Reads and converts the input string to a GUID value asynchronously. This method is called by the component interaction framework to parse the user input into a GUID.

### Method
ReadAsync

### Signature
```csharp
public override ValueTask<ComponentInteractionTypeReaderResult> ReadAsync(ReadOnlyMemory<char> input, TContext context, ComponentInteractionParameter<TContext> parameter, ComponentInteractionServiceConfiguration<TContext> configuration, IServiceProvider? serviceProvider)
```

### Parameters
- **input** (ReadOnlyMemory<char>) - The input string to parse.
- **context** (TContext) - The context of the interaction.
- **parameter** (ComponentInteractionParameter<TContext>) - The parameter being read.
- **configuration** (ComponentInteractionServiceConfiguration<TContext>) - The service configuration.
- **serviceProvider** (IServiceProvider?) - The service provider, optional.

### Returns
ValueTask<ComponentInteractionTypeReaderResult> - The result of the type reading operation.
```

--------------------------------

### ApplicationInstallParamsProperties()

Source: https://netcord.dev/docs/NetCord.Rest.ApplicationInstallParamsProperties.html

Initializes a new instance of the ApplicationInstallParamsProperties class.

```APIDOC
## ApplicationInstallParamsProperties()

### Description
Initializes a new instance of the ApplicationInstallParamsProperties class.

### Method
Constructor

### Parameters
None

### Returns
ApplicationInstallParamsProperties
```

--------------------------------

### Aliases

Source: https://netcord.dev/docs/NetCord.Services.Commands.CommandBuilder.html

Gets the aliases of the command.

```APIDOC
## Aliases

### Description
Gets the aliases of the command.

### Property
`public IEnumerable<string> Aliases { get; }`

### Property Value
- `IEnumerable<string>` - The aliases of the command.

```

--------------------------------

### EntryPointCommandProperties Constructor

Source: https://netcord.dev/docs/NetCord.Rest.EntryPointCommandProperties.html

Initializes a new instance of the EntryPointCommandProperties class with the specified name, description, and handler.

```APIDOC
## EntryPointCommandProperties(string name, string description, EntryPointCommandHandler handler)

### Description
Creates a new Entry Point command properties object. Entry point command serves as the primary way for users to open an application's Activity from the App Launcher. You can create only a single Entry Point command per application.

### Constructor
`public EntryPointCommandProperties(string name, string description, EntryPointCommandHandler handler)`

### Parameters
- **name** (string) - Required - Name of the command (1-32 characters).
- **description** (string) - Required - Description of the command (1-100 characters).
- **handler** (EntryPointCommandHandler) - Required - Determines whether the interaction is handled by the application's interactions handler or by Discord.

### Inherited Members
- ApplicationCommandProperties.Type
- ApplicationCommandProperties.Name
- ApplicationCommandProperties.NameLocalizations
- ApplicationCommandProperties.DefaultGuildPermissions
- ApplicationCommandProperties.IntegrationTypes
- ApplicationCommandProperties.Contexts
- ApplicationCommandProperties.Nsfw
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()
```

--------------------------------

### GetApplicationAsync

Source: https://netcord.dev/docs/NetCord.Rest.RestClient.html

Gets an application by its ID.

```APIDOC
## GetApplicationAsync

### Description
Gets an application by its ID.

### Method
Async method

### Signature
`public Task<Application> GetApplicationAsync(ulong applicationId, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)`

### Parameters
- **applicationId** (ulong) - Required - The ID of the application.
- **properties** (RestRequestProperties) - Optional - Optional properties to customize the request, can be null.
- **cancellationToken** (CancellationToken) - Optional - A token that can be used to cancel the operation before it completes.

### Returns
Task<Application>
```

--------------------------------

### ApplicationInstallParams(JsonApplicationInstallParams)

Source: https://netcord.dev/docs/NetCord.ApplicationInstallParams.html

Initializes a new instance of the ApplicationInstallParams class with the specified JSON model.

```APIDOC
## [CONSTRUCTOR] ApplicationInstallParams(JsonApplicationInstallParams)

### Description
Initializes a new instance of the ApplicationInstallParams class.

### Method
Constructor

### Parameters
#### Parameters
- **jsonModel** (JsonApplicationInstallParams) - Required - The JSON model representing the application install parameters.

### Response
No return value.
```

--------------------------------

### BucketInfo.Bucket

Source: https://netcord.dev/docs/NetCord.Rest.RateLimits.BucketInfo.html

Gets the bucket identifier.

```APIDOC
## Property

### Bucket

#### Description
Gets the bucket identifier.

#### Property Value
- **Type**: string
```

--------------------------------

### Build()

Source: https://netcord.dev/docs/NetCord.Hosting.Services.Commands.ICommandsBuilder.html

Builds the command configuration.

```APIDOC
## Build()

### Description
Builds the command configuration.

### Method
Build

### Signature
```csharp
void Build()
```

### Parameters
None.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### GetAsync

Source: https://netcord.dev/docs/NetCord.GuildTemplate.html

Gets the guild template.

```APIDOC
## GetAsync

### Description
Retrieves the guild template.

### Method
`public Task<GuildTemplate> GetAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)`

### Parameters
- **properties** (RestRequestProperties?) - Optional request properties.
- **cancellationToken** (CancellationToken) - Optional cancellation token.

### Returns
- **Task<GuildTemplate>** - The guild template.

```

--------------------------------

### UseApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>, IServiceProvider>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures the host to use application commands with a configuration action that receives both the options and the service provider.

```APIDOC
## UseApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>, IServiceProvider>)

### Description
Configures the host to use application commands with a configuration action that receives both the options and the service provider.

### Method
Extension Method

### Signature
public static IHostBuilder UseApplicationCommands(this IHostBuilder builder, Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>, IServiceProvider> configureOptions)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>, IServiceProvider>) - Required - The configuration action for the application command service options.

### Returns
- **IHostBuilder** - The configured host builder.
```

--------------------------------

### Id

Source: https://netcord.dev/docs/NetCord.Gateway.Shard.html

Gets the shard ID.

```APIDOC
## Id

### Description
Gets the shard ID.

### Property
`public int Id { get; }`

### Property Value
- `int` - The shard ID.

```

--------------------------------

### GetOnboardingAsync(RestRequestProperties?, CancellationToken)

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Retrieves the onboarding configuration for the guild.

```APIDOC
## GetOnboardingAsync(RestRequestProperties?, CancellationToken)

### Description
Retrieves the onboarding configuration for the guild.

### Method
GetOnboardingAsync

### Signature
public Task<GuildOnboarding> GetOnboardingAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

### Parameters
- **properties** (RestRequestProperties?) - Optional - Additional request properties.
- **cancellationToken** (CancellationToken) - Optional - A token to cancel the operation.

### Returns
Task<GuildOnboarding> - A task representing the asynchronous operation, containing the guild onboarding configuration.
```

--------------------------------

### RegisteredApplicationCommandInfo<TContext> Constructor

Source: https://netcord.dev/docs/NetCord.Services.ApplicationCommands.RegisteredApplicationCommandInfo-1.html

Initializes a new instance of the RegisteredApplicationCommandInfo<TContext> struct with the specified command and command info.

```APIDOC
## Constructor: RegisteredApplicationCommandInfo(ApplicationCommand, ApplicationCommandInfo<TContext>)

### Description
Initializes a new instance of the RegisteredApplicationCommandInfo<TContext> struct.

### Signature
```csharp
public RegisteredApplicationCommandInfo(ApplicationCommand Command, ApplicationCommandInfo<TContext> CommandInfo)
```

### Parameters
- **Command** (ApplicationCommand) - The application command.
- **CommandInfo** (ApplicationCommandInfo<TContext>) - The command information.

```

--------------------------------

### Style

Source: https://netcord.dev/docs/NetCord.Button.html

Gets the style of the button.

```APIDOC
## Style

### Description
Gets the style of the button.

### Property
`public ButtonStyle Style { get; }`

### Property Value
- **ButtonStyle** - The button style.
```

--------------------------------

### Build()

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.IApplicationCommandsBuilder.html

Builds the application commands.

```APIDOC
## Build()

### Description
Builds the application commands.

### Method
Build

### Signature
`void Build()`

### Parameters
None

### Returns
void
```

--------------------------------

### Label

Source: https://netcord.dev/docs/NetCord.Button.html

Gets the label of the button.

```APIDOC
## Label

### Description
Gets the label of the button, if any.

### Property
`public string? Label { get; }`

### Property Value
- **string** - The label, or `null` if none.
```

--------------------------------

### JsonGuildWelcomeScreen.WelcomeChannels Property

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonGuildWelcomeScreen.html

Gets or sets the array of welcome screen channels.

```APIDOC
## JsonGuildWelcomeScreen.WelcomeChannels Property

### Description
Gets or sets the array of welcome screen channels.

### Property Signature
`[JsonPropertyName("welcome_channels")] public JsonWelcomeScreenChannel[] WelcomeChannels { get; set; }`

### Property Value
- **Type**: `JsonWelcomeScreenChannel[]`
- **Description**: An array of `JsonWelcomeScreenChannel` objects representing the welcome screen channels.

```

--------------------------------

### JsonGuildWelcomeScreen.Description Property

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonGuildWelcomeScreen.html

Gets or sets the description of the welcome screen.

```APIDOC
## JsonGuildWelcomeScreen.Description Property

### Description
Gets or sets the description of the welcome screen.

### Property Signature
`[JsonPropertyName("description")] public string? Description { get; set; }`

### Property Value
- **Type**: `string?`
- **Description**: The description of the welcome screen, or `null` if not set.

```

--------------------------------

### Thumbnail.Id

Source: https://netcord.dev/docs/NetCord.Thumbnail.html

Gets the unique identifier for the component.

```APIDOC
## Thumbnail.Id

### Description
Gets the unique identifier for the component.

### Property
`public int Id { get; }`

### Property Value
- **int** - The unique identifier for the component.

```

--------------------------------

### Thumbnail.Description

Source: https://netcord.dev/docs/NetCord.Thumbnail.html

Gets the description of the thumbnail component.

```APIDOC
## Thumbnail.Description

### Description
Gets the description of the thumbnail component.

### Property
`public string? Description { get; }`

### Property Value
- **string** - The description of the thumbnail, or null if not set.

```

--------------------------------

### UseApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures the host to use application commands with a configuration action for the options.

```APIDOC
## UseApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>>)

### Description
Configures the host to use application commands with a configuration action for the options.

### Method
Extension Method

### Signature
public static IHostBuilder UseApplicationCommands(this IHostBuilder builder, Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>> configureOptions)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions<ApplicationCommandInteraction, ApplicationCommandContext, AutocompleteInteractionContext>>) - Required - The configuration action for the application command service options.

### Returns
- **IHostBuilder** - The configured host builder.
```

--------------------------------

### TextDisplay.Id

Source: https://netcord.dev/docs/NetCord.TextDisplay.html

Gets the unique identifier for the component.

```APIDOC
## Property: Id

### Description
Gets the unique identifier for the component.

### Signature
public int Id { get; }

### Property Value
- **int** - The unique identifier for the component.

```

--------------------------------

### SelectedValues

Source: https://netcord.dev/docs/NetCord.Services.ComponentInteractions.HttpUserMenuInteractionContext.html

Gets the selected users from the menu.

```APIDOC
## Property: SelectedValues

### Description
Gets the selected users from the menu.

### Signature
```csharp
public IReadOnlyList<User> SelectedValues { get; }
```

### Property Value
- **Type**: IReadOnlyList<User>

```

--------------------------------

### BucketInfo(string bucket, TopLevelResourceInfo? resourceInfo)

Source: https://netcord.dev/docs/NetCord.Rest.RateLimits.BucketInfo.html

Initializes a new instance of the BucketInfo class with the specified bucket identifier and resource information.

```APIDOC
## Constructor

### BucketInfo(string bucket, TopLevelResourceInfo? resourceInfo)

#### Description
Initializes a new instance of the BucketInfo class.

#### Parameters
- **bucket** (string) - The bucket identifier.
- **resourceInfo** (TopLevelResourceInfo?) - Optional resource information associated with the bucket.
```

--------------------------------

### UseApplicationCommands(IHostBuilder)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Adds application command services to the host builder.

```APIDOC
## UseApplicationCommands(IHostBuilder)

### Description
Adds application command services to the host builder.

### Method
Extension method

### Signature
public static IHostBuilder UseApplicationCommands(this IHostBuilder builder)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### SelectedValues

Source: https://netcord.dev/docs/NetCord.Services.ComponentInteractions.HttpRoleMenuInteractionContext.html

Gets the selected roles from the menu.

```APIDOC
## SelectedValues

### Description
Gets the selected roles from the menu.

### Property Value
IReadOnlyList<Role>

### Example
```csharp
IReadOnlyList<Role> selectedRoles = context.SelectedValues;
```
```

--------------------------------

### User

Source: https://netcord.dev/docs/NetCord.Services.ComponentInteractions.HttpMessageComponentInteractionContext.html

Gets the user who triggered the interaction.

```APIDOC
## Property: User

### Description
Gets the user who invoked the handled command or interaction.

### Signature
public User User { get; }

### Property Value
User

```

--------------------------------

### ConfigureApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures application command services with an options configuration action.

```APIDOC
## ConfigureApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions>)

### Description
Configures application command services with an options configuration action.

### Method
Extension method

### Signature
public static IHostBuilder ConfigureApplicationCommands(this IHostBuilder builder, Action<ApplicationCommandServiceOptions> configureOptions)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions>) - Required - The configuration action for the options.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### Message

Source: https://netcord.dev/docs/NetCord.Services.ComponentInteractions.HttpMessageComponentInteractionContext.html

Gets the message that triggered the interaction.

```APIDOC
## Property: Message

### Description
Gets the message associated with the handled command or interaction.

### Signature
public RestMessage Message { get; }

### Property Value
RestMessage

```

--------------------------------

### Description Property

Source: https://netcord.dev/docs/NetCord.GuildWelcomeScreenChannel.html

Gets the description of the welcome screen channel.

```APIDOC
## Description Property

### Description
Gets the description of the welcome screen channel.

### Property Value
- `string` - The description of the channel.
```

--------------------------------

### TypingStart

Source: https://netcord.dev/docs/NetCord.Gateway.GatewayClient.html

Event triggered when a user starts typing in a channel.

```APIDOC
## TypingStart

### Description
Sent when a user starts typing in a channel, and fires again every 10 seconds while they continue typing.

### Event Type
Func<TypingStartEventArgs, ValueTask>

### Remarks
Required Intents: GuildMessageTyping, DirectMessageTyping
Optional Intents: None
```

--------------------------------

### Interaction

Source: https://netcord.dev/docs/NetCord.Services.ComponentInteractions.BaseModalInteractionContext.html

Gets the modal interaction that is being handled.

```APIDOC
## Interaction

### Description
Gets the modal interaction that is being handled.

### Property Value
ModalInteraction

### Example
```csharp
ModalInteraction interaction = context.Interaction;
```
```

--------------------------------

### Name Property

Source: https://netcord.dev/docs/NetCord.Services.ApplicationCommands.SubSlashCommandGroupBuilder.html

Gets the name of the command.

```APIDOC
## Name Property

### Description
Gets the name of the command (1-32 characters).

### Property
`public string Name { get; }`

### Property Value
- **string** - The name of the command.

```

--------------------------------

### AddEntryPointCommand(IHost, string, string)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostExtensions.html

Adds an entry point command with the specified name and description.

```APIDOC
## AddEntryPointCommand(IHost, string, string)

### Description
Adds an entry point command with the specified name and description.

### Method
AddEntryPointCommand

### Endpoint
EntryPointCommandBuilder AddEntryPointCommand(this IHost host, string name, string description)

### Parameters
#### Parameters
- **host** (IHost) - Required - The host to which the command is added.
- **name** (string) - Required - The name of the command.
- **description** (string) - Required - The description of the command.

### Returns
EntryPointCommandBuilder - A builder for configuring the command.

### Example
```csharp
host.AddEntryPointCommand("help", "Shows help");
```
```

--------------------------------

### Initialize()

Source: https://netcord.dev/docs/NetCord.Gateway.Compression.UncompressedGatewayCompression.html

Initializes the compression instance. This method is called to prepare the instance for use.

```APIDOC
## Method: Initialize()

### Description
Initializes the compression instance. This method is called to prepare the instance for use.

### Signature
```csharp
public void Initialize()
```

### Parameters
None.

### Returns
Void.
```

--------------------------------

### Description Property

Source: https://netcord.dev/docs/NetCord.Services.ApplicationCommands.SubSlashCommandGroupBuilder.html

Gets the description of the command.

```APIDOC
## Description Property

### Description
Gets the description of the command (1-100 characters).

### Property
`public string Description { get; }`

### Property Value
- **string** - The description of the command.

```

--------------------------------

### Interaction Property

Source: https://netcord.dev/docs/NetCord.Services.ApplicationCommands.BaseSlashCommandContext.html

Gets the interaction that is being handled.

```APIDOC
## Interaction Property

### Description
Gets the interaction that is being handled.

### Property
`public SlashCommandInteraction Interaction { get; }`

### Property Value
- **Interaction** (SlashCommandInteraction) - The interaction that is being handled.

```

--------------------------------

### ConfigureApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures application command services with generic interaction, context, and autocomplete context types, and an options configuration action.

```APIDOC
## ConfigureApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>>)

### Description
Configures application command services with generic interaction, context, and autocomplete context types, and an options configuration action.

### Method
Extension method

### Signature
public static IHostBuilder ConfigureApplicationCommands<TInteraction, TContext, TAutocompleteContext>(this IHostBuilder builder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>> configureOptions) where TInteraction : ApplicationCommandInteraction where TContext : IApplicationCommandContext where TAutocompleteContext : IAutocompleteInteractionContext

### Type Parameters
- **TInteraction** - The interaction type.
- **TContext** - The context type.
- **TAutocompleteContext** - The autocomplete context type.

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>>) - Required - The configuration action for the options.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### GetActiveGuildThreadsAsync

Source: https://netcord.dev/docs/NetCord.Rest.RestClient.html

Gets the active threads in a guild.

```APIDOC
## GetActiveGuildThreadsAsync

### Description
Gets the active threads in a guild.

### Method
Async method

### Signature
`public Task<IReadOnlyList<GuildThread>> GetActiveGuildThreadsAsync(ulong guildId, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)`

### Parameters
- **guildId** (ulong) - Required - The ID of the guild.
- **properties** (RestRequestProperties) - Optional - Optional properties to customize the request, can be null.
- **cancellationToken** (CancellationToken) - Optional - A token that can be used to cancel the operation before it completes.

### Returns
Task<IReadOnlyList<GuildThread>>
```

--------------------------------

### ConfigureApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions, IServiceProvider>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures application command services with an options configuration action that receives the service provider.

```APIDOC
## ConfigureApplicationCommands(IHostBuilder, Action<ApplicationCommandServiceOptions, IServiceProvider>)

### Description
Configures application command services with an options configuration action that receives the service provider.

### Method
Extension method

### Signature
public static IHostBuilder ConfigureApplicationCommands(this IHostBuilder builder, Action<ApplicationCommandServiceOptions, IServiceProvider> configureOptions)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions, IServiceProvider>) - Required - The configuration action that receives the options and service provider.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### UseApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Registers application command services with the host builder, allowing configuration of the service options.

```APIDOC
## UseApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>>)

### Description
Registers application command services with the host builder, allowing configuration of the service options.

### Method
UseApplicationCommands

### Signature
public static IHostBuilder UseApplicationCommands<TInteraction, TContext, TAutocompleteContext>(this IHostBuilder builder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>> configureOptions) where TInteraction : ApplicationCommandInteraction where TContext : IApplicationCommandContext where TAutocompleteContext : IAutocompleteInteractionContext

### Parameters
- **builder** (IHostBuilder) - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>>) - A delegate to configure the application command service options.

### Type Parameters
- **TInteraction** - The type of the interaction.
- **TContext** - The type of the context.
- **TAutocompleteContext** - The type of the autocomplete context.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### GetWidgetUrl

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Gets the ImageUrl of a guild widget.

```APIDOC
## GetWidgetUrl

### Description
Gets the ImageUrl of a guild widget.

### Method
GetWidgetUrl

### Signature
public ImageUrl GetWidgetUrl(GuildWidgetStyle? style = null, string hostname = "discord.com", ApiVersion? version = null)

### Parameters
- **style** (GuildWidgetStyle?) - Optional - The style of the widget. If null, uses the default style.
- **hostname** (string) - Optional - The hostname to use for the API request.
- **version** (ApiVersion?) - Optional - The API version to use.

### Returns
ImageUrl - An ImageUrl pointing to the guild widget.

### Remarks
This ImageUrl does not support setting size.
```

--------------------------------

### VerificationLevel

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Gets the VerificationLevel required for the RestGuild.

```APIDOC
### VerificationLevel

Gets the VerificationLevel required for the RestGuild.

```csharp
public VerificationLevel VerificationLevel { get; }
```

#### Property Value

VerificationLevel
```

--------------------------------

### RegisteredApplicationCommand<TContext> Constructor

Source: https://netcord.dev/docs/NetCord.Services.ApplicationCommands.RegisteredApplicationCommand-1.html

Initializes a new instance of the RegisteredApplicationCommand struct with the specified ID and command info.

```APIDOC
## Constructor: RegisteredApplicationCommand(ulong, ApplicationCommandInfo<TContext>)

### Description
Initializes a new instance of the RegisteredApplicationCommand struct with the specified ID and command info.

### Signature
```csharp
public RegisteredApplicationCommand(ulong Id, ApplicationCommandInfo<TContext> Info)
```

### Parameters
- **Id** (ulong) - Required - The unique identifier of the command.
- **Info** (ApplicationCommandInfo<TContext>) - Required - The command information associated with this registration.
```

--------------------------------

### ConfigureApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures application command services with generic interaction, context, and autocomplete context types, and an options configuration action that receives the service provider.

```APIDOC
## ConfigureApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider>)

### Description
Configures application command services with generic interaction, context, and autocomplete context types, and an options configuration action that receives the service provider.

### Method
Extension method

### Signature
public static IHostBuilder ConfigureApplicationCommands<TInteraction, TContext, TAutocompleteContext>(this IHostBuilder builder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider> configureOptions) where TInteraction : ApplicationCommandInteraction where TContext : IApplicationCommandContext where TAutocompleteContext : IAutocompleteInteractionContext

### Type Parameters
- **TInteraction** - The interaction type.
- **TContext** - The context type.
- **TAutocompleteContext** - The autocomplete context type.

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider>) - Required - The configuration action that receives the options and service provider.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### Id

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Gets the RestGuild's ID.

```APIDOC
## Property

### Id

Gets the RestGuild's ID.

#### Property Value
- **Type**: ulong
- **Access**: get

```

--------------------------------

### DefaultMessageNotificationLevel

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Gets the RestGuild's DefaultMessageNotificationLevel.

```APIDOC
## Property

### DefaultMessageNotificationLevel

Gets the RestGuild's DefaultMessageNotificationLevel.

#### Property Value
- **Type**: DefaultMessageNotificationLevel
- **Access**: get

```

--------------------------------

### JsonMediaGalleryComponent Constructor

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonMediaGalleryComponent.html

Initializes a new instance of the JsonMediaGalleryComponent class.

```APIDOC
## Constructor

### JsonMediaGalleryComponent()

Initializes a new instance of the JsonMediaGalleryComponent class.

```csharp
public JsonMediaGalleryComponent()
```
```

--------------------------------

### ContentFilter

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Gets the RestGuild's ContentFilter.

```APIDOC
## Property

### ContentFilter

Gets the RestGuild's ContentFilter.

#### Property Value
- **Type**: ContentFilter
- **Access**: get

```

--------------------------------

### UseApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.ApplicationCommands.ApplicationCommandServiceHostBuilderExtensions.html

Configures the host to use application commands with the specified interaction, context, and autocomplete context types and a configuration action that receives the service provider.

```APIDOC
## UseApplicationCommands<TInteraction, TContext, TAutocompleteContext>(IHostBuilder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider>)

### Description
Configures the host to use application commands with the specified interaction, context, and autocomplete context types and a configuration action that receives the service provider.

### Method
Extension Method

### Signature
public static IHostBuilder UseApplicationCommands<TInteraction, TContext, TAutocompleteContext>(this IHostBuilder builder, Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider> configureOptions) where TInteraction : ApplicationCommandInteraction where TContext : IApplicationCommandContext where TAutocompleteContext : IAutocompleteInteractionContext

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<ApplicationCommandServiceOptions<TInteraction, TContext, TAutocompleteContext>, IServiceProvider>) - Required - The configuration action for the application command service options.

### Type Parameters
- **TInteraction** - The type of the interaction.
- **TContext** - The type of the context.
- **TAutocompleteContext** - The type of the autocomplete context.

### Returns
- **IHostBuilder** - The configured host builder.
```

--------------------------------

### JsonGuildWelcomeScreen Constructor

Source: https://netcord.dev/docs/NetCord.JsonModels.JsonGuildWelcomeScreen.html

Initializes a new instance of the JsonGuildWelcomeScreen class.

```APIDOC
## JsonGuildWelcomeScreen()

### Description
Initializes a new instance of the JsonGuildWelcomeScreen class.

### Method
Constructor

### Signature
`public JsonGuildWelcomeScreen()`

### Parameters
None.

### Return Value
A new instance of the JsonGuildWelcomeScreen class.

```

--------------------------------

### Placeholder

Source: https://netcord.dev/docs/NetCord.Rest.MenuProperties.html

Gets or sets the placeholder text.

```APIDOC
## [Property] Placeholder

### Description
Gets or sets the placeholder text if nothing is selected (max 150 characters).

### Property Value
- **string?** - The placeholder text, or null if not set.
```

--------------------------------

### ParentId

Source: https://netcord.dev/docs/NetCord.Rest.MenuProperties.html

Gets or sets the parent identifier.

```APIDOC
## [Property] ParentId

### Description
Gets or sets the parent identifier for the component.

### Property Value
- **int?** - The parent identifier, or null if not set.
```

--------------------------------

### MediaGalleryProperties()

Source: https://netcord.dev/docs/NetCord.Rest.MediaGalleryProperties.html

Initializes a new instance of the MediaGalleryProperties class.

```APIDOC
## MediaGalleryProperties()

### Description
Initializes a new instance of the MediaGalleryProperties class.

### Method
Constructor

### Signature
`public MediaGalleryProperties()`

```

--------------------------------

### EndedAt

Source: https://netcord.dev/docs/NetCord.Rest.MessageCall.html

Gets the timestamp of when the call ended.

```APIDOC
## EndedAt

### Description
Gets the timestamp of when the call ended.

### Property
`public DateTimeOffset? EndedAt { get; }`

### Property Value
- **DateTimeOffset?** - The timestamp of the call's end, or null if not set.

```

--------------------------------

### CreateApplicationCommandAsync(ulong, ApplicationCommandProperties, RestRequestProperties?, CancellationToken)

Source: https://netcord.dev/docs/NetCord.Rest.RestGuild.html

Creates a new application command for the guild.

```APIDOC
## CreateApplicationCommandAsync

### Description
Creates a new application command for the guild.

### Method
CreateApplicationCommandAsync

### Signature
`public Task<GuildApplicationCommand> CreateApplicationCommandAsync(ulong applicationId, ApplicationCommandProperties applicationCommandProperties, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)`

### Parameters
- **applicationId** (ulong) - Required - The ID of the application.
- **applicationCommandProperties** (ApplicationCommandProperties) - Required - The properties of the command to create.
- **properties** (RestRequestProperties?) - Optional - Optional request properties.
- **cancellationToken** (CancellationToken) - Optional - A token to cancel the operation.

### Returns
Task<GuildApplicationCommand> - A task representing the asynchronous operation, with the created command.
```

--------------------------------

### GuildVanityInvite.Code

Source: https://netcord.dev/docs/NetCord.Rest.GuildVanityInvite.html

Gets the code of the vanity invite.

```APIDOC
## GuildVanityInvite.Code

### Description
Gets the code of the vanity invite.

### Property
`public string Code { get; }`

### Property Value
- **string** - The invite code.

```

--------------------------------

### HandleAsync(GatewayClient, TypingStartEventArgs)

Source: https://netcord.dev/docs/NetCord.Hosting.Gateway.ITypingStartShardedGatewayHandler.html

Handles the typing start gateway event. Provides the gateway client representing the shard and the event arguments.

```APIDOC
## HandleAsync(GatewayClient, TypingStartEventArgs)

### Description
Handles the gateway event for when a user starts typing in a channel.

### Method
HandleAsync

### Parameters
- **client** (GatewayClient) - The gateway client that represents the shard that received the event.
- **arg** (TypingStartEventArgs) - The event argument.

### Returns
ValueTask
```

--------------------------------

### Title

Source: https://netcord.dev/docs/NetCord.Rest.EmbedProperties.html

Gets or sets the title of the embed.

```APIDOC
## [Property] Title

### Description
Gets or sets the title text of the embed, placed above the description, with a 256 character limit. When Url is set, the title becomes a clickable link.

### Property Type
string?

### Attributes
- `[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]`
- `[JsonPropertyName("title")]`

### Access
Get/Set

### Example
```csharp
embed.Title = "Example Title";
```
```

--------------------------------

### UseCommands(IHostBuilder, Action<CommandServiceOptions<CommandContext>>)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.Commands.CommandServiceHostBuilderExtensions.html

Adds command services to the host builder and configures options.

```APIDOC
## UseCommands(IHostBuilder, Action<CommandServiceOptions<CommandContext>>)

### Description
Adds command services to the host builder and configures options.

### Method
UseCommands

### Signature
public static IHostBuilder UseCommands(this IHostBuilder builder, Action<CommandServiceOptions<CommandContext>> configureOptions)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.
- **configureOptions** (Action<CommandServiceOptions<CommandContext>>) - Required - A delegate to configure the command service options.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### Timestamp

Source: https://netcord.dev/docs/NetCord.Rest.EmbedProperties.html

Gets or sets the timestamp of the embed.

```APIDOC
## [Property] Timestamp

### Description
Gets or sets the timestamp displayed in the embed, located next to the footer if set.

### Property Type
DateTimeOffset?

### Attributes
- `[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]`
- `[JsonPropertyName("timestamp")]`

### Access
Get/Set

### Example
```csharp
embed.Timestamp = DateTimeOffset.UtcNow;
```
```

--------------------------------

### Property: Prompts

Source: https://netcord.dev/docs/NetCord.Rest.GuildOnboarding.html

Gets the prompts shown during onboarding and in customize community.

```APIDOC
## Property: Prompts

### Description
Prompts shown during onboarding and in customize community.

### Property Value
- **Type**: IReadOnlyList<GuildOnboardingPrompt>
- **Access**: Read-only

### Example
```csharp
IReadOnlyList<GuildOnboardingPrompt> prompts = onboarding.Prompts;
```
```

--------------------------------

### Footer

Source: https://netcord.dev/docs/NetCord.Rest.EmbedProperties.html

Gets or sets the footer of the embed.

```APIDOC
## [Property] Footer

### Description
Gets or sets the footer text of the embed, limited to 2048 characters.

### Property Type
EmbedFooterProperties?

### Attributes
- `[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]`
- `[JsonPropertyName("footer")]`

### Access
Get/Set

### Example
```csharp
embed.Footer = new EmbedFooterProperties() { Text = "Footer" };
```
```

--------------------------------

### BaseApplicationCommandContext Class

Source: https://netcord.dev/docs/NetCord.Services.ApplicationCommands.BaseApplicationCommandContext.html

Documentation for the BaseApplicationCommandContext class, including its constructor and Interaction property.

```APIDOC
## Class BaseApplicationCommandContext

### Description
Base context for handling application command interactions.

### Namespace
NetCord.Services.ApplicationCommands

### Assembly
NetCord.Services.dll

### Inheritance
object → BaseApplicationCommandContext

### Implements
- IApplicationCommandContext
- IInteractionContext
- IContext

### Derived
- ApplicationCommandContext
- HttpApplicationCommandContext

### Constructors

#### BaseApplicationCommandContext(ApplicationCommandInteraction interaction)

Creates a new instance of the context with the specified interaction.

**Parameters**
- `interaction` (ApplicationCommandInteraction) - The interaction that is being handled.

### Properties

#### Interaction

Gets the interaction that is being handled.

**Property Value**
- `ApplicationCommandInteraction` - The interaction that is being handled.
```

--------------------------------

### ComponentType Property

Source: https://netcord.dev/docs/NetCord.Rest.ActionRowProperties.html

Gets the type of the component.

```APIDOC
## ComponentType Property

### Description
Gets the type of the component.

### Property Value
- **ComponentType** - The type of the component.

### Syntax
```csharp
[JsonPropertyName("type")]
public ComponentType ComponentType { get; }
```

```

--------------------------------

### UseCommands(IHostBuilder)

Source: https://netcord.dev/docs/NetCord.Hosting.Services.Commands.CommandServiceHostBuilderExtensions.html

Adds command services to the host builder.

```APIDOC
## UseCommands(IHostBuilder)

### Description
Adds command services to the host builder.

### Method
UseCommands

### Signature
public static IHostBuilder UseCommands(this IHostBuilder builder)

### Parameters
- **builder** (IHostBuilder) - Required - The host builder to configure.

### Returns
IHostBuilder - The configured host builder.
```

--------------------------------

### MessageReactionEmoji.Name

Source: https://netcord.dev/docs/NetCord.MessageReactionEmoji.html

Gets the emoji's name.

```APIDOC
## Property: Name

### Description
Gets the emoji's name.

### Signature
csharp
public string? Name { get; }


### Property Value
- **string?** - The emoji's name, or `null` if not available.

```
Tokens:
Raw