Carbon
CoreClasses

LinkButton

Extends

  • BaseButton

Constructors

new LinkButton()

new LinkButton(data?): LinkButton

Parameters

ParameterType
data?object
data.additionalData?ComponentAdditionalData

Returns

LinkButton

Inherited from

BaseButton.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited from
additionalDatapublicnull | ComponentAdditionalDatanull--BaseButton.additionalData
customIdpublicstring""The custom ID of the componentBaseButton.customId-
deferpublicbooleanfalseWhether the component response should be automatically deferred-BaseButton.defer
disabledpublicbooleanfalseThe disabled state of the button-BaseButton.disabled
emoji?publicobjectundefinedThe emoji of the button-BaseButton.emoji
emoji.animated?publicbooleanundefined---
emoji.id?publicstringundefined---
emoji.namepublicstringundefined---
ephemeralpublicbooleanfalseWhether the component response should be ephemeral-BaseButton.ephemeral
labelabstractstringundefinedThe label of the button-BaseButton.label
stylepublicLinkButtonStyle.LinkThe style of the buttonBaseButton.style-
typepublicComponentTypeComponentType.ButtonThe type of the component-BaseButton.type
urlabstractstringundefinedThe URL that the button links to--

Methods

createId()

createId(additionalData): string

Create a custom ID to use for this component that embeds additional data that you want to be handed

Parameters

ParameterTypeDescription
additionalDatanull | ComponentAdditionalDataThe additional data that you want to be passed in this component's custom ID

Returns

string

The custom ID to use

Inherited from

BaseButton.createId


serialize()

serialize(): APIButtonComponentWithURL

Returns

APIButtonComponentWithURL

Overrides

BaseButton.serialize

On this page

Edit on GitHub