API Reference

This section contains an index of all the API reference pages for flare.

If you think anything is missing, feel free to open an issue or pull request.

---

Index

• Component API Reference
  • CallbackComponent
    • CallbackComponent.from_partial()
    • CallbackComponent.get_from()
    • CallbackComponent.cookie
    • CallbackComponent.custom_id
  • Component
    • Component.build()
    • Component.custom_id
    • Component.width
  • SupportsCookie
    • SupportsCookie.cookie
• Button API Reference
  • Button
    • Button.build()
    • Button.width
  • LinkButton
    • LinkButton.build()
    • LinkButton.custom_id
    • LinkButton.width
  • button
    • button.component_type
    • button.kwargs
• Select API Reference
  • ChannelSelect
    • ChannelSelect.build()
  • MentionableSelect
  • RoleSelect
  • TextSelect
    • TextSelect.build()
  • UserSelect
  • channel_select
    • channel_select.component_type
    • channel_select.kwargs
  • mentionable_select
    • mentionable_select.component_type
  • role_select
    • role_select.component_type
  • text_select
    • text_select.component_type
    • text_select.kwargs
  • user_select
    • user_select.component_type
• Modal API Reference
  • Modal
    • Modal.insert()
    • Modal.send()
    • Modal.cookie
  • ModalComponent
  • TextInput
    • TextInput.build()
    • TextInput.custom_id
    • TextInput.width
• Context API Reference
  • MessageContext
    • MessageContext.get_components()
    • MessageContext.channels
    • MessageContext.mentionables
    • MessageContext.message
    • MessageContext.roles
    • MessageContext.users
    • MessageContext.values
  • ModalContext
    • ModalContext.components
    • ModalContext.values
  • InteractionResponse
    • InteractionResponse.delete()
    • InteractionResponse.edit()
    • InteractionResponse.retrieve_message()
  • PartialContext
    • PartialContext.defer()
    • PartialContext.edit_response()
    • PartialContext.get_channel()
    • PartialContext.get_guild()
    • PartialContext.get_last_response()
    • PartialContext.respond()
    • PartialContext.app
    • PartialContext.app_permissions
    • PartialContext.author
    • PartialContext.bot
    • PartialContext.channel_id
    • PartialContext.custom_id
    • PartialContext.guild_id
    • PartialContext.guild_locale
    • PartialContext.interaction
    • PartialContext.locale
    • PartialContext.member
    • PartialContext.responses
    • PartialContext.user
• Converters API Reference
  • Converter
    • Converter.type
  • EnumConverter
  • IntConverter
  • StringConverter
  • add_converter()
• Exceptions API Reference
  • ConverterError
  • FlareException
• Internal API
  • Serde API Reference
    • Serde
      • Serde.deserialize()
      • Serde.escape()
      • Serde.serialize()
      • Serde.split_on_sep()
      • Serde.tuple_list_to_string()
      • Serde.unescape()
      • Serde.ESC
      • Serde.NULL
      • Serde.SEP
      • Serde.VER
  • Event Handler API Reference
    • on_inter()