@discord-types/builders/message/components/textInput
API reference for @discord-types/builders/message/components/textInput
@discord-types/builders/message/components/textInput
Types
TextInput
Raw Type
type TextInput = TextInput.Prototype, & {
customId: string?,
style: messageTypes.TextInputStyle?,
label: string?,
minLength: number?,
maxLength: number?,
required: boolean?,
value: string?,
placeholder: string?
}
Intersection with variants:
Variant 2
Prop | Type | Description |
---|---|---|
customId? | - | |
style? | - | |
label? | - | |
minLength? | - | |
maxLength? | - | |
required? | - | |
value? | - | |
placeholder? | - |
JSON
Raw Type
type JSON = apiTypes.TextInputComponentObject
apiTypes.TextInputComponentObject
Functions
TextInput.Prototype.setCustomId
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setCustomId(self: TextInput, customId: string) -> TextInput end
Arguments
customId
Returns
ret1
TextInput.Prototype.setStyle
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setStyle(self: TextInput, style: messageTypes.TextInputStyle) -> TextInput end
Arguments
style
Returns
ret1
TextInput.Prototype.setLabel
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setLabel(self: TextInput, label: string) -> TextInput end
Arguments
label
Returns
ret1
TextInput.Prototype.setMinLength
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setMinLength(self: TextInput, minLength: number) -> TextInput end
Arguments
minLength
Returns
ret1
TextInput.Prototype.setMaxLength
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setMaxLength(self: TextInput, maxLength: number) -> TextInput end
Arguments
maxLength
Returns
ret1
TextInput.Prototype.setIsRequired
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setIsRequired(self: TextInput, isRequired: boolean) -> TextInput end
Arguments
isRequired
Returns
ret1
TextInput.Prototype.setValue
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setValue(self: TextInput, value: string) -> TextInput end
Arguments
value
Returns
ret1
TextInput.Prototype.setPlaceholder
[[
]]
Function Signature
--[[
]]
function TextInput.Prototype.setPlaceholder(self: TextInput, placeholder: string) -> TextInput end
Arguments
placeholder
Returns
ret1
TextInput.Prototype.build
[[ Responsible for building the TextInput JSON that can be parsed by the Discord API. ]]
Function Signature
--[[
Responsible for building the TextInput JSON that can be parsed by the Discord API.
]]
function TextInput.Prototype.build(self: TextInput) -> JSON end
Returns
ret1
TextInput.Interface.new
[[ Responsible for creating a new TextInput.
```lua
``` ]]
Function Signature
--[[
Responsible for creating a new TextInput.
\`\`\`lua
\`\`\`
]]
function TextInput.Interface.new(resource: {
customId: string?,
style: messageTypes.TextInputStyle?,
label: string?,
minLength: number?,
maxLength: number?,
required: boolean?,
value: string?,
placeholder: string?
}?) -> TextInput end
Arguments
resource
This field is optional and may not be specified
{customId: string?, style: messageTypes.TextInputStyle?, label: string?, minLength: number?, maxLength: number?, required: boolean?, value: string?, placeholder: string?}?
Returns
ret1
Last updated on