GramIO API Reference / gramio/dist / Updates

Class: Updates

Defined in: gramio/index.d.ts:1196

Constructors

Constructor

new Updates(bot, onError): Updates

Defined in: gramio/index.d.ts:1204

Parameters

Parameter	Type
bot	AnyBot
onError	(context, error) => unknown

Returns

Updates

Properties

Property	Type	Defined in
composer	EventComposer<Context<AnyBot>, TelegramEventMap, Context<AnyBot>, Context<AnyBot>, object, Record<string, object>, { callbackQuery: TThis; chosenInlineResult: TThis; command: TThis; guestQuery: TThis; hears: TThis; inlineQuery: TThis; reaction: TThis; startParameter: TThis; }, MacroDefinitions> & object	gramio/index.d.ts:1201
isRequestActive	boolean	gramio/index.d.ts:1199
isStarted	boolean	gramio/index.d.ts:1198
queue	EventQueue<TelegramUpdate>	gramio/index.d.ts:1202
stopPollingPromiseResolve	(value?) => void	gramio/index.d.ts:1203

Methods

dropPendingUpdates()

dropPendingUpdates(deleteWebhookOnConflict?): Promise<void>

Defined in: gramio/index.d.ts:1209

Parameters

Parameter	Type
deleteWebhookOnConflict?	boolean

Returns

Promise<void>

---

handleUpdate()

handleUpdate(data): Promise<void>

Defined in: gramio/index.d.ts:1205

Parameters

Parameter	Type
data	TelegramUpdate

Returns

Promise<void>

---

startFetchLoop()

startFetchLoop(params?, options?): Promise<void>

Defined in: gramio/index.d.ts:1208

Parameters

Parameter	Type
params?	GetUpdatesParams
options?	PollingStartOptions

Returns

Promise<void>

---

startPolling()

startPolling(params?, options?): void

Defined in: gramio/index.d.ts:1207

Internal

Parameters

Parameter	Type
params?	GetUpdatesParams
options?	PollingStartOptions

Returns

void

Deprecated

use bot.start instead

---

stopPolling()

stopPolling(waitPendingRequests?): Promise<void>

Defined in: gramio/index.d.ts:1213

! Soon waitPendingRequests param default will changed to true

Parameters

Parameter	Type
waitPendingRequests?	boolean

Returns

Promise<void>