Class Tgind

Hierarchy

Event
- Tgind

Constructors

constructor

new Tgind(TOKEN, options?): Tgind
Parameters
- TOKEN: any
- options: {
      dropUpdates?: any;
      scene?: any;
      start?: boolean;
      timeout?: any;
      ttl?: any;
  } = {}
  - Optional dropUpdates?: any
  - Optional scene?: any
  - Optional start?: boolean
  - Optional timeout?: any
  - Optional ttl?: any
Returns Tgind
Overrides Event.constructor
- Defined in tgind.ts:30

Properties

TOKEN

TOKEN: any

offset

offset: any

options

options: Options = {}

run

run: any

scene

scene: any = {}

Methods

all

all(callback): Promise<void>
Parameters
- callback: Function
Returns Promise<void>
Inherited from Event.all
- Defined in tg/event.ts:119

ansQuery

ansQuery(query_id, text, options?): Promise<any>
Parameters
- query_id: any
- text: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:696

approveJoinRequest

approveJoinRequest(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:533

ban

ban(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:381

command

command(cmd, callback): Promise<void>
Parameters
- cmd: any
- callback: any
Returns Promise<void>
Inherited from Event.command
- Defined in tg/event.ts:96

copy

copy(chat, from_chat, message_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- from_chat: undefined | string | number
- message_id: undefined | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:144

declineJoinRequest

declineJoinRequest(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:548

del

del(chat, message_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- message_id: undefined | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:283

deleteWebhook

deleteWebhook(drop_pending_updates?): Promise<any>
Parameters
- drop_pending_updates: any = true
Returns Promise<any>
Overrides Event.deleteWebhook
- Defined in tgind.ts:715

demote

demote(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:474

edit

edit(chat, message_id, text, options?): Promise<any>
Parameters
- chat: undefined | string | number
- message_id: undefined | number
- text: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:110

enter

enter(listener, options?): Promise<void>
Parameters
- listener: string | boolean | Function
- options: Options = {}
Returns Promise<void>
Inherited from Event.enter
- Defined in tg/event.ts:165

error

error(msg, options?): never
Parameters
- msg: any
- options: Options = {}
Returns never
- Defined in tgind.ts:726

exportChatInviteLink

exportChatInviteLink(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:491

forword

forword(chat, from_chat, message_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- from_chat: undefined | string | number
- message_id: undefined | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:127

getAdmins

getAdmins(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:631

getChat

getChat(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:618

getFile

getFile(file_id, options?): Promise<any>
Parameters
- file_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:672

getMe

getMe(): Promise<any>
Returns Promise<any>
- Defined in tgind.ts:705

getMember

getMember(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:658

getMemberCount

getMemberCount(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:644

getUserProfilePhotos

getUserProfilePhotos(user_id, options?): Promise<any>
Parameters
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:683

handleUpdate

handleUpdate(update, options?): Promise<void>
Parameters
- update: Options
- options: Options = {}
Returns Promise<void>
- Defined in tgind.ts:753

help

help(str): Promise<void>
Parameters
- str: any
Returns Promise<void>
Overrides Event.help
- Defined in tgind.ts:743

launch

launch(options?): Promise<undefined | false>
Parameters
- options: Options = {}
Returns Promise<undefined | false>
- Defined in tgind.ts:785

leave

leave(listener, options?): Promise<void>

Parameters

listener: string | Function
options: Options = {}

Returns Promise<void>

Example

// use function inside leave
echoScene.leave((msg, util)=> {
msg.send("Entered in echo scene")
})

// Or directly pass string
echoScene.leave("Entered in echo scene")

leaveChat

leaveChat(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:605

link

link(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:504

matches

matches(str, callback): Promise<void>
Parameters
- str: any
- callback: any
Returns Promise<void>
Inherited from Event.matches
- Defined in tg/event.ts:133

mute

mute(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:411

pin(chat, message_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- message_id: undefined | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:563

promote

promote(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:449

request

request(method, options, headers?): Promise<any>
Parameters
- method: string
- options: any
- headers: Options = {}
Returns Promise<any>
Overrides Event.request
- Defined in tgind.ts:57

revokeLink

revokeLink(chat, invite_link, options?): Promise<any>
Parameters
- chat: undefined | string | number
- invite_link: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:518

send

send(chat, text, options?): Promise<any>

Parameters

chat: undefined | string | number
text: any
options: Options = {}

Returns Promise<any>

Example

bot.send(-100123456789, "Hello");
or you can use directly without giving chatid by using context object of your listener

Example

bot.on("message", ctx => ctx.send("Hello"))

sendAction

sendAction(chat, action, options?): Promise<any>
Parameters
- chat: undefined | string | number
- action: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:366

sendAudio

sendAudio(chat, file, options?): Promise<any>
Parameters
- chat: undefined | string | number
- file: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:186

sendContact

sendContact(chat, phone_number, first_name, options?): Promise<any>
Parameters
- chat: undefined | string | number
- phone_number: any
- first_name: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:320

sendDice

sendDice(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:352

sendDoc

sendDoc(chat, doc, options?): Promise<any>
Parameters
- chat: undefined | string | number
- doc: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:256

sendLocation

sendLocation(chat, latitude, longitude, options?): Promise<any>
Parameters
- chat: undefined | string | number
- latitude: any
- longitude: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:240

sendPhoto

sendPhoto(chat, file, options?): Promise<any>
Parameters
- chat: undefined | string | number
- file: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:160

sendPoll

sendPoll(chat, question, your_options, options?): Promise<any>
Parameters
- chat: undefined | string | number
- question: any
- your_options: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:337

sendVenue

sendVenue(chat, latitude, longitude, title, address, options?): Promise<any>
Parameters
- chat: undefined | string | number
- latitude: any
- longitude: any
- title: any
- address: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:301

sendVideo

sendVideo(chat, file, options?): Promise<any>
Parameters
- chat: undefined | string | number
- file: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:213

start

start(str): Promise<void>
Parameters
- str: any
Returns Promise<void>
Overrides Event.start
- Defined in tgind.ts:735

stop

stop(options?): Promise<any>
Parameters
- options: Options = {}
Returns Promise<any>
Inherited from Event.stop
- Defined in tg/event.ts:293

unban

unban(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:396

unmute

unmute(chat, user_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- user_id: any
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:430

unpin

unpin(chat, message_id, options?): Promise<any>
Parameters
- chat: undefined | string | number
- message_id: undefined | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:578

unpinAll

unpinAll(chat, options?): Promise<any>
Parameters
- chat: undefined | string | number
- options: Options = {}
Returns Promise<any>
- Defined in tgind.ts:592

Class Tgind

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

TOKEN: any

options: { dropUpdates?: any; scene?: any; start?: boolean; timeout?: any; ttl?: any; } = {}

Optional dropUpdates?: any

Optional scene?: any

Optional start?: boolean

Optional timeout?: any

Optional ttl?: any

Returns Tgind

Properties

TOKEN

offset

options

run

scene

Methods

all

Parameters

callback: Function

Returns Promise<void>

ansQuery

Parameters

query_id: any

text: undefined | string | number

options: Options = {}

Returns Promise<any>

approveJoinRequest

Parameters

chat: undefined | string | number

user_id: any

options: Options = {}

Returns Promise<any>

ban

Parameters

chat: undefined | string | number

user_id: any

options: Options = {}

Returns Promise<any>

command

Parameters

cmd: any

callback: any

Returns Promise<void>

copy

Parameters

chat: undefined | string | number

from_chat: undefined | string | number

message_id: undefined | number

options: Options = {}

Returns Promise<any>

declineJoinRequest

Parameters

chat: undefined | string | number

user_id: any

options: Options = {}

Returns Promise<any>

del

Parameters

chat: undefined | string | number

message_id: undefined | number

options: Options = {}

Returns Promise<any>

deleteWebhook

Parameters

drop_pending_updates: any = true

Returns Promise<any>

demote

Parameters

chat: undefined | string | number

user_id: any

options: Options = {}

Returns Promise<any>

options: {
dropUpdates?: any;
scene?: any;
start?: boolean;
timeout?: any;
ttl?: any;
} = {}

`Optional` dropUpdates?: any

`Optional` scene?: any

`Optional` start?: boolean

`Optional` timeout?: any

`Optional` ttl?: any