Class CurrentApplicationOptions

Namespace

NetCord.Rest

Assembly

NetCord.dll

Represents a modification to apply to the bot user's current application.

public class CurrentApplicationOptions

Inheritance

object

CurrentApplicationOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CoverImage

The application's cover image.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("cover_image")]
public ImageProperties? CoverImage { get; set; }

Property Value

ImageProperties?

CustomInstallUrl

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

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("custom_install_url")]
public string? CustomInstallUrl { get; set; }

Property Value

string

Description

The application's description.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("description")]
public string? Description { get; set; }

Property Value

string

EventWebhooksStatus

The application's configuration for webhook events.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("event_webhooks_status")]
public ApplicationEventWebhooksStatus? EventWebhooksStatus { get; set; }

Property Value

ApplicationEventWebhooksStatus?

EventWebhooksTypes

A list of event webhook types that the application supports.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("event_webhooks_types")]
public IEnumerable<string>? EventWebhooksTypes { get; set; }

Property Value

IEnumerable<string>

EventWebhooksUrl

The application's event webhooks URL to receive webhook events.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("event_webhooks_url")]
public string? EventWebhooksUrl { get; set; }

Property Value

string

Flags

The application's public flags.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("flags")]
public ApplicationFlags? Flags { get; set; }

Property Value

ApplicationFlags?

Icon

The application's icon.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("icon")]
public ImageProperties? Icon { get; set; }

Property Value

ImageProperties?

InstallParams

The application's default in-application authorization URL if enabled, otherwise null.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("install_params")]
public ApplicationInstallParamsProperties? InstallParams { get; set; }

Property Value

ApplicationInstallParamsProperties

IntegrationTypesConfiguration

A list of the application's default scopes and permissions, for each supported installation context.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("integration_types_config")]
public IReadOnlyDictionary<ApplicationIntegrationType, ApplicationIntegrationTypeConfigurationProperties>? IntegrationTypesConfiguration { get; set; }

Property Value

IReadOnlyDictionary<ApplicationIntegrationType, ApplicationIntegrationTypeConfigurationProperties>

InteractionsEndpointUrl

The application's interactions endpoint URL.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("interactions_endpoint_url")]
public string? InteractionsEndpointUrl { get; set; }

Property Value

string

RoleConnectionsVerificationUrl

The application's role connection verification URL.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("role_connections_verification_url")]
public string? RoleConnectionsVerificationUrl { get; set; }

Property Value

string

Tags

A list of the application's tags, describing its content and functionality.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonPropertyName("tags")]
public IEnumerable<string>? Tags { get; set; }

Property Value

IEnumerable<string>

Remarks

A maximum of 5 tags is supported.

Methods

AddEventWebhooksTypes(params IEnumerable<string>)

A list of event webhook types that the application supports.

public CurrentApplicationOptions AddEventWebhooksTypes(params IEnumerable<string> eventWebhooksTypes)

Parameters

eventWebhooksTypes IEnumerable<string>

Returns

CurrentApplicationOptions

AddTags(params IEnumerable<string>)

A list of the application's tags, describing its content and functionality.

public CurrentApplicationOptions AddTags(params IEnumerable<string> tags)

Parameters

tags IEnumerable<string>

Returns

CurrentApplicationOptions

Remarks

A maximum of 5 tags is supported.

WithCoverImage(ImageProperties?)

The application's cover image.

public CurrentApplicationOptions WithCoverImage(ImageProperties? coverImage)

Parameters

coverImage ImageProperties?

Returns

CurrentApplicationOptions

WithCustomInstallUrl(string?)

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

public CurrentApplicationOptions WithCustomInstallUrl(string? customInstallUrl)

Parameters

customInstallUrl string

Returns

CurrentApplicationOptions

WithDescription(string?)

The application's description.

public CurrentApplicationOptions WithDescription(string? description)

Parameters

description string

Returns

CurrentApplicationOptions

WithEventWebhooksStatus(ApplicationEventWebhooksStatus?)

The application's configuration for webhook events.

public CurrentApplicationOptions WithEventWebhooksStatus(ApplicationEventWebhooksStatus? eventWebhooksStatus)

Parameters

eventWebhooksStatus ApplicationEventWebhooksStatus?

Returns

CurrentApplicationOptions

WithEventWebhooksTypes(IEnumerable<string>?)

A list of event webhook types that the application supports.

public CurrentApplicationOptions WithEventWebhooksTypes(IEnumerable<string>? eventWebhooksTypes)

Parameters

eventWebhooksTypes IEnumerable<string>

Returns

CurrentApplicationOptions

WithEventWebhooksUrl(string?)

The application's event webhooks URL to receive webhook events.

public CurrentApplicationOptions WithEventWebhooksUrl(string? eventWebhooksUrl)

Parameters

eventWebhooksUrl string

Returns

CurrentApplicationOptions

WithFlags(ApplicationFlags?)

The application's public flags.

public CurrentApplicationOptions WithFlags(ApplicationFlags? flags)

Parameters

flags ApplicationFlags?

Returns

CurrentApplicationOptions

WithIcon(ImageProperties?)

The application's icon.

public CurrentApplicationOptions WithIcon(ImageProperties? icon)

Parameters

icon ImageProperties?

Returns

CurrentApplicationOptions

WithInstallParams(ApplicationInstallParamsProperties?)

The application's default in-application authorization URL if enabled, otherwise null.

public CurrentApplicationOptions WithInstallParams(ApplicationInstallParamsProperties? installParams)

Parameters

installParams ApplicationInstallParamsProperties

Returns

CurrentApplicationOptions

WithIntegrationTypesConfiguration(IReadOnlyDictionary<ApplicationIntegrationType, ApplicationIntegrationTypeConfigurationProperties>?)

A list of the application's default scopes and permissions, for each supported installation context.

public CurrentApplicationOptions WithIntegrationTypesConfiguration(IReadOnlyDictionary<ApplicationIntegrationType, ApplicationIntegrationTypeConfigurationProperties>? integrationTypesConfiguration)

Parameters

integrationTypesConfiguration IReadOnlyDictionary<ApplicationIntegrationType, ApplicationIntegrationTypeConfigurationProperties>

Returns

CurrentApplicationOptions

WithInteractionsEndpointUrl(string?)

The application's interactions endpoint URL.

public CurrentApplicationOptions WithInteractionsEndpointUrl(string? interactionsEndpointUrl)

Parameters

interactionsEndpointUrl string

Returns

CurrentApplicationOptions

WithRoleConnectionsVerificationUrl(string?)

The application's role connection verification URL.

public CurrentApplicationOptions WithRoleConnectionsVerificationUrl(string? roleConnectionsVerificationUrl)

Parameters

roleConnectionsVerificationUrl string

Returns

CurrentApplicationOptions

WithTags(IEnumerable<string>?)

A list of the application's tags, describing its content and functionality.

public CurrentApplicationOptions WithTags(IEnumerable<string>? tags)

Parameters

tags IEnumerable<string>

Returns

CurrentApplicationOptions

Remarks

A maximum of 5 tags is supported.