Documentation - Docs Should Follow its Own Advice to Implement All Message Types

[hack-r]

Make sure the issue is related to code located in this repository.

• [X] I confirm that the reported bug or feature request is not related to Botpress on premise version (v12 and below)
• [X] I confirm that the reported bug or feature request is not related to the Botpress Studio
• [X] I confirm that the reported bug or feature request is not related to the Botpress Dashboard

Description of the bug or feature request

The SDK documentation states:

For now, we will only implement the text message. The defaults object that comes from the SDK is used to define the default messages that the integration supports. We highly recommend implementing all message types provided by the SDK.

If it's highly recommended to implement all message types provided by the SDK, perhaps the docs should implement all types provided by the SDK? Otherwise, it's unclear how to follow this very important recommendation. Also, using Telegram group chat as the only example seems like an unusual choice that won't apply to most users.

So I guess it would be something like

      messages: {
        audio: messages.defaults.audio,
        card: messages.defaults.card,
        carousel: messages.defaults.carousel,
        choice: messages.defaults.choice,
        dropdown: messages.defaults.dropdown,
        file: messages.defaults.file,
        image: messages.defaults.image,
        location: messages.defaults.location,
        markdown: messages.defaults.markdown,
        text: messages.defaults.text,
        video: messages.defaults.video
      }

[franklevasseur]

hey @hack-r ,

Sorry for the confusion, the doc is unfortunately outdated.

What integration are you trying to build ?

The truth is that most integrations are not messaging channels and don't need to implement any outgoing message handler at all.

You take a look at the googlecalendar integration for an example of a non-messaging integration: https://github.com/botpress/botpress/blob/master/integrations/googlecalendar/integration.definition.ts

[franklevasseur]

will close this issue for lack of activity, feel free to reopen if needed.