TelegramAPI | RaccoonJS API

Hierarchy

TelegramAPI

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TelegramAPI(token: string, host: string): TelegramAPI

- Defined in TelegramAPI.ts:25
TelegramAPI constructor

Parameters
- token: string
  
  Bot token
- host: string
  
  Public secure url
Returns TelegramAPI

Properties

Private callbackQueryHandler

callbackQueryHandler: QueryHandler = null

Private host

host: string

Public secure url

Private state

state: Map<string, (ctx: Message) => void> = new Map<string, CommandHandler>()

Private token

token: string

Bot token

Methods

answerCallbackQuery

answerCallbackQuery(id: string, text: string, showAlert?: boolean): Promise<boolean>

Implementation of API.answerCallbackQuery
- Defined in TelegramAPI.ts:168
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Parameters
- id: string
  
  Unique identifier for the query to be answered.
- text: string
  
  Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters.
- Default value showAlert: boolean = false
  
  Default: false. If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
Returns Promise<boolean>

cmd

cmd(name: string, handler: CommandHandler): Map<string, CommandHandler>

- Defined in TelegramAPI.ts:186
Use this method register the command message.

Parameters
- name: string
  
  Command name (without "/" charater).
- handler: CommandHandler
  
  Command hanlder (executed when a message sent by a user matches the command message that is registered).
Returns Map<string, CommandHandler>

delCmd

delCmd(name: string): boolean

- Defined in TelegramAPI.ts:194
Use this method to unregister the command message.

Parameters
- name: string
  
  Command name (include "/" charater, e.q: "/command-name").
Returns boolean

deleteText

deleteText(chatId: ChatId, msgId: number): Promise<boolean>

Implementation of API.deleteText
- Defined in TelegramAPI.ts:111
Use this method to delete a message, including service messages, with the following limitations:
- A message can only be deleted if it was sent less than 48 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.
Parameters
- chatId: ChatId
  
  Unique identifier for the target chat or username of the target channel (in the format @channelusername)
- msgId: number
  
  Identifier of the message to delete.
Returns Promise<boolean>

editMessageCaption

editMessageCaption(chatId: ChatId, msgId: number, opt?: editCaptionOpt): Promise<Message>

Implementation of API.editMessageCaption
- Defined in TelegramAPI.ts:149
Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Parameters
- chatId: ChatId
  
  Unique identifier for the target chat or username of the target channel (in the format @channelusername).
- msgId: number
  
  Identifier of the message to edit.
- Optional opt: editCaptionOpt
  
  Optional parameter. See.
Returns Promise<Message>

editText

editText(chatId: ChatId, msgId: number, opt?: editTextOpt): Promise<Message>

Implementation of API.editText
- Defined in TelegramAPI.ts:86
Use this method to edit text messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Parameters
- chatId: ChatId
  
  Unique identifier for the target chat or username of the target channel (in the format @channelusername)
- msgId: number
  
  Identifier of the message to edit.
- Optional opt: editTextOpt
  
  Optional parameter. See
Returns Promise<Message>

Private forwardUpdate

forwardUpdate(update: Update): void

- Defined in TelegramAPI.ts:215
Receive updates from the webhook and proceed to the corresponding handler.

Parameters
- update: Update
  
  Update from Telegram server.
Returns void

on

on(event: "callback_query", handler: QueryHandler): void

- Defined in TelegramAPI.ts:204
Use this method to set a handler for specific events.

Parameters
- event: "callback_query"
  
  Event name, e.q: "callback_query".
- handler: QueryHandler
  
  Query handler.
Returns void

sendPhoto

sendPhoto(chatId: ChatId, photo: PathLike, opt?: sendPhotoOpt): Promise<Message>

Implementation of API.sendPhoto
- Defined in TelegramAPI.ts:129
Use this method to send photos. On success, the sent Message is returned.

Parameters
- chatId: ChatId
  
  Unique identifier for the target chat or username of the target channel (in the format @channelusername)
- photo: PathLike
  
  Path photo to send.
- Optional opt: sendPhotoOpt
  
  Optional parameter. See
Returns Promise<Message>

sendText

sendText(chatId: ChatId, text: string, opt?: SendTextOpt): Promise<Message>

Implementation of API.sendText
- Defined in TelegramAPI.ts:72
Use this method to send text messages. On success, the sent Message is returned.

Parameters
- chatId: ChatId
  
  Unique identifier for the target chat or username of the target channel (in the format @channelusername)
- text: string
  
  Text of the message to be sent
- Optional opt: SendTextOpt
  
  Optional parameter. See
Returns Promise<Message>

startWebhook

startWebhook(endpoint: string, port: number, cb: () => void): TelegramAPI

- Defined in TelegramAPI.ts:40
Use this method to start the webhook server to receive incoming updates from the Telegram server when the user sends a message or request.

Parameters
- endpoint: string
  
  Secret path to receive incoming updates
- port: number
  
  protocol port.
- cb: () => void
  
  callback function called when the server is started.
  - - (): void
    - Returns void
Returns TelegramAPI

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

token: string

host: string

Returns TelegramAPI

Properties

Private callbackQueryHandler

Private host

Private state

Private token

Methods

answerCallbackQuery

Parameters

id: string

text: string

Default value showAlert: boolean = false

Returns Promise<boolean>

cmd

Parameters

name: string

handler: CommandHandler

Returns Map<string, CommandHandler>

delCmd

Parameters

name: string

Returns boolean

deleteText

Parameters

chatId: ChatId

msgId: number

Returns Promise<boolean>

editMessageCaption

Parameters

chatId: ChatId

msgId: number

Optional opt: editCaptionOpt

Returns Promise<Message>

editText

Parameters

chatId: ChatId

msgId: number

Optional opt: editTextOpt

Returns Promise<Message>

Private forwardUpdate

Parameters

update: Update

Returns void

on

Parameters

event: "callback_query"

handler: QueryHandler

Returns void

sendPhoto

Parameters

chatId: ChatId

photo: PathLike

Optional opt: sendPhotoOpt

Returns Promise<Message>

sendText

Parameters

chatId: ChatId

text: string

Optional opt: SendTextOpt

Returns Promise<Message>

startWebhook

Parameters

endpoint: string

port: number

cb: () => void

Returns void

Returns TelegramAPI