ZEGBot

4.2.8

Build your Telegram Bot with Swift! (works on macOS / Ubuntu)
ShaneQi/ZEGBot

What's New

Lowered Swift Requirement to `5.0`

2022-12-04T07:39:28Z

ZEGBot

CI Swift Version Platforms License

This library wraps the JSON decoding processing, making it easy to decode incoming JSON String to manipulatable objects.

This library wraps the processing of converting objects to Telegram Bot API request parameters and the processing of performing request, making it easy to handle incoming update.

Installation

Add this project as a dependency in your Package.swift file.

.package(url: "https://github.com/shaneqi/ZEGBot.git", from: Version(4, 2, 8))

Quick Start

Checkout the example here: ./Example.

Or you can just put the following code into main.swift of your project.

  • Sending messages directly:
import ZEGBot

// Don't forget to fill in your bot token.
let bot = ZEGBot(token: "TYPE YOUR TOKEN HERE")

do {
  try bot.send(message: "Hello world!", to: AnyChat(chatId: CHAT_ID))
} catch let error {
  NSLog("Bot exit due to: \(error)")
}
  • or responding to incoming messages/updates:
import ZEGBot

// Don't forget to fill in your bot token.
let bot = ZEGBot(token: "YOUR_BOT_TOKEN")

do {
  try bot.run { updates, bot in
    // Handle updates here...
  }
} catch let error {
  NSLog("Bot exit due to: \(error)")
}

Usage

  • Get text content of the incoming message:

    ...
    if let text = update.message?.text {
      // Do something.
    }
    ...
  • Get other type of content if exists:

    ...
    if let voice = update.message?.voice {
      // Do something.
    }
    ...
  • Send a text message to a chat:

    ...
    if let message = update.message {
      do {
        try bot.send(message: "bar", to: message.chat)
      } catch let error {
        NSLog("Failed to send message due to: \(error)")
      }
    }
    ...

    or

    ...
    do {
      try bot.send(message: "bar", to: AnyChat(chatId: CHAT_ID))
    } catch let error {
      NSLog("Failed to send message due to: \(error)")
    }
    ...
  • Send a silent message with a none-preview markdown link to a chat:

    ...
    do {
      try bot.send(
        message: "[Google](https://google.com)",
        to: AnyChat(chatId: CHAT_ID),
        parseMode: .markdown,
        disableWebPagePreview: true,
        disableNotification: true)
    } catch let error {
      NSLog("Failed to send message due to: \(error)")
    }
    ...
  • In all the sending methods, send to a Message Object means reply to this specific message. While Send to a Chat Object means send to this chat without replying to anyone.

    ...
    if let message = update?.message {
      do {
        /* This sends a message replying to another message. */
        try bot.send(message: "bar", to: message)
        /* This doesn't reply to a message. */
        try bot.send(message: "bar", to: message.chat)
      } catch let error {
        NSLog("Failed to send message due to: \(error)")
      }
    }
    ...

Support Types

  • Update
  • Message
  • Chat
  • User
  • MessageEntity
  • Audio
  • Document
  • PhotoSize
  • Sticker
  • Video
  • Voice
  • Contact
  • Location
  • Venue
  • File
  • ParseMode
  • ChatAction
  • ChatMember
  • InlineKeyboardButton
  • InlineKeyboardMarkup
  • CallbackQuery

Not all the types are supported, checkout more details on Telegram Bot API.

Support Methods

  • sendMessage
  • forwardMessage
  • sendPhoto
  • sendAudio
  • sendDocument
  • sendSticker
  • sendVideo
  • sendVoice
  • sendLocation
  • sendVenue
  • sendContact
  • sendChatAction
  • getFile
  • deleteMessage
  • getChatAdministrators
  • answerCallbackQuery
  • restrictChatMember
  • kickChatMember
  • editMessageText
  • editMessageCaption

Not all the methods are supported, checkout more details on Telegram Bot API.

Feature Requests are VERY WELCOME

The goal of this project is NOT keeping updated to the latest Telegram bot API, but to serve the community. So even though you don't see the API features you need in this project, please CONTACT ME, and I WILL do my best to add the features you requested.

License

This project is licensed under Apache License v2.0.

Description

  • Swift Tools 5.0.0
View More Packages from this Author

Dependencies

  • None
Last updated: Thu Feb 02 2023 17:09:08 GMT-0500 (GMT-05:00)