Home Explore Help
Register Sign In
devn00b
/
EQ2EMu-DiscordBot
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: eb0a7ab06a
Branches Tags
EQ2EMu-Disco...
/
vendor
/
team-reflex
/
discord-php
/
guide
/
interactions.rst

interactions.rst 10 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485 
  1. ============
    2. 

  2. Interactions
    3. 

  3. ============
    4. 

  4. 

  5. 

  6. Interactions are utilized in message components and slash commands.
    7. 

  7. 

  8. Attributes
    9. 

  9. ==========
    10. 

  10. 

  11. +----------------+----------------------+------------------------------------------------------+
    12. 

  12. | name           | type                 | description                                          |
    13. 

  13. +================+======================+======================================================+
    14. 

  14. | id             | string               | id of the interaction.                               |
    15. 

  15. +----------------+----------------------+------------------------------------------------------+
    16. 

  16. | application_id | string               | id of the application associated to the interaction. |
    17. 

  17. +----------------+----------------------+------------------------------------------------------+
    18. 

  18. | int            | type                 | type of interaction.                                 |
    19. 

  19. +----------------+----------------------+------------------------------------------------------+
    20. 

  20. | data           | ``?InteractionData`` | data associated with the interaction.                |
    21. 

  21. +----------------+----------------------+------------------------------------------------------+
    22. 

  22. | guild          | ``?Guild``           | guild interaction was triggered from, null if DM.    |
    23. 

  23. +----------------+----------------------+------------------------------------------------------+
    24. 

  24. | channel        | ``?Channel``         | channel interaction was triggered from.              |
    25. 

  25. +----------------+----------------------+------------------------------------------------------+
    26. 

  26. | member         | ``?Member``          | member that triggered interaction.                   |
    27. 

  27. +----------------+----------------------+------------------------------------------------------+
    28. 

  28. | user           | ``User``             | user that triggered interaction.                     |
    29. 

  29. +----------------+----------------------+------------------------------------------------------+
    30. 

  30. | token          | string               | internal token for responding to interaction.        |
    31. 

  31. +----------------+----------------------+------------------------------------------------------+
    32. 

  32. | version        | int                  | version of interaction.                              |
    33. 

  33. +----------------+----------------------+------------------------------------------------------+
    34. 

  34. | message        | ``?Message``         | message that triggered interaction.                  |
    35. 

  35. +----------------+----------------------+------------------------------------------------------+
    36. 

  36. | locale         | ?string              | The selected language of the invoking user.          |
    37. 

  37. +----------------+----------------------+------------------------------------------------------+
    38. 

  38. | guild_locale   | ?string              | The guild’s preferred locale, if invoked in a guild. |
    39. 

  39. +----------------+----------------------+------------------------------------------------------+
    40. 

  40. 

  41. The locale list can be seen on `Discord API reference <https://discord.com/developers/docs/reference#locales>`_.
    42. 

  42. 

  43. Functions on interaction create
    44. 

  44. ===============================
    45. 

  45. 

  46. The following functions are used to respond an interaction after being created ``Event::INTERACTION_CREATE``, responding interaction with wrong type throws a ``LogicException``
    47. 

  47. 

  48. +----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------+
    49. 

  49. | name                                                                                         | description                                                                 | valid for interaction type                                       |
    50. 

  50. +==============================================================================================+=============================================================================+==================================================================+
    51. 

  51. | ``acknowledgeWithResponse(?bool $ephemeral)``                                                | acknowledges the interaction, creating a placeholder response to be updated | ``APPLICATION_COMMAND``, ``MESSAGE_COMPONENT``, ``MODAL_SUBMIT`` |
    52. 

  52. +----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------+
    53. 

  53. | ``acknowledge()``                                                                            | defer the interaction                                                       | ``MESSAGE_COMPONENT``, ``MODAL_SUBMIT``                          |
    54. 

  54. +----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------+
    55. 

  55. | ``respondWithMessage(MessageBuilder $builder, ?bool $ephemeral)``                            | responds to the interaction with a message. ephemeral is default false      | ``APPLICATION_COMMAND``, ``MESSAGE_COMPONENT``, ``MODAL_SUBMIT`` |
    56. 

  56. +----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------+
    57. 

  57. | ``autoCompleteResult(array $choices)``                                                       | responds a suggestion to options with auto complete                         | ``APPLICATION_COMMAND_AUTOCOMPLETE``                             |
    58. 

  58. +----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------+
    59. 

  59. | ``showModal(string $title, string $custom_id, array $components, ?callable $submit = null)`` | responds to the interaction with a popup modal                              | ``MODAL_SUBMIT``                                                 |
    60. 

  60. +----------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+------------------------------------------------------------------+
    61. 

  61. 

  62. Functions after interaction response
    63. 

  63. ====================================
    64. 

  64. 

  65. The following functions can be only used after interaction respond above, otherwise throws a ``RuntimeException`` “Interaction has not been responded to.”
    66. 

  66. 

  67. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    68. 

  68. | name                                                                   | description                                                                                    | return               |
    69. 

  69. +========================================================================+================================================================================================+======================+
    70. 

  70. | ``updateMessage(MessageBuilder $message)``                             | updates the message the interaction was triggered from. only for message component interaction | ``Promise<void>``    |
    71. 

  71. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    72. 

  72. | ``getOriginalResponse()``                                              | gets the original interaction response                                                         | ``Promise<Message>`` |
    73. 

  73. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    74. 

  74. | ``updateOriginalResponse(MessageBuilder $message)``                    | updates the original interaction response                                                      | ``Promise<Message>`` |
    75. 

  75. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    76. 

  76. | ``deleteOriginalResponse()``                                           | deletes the original interaction response                                                      | ``Promise<void>``    |
    77. 

  77. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    78. 

  78. | ``sendFollowUpMessage(MessageBuilder $builder, ?bool $ephemeral)``     | sends a follow up message to the interaction. ephemeral is defalt false                        | ``Promise<Message>`` |
    79. 

  79. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    80. 

  80. | ``getFollowUpMessage(string $message_id)``                             | gets a non ephemeral follow up message from the interaction                                    | ``Promise<Message>`` |
    81. 

  81. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    82. 

  82. | ``updateFollowUpMessage(string $message_id, MessageBuilder $builder)`` | updates the follow up message of the interaction                                               | ``Promise<Message>`` |
    83. 

  83. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    84. 

  84. | ``deleteFollowUpMessage(string $message_id)``                          | deletes a follow up message from the interaction                                               | ``Promise<void>``    |
    85. 

  85. +------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+----------------------+
    86.