Class MessageButtonBuilder

a helper to build Button for oceanic.js

Hierarchy

MessageActionRowComponentsBuilder<NormalButtonComponent>
- MessageButtonBuilder

Index

Constructors

Accessors

customId disabled emoji label style type url

Methods

setCustomId setDisabled setEmoji setLabel setStyle setUrl toOceanic

Constructors

constructor

new MessageButtonBuilder(_data?): MessageButtonBuilder
Parameters
- Optional _data: NormalButtonComponent
Returns MessageButtonBuilder
Overrides MessageActionRowComponentsBuilder.constructor
- Defined in helper/component/button.ts:28

Accessors

customId

get customId(): undefined | string
Returns undefined | string
- Defined in helper/component/button.ts:43

disabled

get disabled(): boolean
Returns boolean
- Defined in helper/component/button.ts:47

emoji

get emoji(): undefined | NullablePartialEmoji
Returns undefined | NullablePartialEmoji
- Defined in helper/component/button.ts:51

label

get label(): undefined | string
Returns undefined | string
- Defined in helper/component/button.ts:55

style

get style(): undefined | ButtonStyles
Returns undefined | ButtonStyles
- Defined in helper/component/button.ts:59

type

get type(): BUTTON
Returns BUTTON
- Defined in helper/component/button.ts:63

url

get url(): undefined | string
Returns undefined | string
- Defined in helper/component/button.ts:67

Methods

setCustomId

setCustomId(customId): MessageButtonBuilder
Parameters
- customId: string
Returns MessageButtonBuilder
- Defined in helper/component/button.ts:71

setDisabled

setDisabled(disabled?): MessageButtonBuilder
Parameters
- disabled: boolean = true
Returns MessageButtonBuilder
- Defined in helper/component/button.ts:76

setEmoji

setEmoji(emoji): MessageButtonBuilder
Parameters
- emoji: string | Partial<PartialEmoji>
Returns MessageButtonBuilder
- Defined in helper/component/button.ts:81

setLabel

setLabel(label): MessageButtonBuilder
Parameters
- label: string
Returns MessageButtonBuilder
- Defined in helper/component/button.ts:97

setStyle

setStyle(style): MessageButtonBuilder
Parameters
- style: ButtonStyles
Returns MessageButtonBuilder
- Defined in helper/component/button.ts:102

setUrl

setUrl(url): MessageButtonBuilder
Parameters
- url: string
Returns MessageButtonBuilder
- Defined in helper/component/button.ts:107

toOceanic

toOceanic(): NormalButtonComponent
Returns NormalButtonComponent
Overrides MessageActionRowComponentsBuilder.toOceanic
- Defined in helper/component/button.ts:112

Generated using TypeDoc