Skip to content

GramIO API Reference / gramio/dist / Updates

Class: Updates

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

Constructors

Constructor

new Updates(bot, onError): Updates

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

Parameters

ParameterType
botAnyBot
onError(context, error) => unknown

Returns

Updates

Properties

PropertyTypeDefined in
composerEventComposer<Context<AnyBot>, TelegramEventMap, Context<AnyBot>, Context<AnyBot>, object, Record<string, object>, { callbackQuery: TThis; chosenInlineResult: TThis; command: TThis; hears: TThis; inlineQuery: TThis; reaction: TThis; startParameter: TThis; }, MacroDefinitions> & objectgramio/index.d.ts:839
isRequestActivebooleangramio/index.d.ts:837
isStartedbooleangramio/index.d.ts:836
queueEventQueue<TelegramUpdate>gramio/index.d.ts:840
stopPollingPromiseResolve(value?) => voidgramio/index.d.ts:841

Methods

dropPendingUpdates()

dropPendingUpdates(deleteWebhookOnConflict?): Promise<void>

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

Parameters

ParameterType
deleteWebhookOnConflict?boolean

Returns

Promise<void>


handleUpdate()

handleUpdate(data): Promise<void>

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

Parameters

ParameterType
dataTelegramUpdate

Returns

Promise<void>


startFetchLoop()

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

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

Parameters

ParameterType
params?GetUpdatesParams
options?PollingStartOptions

Returns

Promise<void>


startPolling()

startPolling(params?, options?): void

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

Internal

Parameters

ParameterType
params?GetUpdatesParams
options?PollingStartOptions

Returns

void

Deprecated

use bot.start instead


stopPolling()

stopPolling(waitPendingRequests?): Promise<void>

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

! Soon waitPendingRequests param default will changed to true

Parameters

ParameterType
waitPendingRequests?boolean

Returns

Promise<void>