Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Telegram Bot response message ID #35904

Open
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

tyron
Copy link
Contributor

@tyron tyron commented Nov 22, 2024

Proposed change

This feature documents the new returned data (on response_variable) from Telegram Bot integration. Using this new feature when sending content via Telegram allows to perform following actions such as editing or deleting the message, as shown in the new example.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Enhanced Telegram bot integration to return message_id and chat_id for delivered messages, enabling better management of sent messages.
    • Added a new example automation for sending a message and deleting it after a specified delay, demonstrating the sequence of actions involved.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Nov 22, 2024
Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new feature to the Telegram bot integration, enhancing the functionality of actions that send content. Specifically, actions like send_message and send_photo will now return a list of message_id and chat_id for delivered messages, encapsulated in a property called chats. Additionally, a new example automation is provided, demonstrating how to send a message and delete it after a delay, utilizing the identifiers from the response.

Changes

File Path Change Summary
source/_integrations/telegram_bot.markdown Added a new section detailing the return of message_id and chat_id for actions sending content. Included a new example automation for sending and deleting a message.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TelegramBot

    User->>TelegramBot: send_message("testing")
    TelegramBot-->>User: response(chats: [{message_id, chat_id}])
    User->>TelegramBot: wait(5 seconds)
    User->>TelegramBot: delete_message(message_id, chat_id)
    TelegramBot-->>User: confirmation(deleted)
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 695cbcc and cf75a58.

📒 Files selected for processing (1)
  • source/_integrations/telegram_bot.markdown (2 hunks)
🔇 Additional comments (2)
source/_integrations/telegram_bot.markdown (2)

22-23: LGTM! Clear and well-structured documentation of the new feature.

The description effectively explains:

  • What actions return the data (send_* actions)
  • The structure of the returned data (list of message_id/chat_id in chats property)
  • How to use it (via response data)
  • Practical applications (edit/delete messages)

610-633: LGTM! Excellent example demonstrating the new feature.

The automation example is well-structured and demonstrates:

  • Proper use of response_variable to capture the response
  • Correct iteration over response.chats
  • Practical use case of deleting a message after delay
  • Proper template syntax and YAML formatting

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Nov 22, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit cf75a58
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6740ab8c65e483000863cfcf
😎 Deploy Preview https://deploy-preview-35904--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
source/_integrations/telegram_bot.markdown (1)

610-634: Consider standardizing the delay format for better readability.

While the automation example is functionally correct and well-structured, the delay section could be simplified for better readability.

Consider this format instead:

  - delay:
-     hours: 0
-     minutes: 0
-     seconds: 5
-     milliseconds: 0
+     seconds: 5

The current format with explicit zero values for hours, minutes, and milliseconds adds unnecessary verbosity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9d5da7a and 91e5cc7.

📒 Files selected for processing (1)
  • source/_integrations/telegram_bot.markdown (2 hunks)
🔇 Additional comments (1)
source/_integrations/telegram_bot.markdown (1)

22-23: LGTM! Clear documentation of the new response data feature.

The documentation clearly explains that send actions now return message and chat IDs, and properly references how to use this data in automations.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
source/_integrations/telegram_bot.markdown (1)

22-23: Fix typo in feature description

There's a typo in the word "delievered" - it should be "delivered".

-Actions that send contents (`send_*`) will return a list of `message_id`/`chat_id` for messages delievered (in a property called `chats`).
+Actions that send contents (`send_*`) will return a list of `message_id`/`chat_id` for messages delivered (in a property called `chats`).
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 91e5cc7 and 695cbcc.

📒 Files selected for processing (1)
  • source/_integrations/telegram_bot.markdown (2 hunks)
🔇 Additional comments (1)
source/_integrations/telegram_bot.markdown (1)

615-631: LGTM! Well-structured example demonstrating the new feature

The example automation effectively demonstrates:

  • Using response_variable to capture message details
  • Proper iteration over response.chats
  • Correct usage of message_id and chat_id for message deletion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant