Class Scene

Hierarchy

Event
- Scene

Constructors

constructor

new Scene(sceneName, options?): Scene
Parameters
- sceneName: string
- options: any = {}
Returns Scene
Overrides Event.constructor
- Defined in scene.ts:8

Properties

TOKEN

TOKEN: any

offset

offset: any

options

options: Options = {}

run

run: any

sceneName

sceneName: 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 scene.ts:652

approveJoinRequest

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

ban

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

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 scene.ts:100

declineJoinRequest

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

del

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

deleteWebhook

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

demote

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

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 scene.ts:66

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 scene.ts:682

exportChatInviteLink

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

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 scene.ts:83

getAdmins

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

getChat

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

getFile

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

getMe

getMe(): Promise<any>
Returns Promise<any>
- Defined in scene.ts:661

getMember

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

getMemberCount

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

getUserProfilePhotos

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

help

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

Parameters

listener: string | Function
options: Options = {}

Returns Promise<void>

Example

// It will send message when msg startsWith /help command
// Simple
bot.help("use /abc command to see more!") // you can also pass sendMessage options in second param

// You can use functions also
bot.help((msg, util)=> {
// Do here which you want
})

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 scene.ts:561

link

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

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 scene.ts:367

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

promote

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

request

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

revokeLink

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

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 scene.ts:322

sendAudio

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

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 scene.ts:276

sendDice

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

sendDoc

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

sendLocation

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

sendPhoto

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

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 scene.ts:293

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 scene.ts:257

sendVideo

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

start

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

Parameters

listener: string | Function
options: Options = {}

Returns Promise<void>

Example

// It will send message when msg startsWith /start command
// Simple
bot.start("Hello welcome!") // you can also pass sendMessage options in second param

// You can use functions also
bot.start((msg, util)=> {
// Do here which you want
})

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 scene.ts:352

unmute

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

unpin

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

unpinAll

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

Class Scene

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

sceneName: string

options: any = {}

Returns Scene

Properties

TOKEN

offset

options

run

sceneName

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>

edit

Parameters

chat: undefined | string | number

message_id: undefined | number

text: any