Class Updates

Index

Constructors

Properties

api composed composer options pollingTransport upload webhookTransport

Accessors

Methods

dispatchMiddleware getKoaWebhookMiddleware getWebhookCallback handlePollingUpdate handleWebhookUpdate on recompose start startPolling startWebhook stop use

Constructors

constructor

new Updates(__namedParameters): Updates
Constructor
Parameters
- __namedParameters: Partial<IUpdatesOptions> & {
  api: API;
  upload: Upload;
  }
Returns Updates
- Defined in packages/vk-io/src/updates/updates.ts:379

Properties

`Private` api

api: API

`Private` composed

composed: Middleware<Context<object, ContextDefaultState, string, string>>

`Private` composer

composer: Composer<Context<object, ContextDefaultState, string, string> & UnknownObject, Context<object, ContextDefaultState, string, string>> = ...

`Private` options

options: Omit<IUpdatesOptions, "api" | "upload">

`Private` pollingTransport

pollingTransport: PollingTransport

`Private` upload

upload: Upload

`Private` webhookTransport

webhookTransport: WebhookTransport

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
- Defined in packages/vk-io/src/updates/updates.ts:420

isStarted

get isStarted(): boolean
Checks is started

Returns boolean
- Defined in packages/vk-io/src/updates/updates.ts:427

Methods

dispatchMiddleware

dispatchMiddleware(context): Promise<void>
Calls up the middleware chain
Parameters
- context: Context<object, ContextDefaultState, string, string>
Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:743

getKoaWebhookMiddleware

getKoaWebhookMiddleware(): WebhookTransportKoaCallback
Returns the middleware for the webhook under koa

Returns WebhookTransportKoaCallback
- Defined in packages/vk-io/src/updates/updates.ts:736

getWebhookCallback

getWebhookCallback(path?): WebhookTransportCallback
Returns webhook callback like http[s] or express
Parameters
- Optional path: string
Returns WebhookTransportCallback
- Defined in packages/vk-io/src/updates/updates.ts:729

handlePollingUpdate

handlePollingUpdate(update): Promise<void>
Handles longpoll event
Parameters
- update: any[]
Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:612

handleWebhookUpdate

handleWebhookUpdate(update): Promise<void>
Handles webhook event
Parameters
- update: Record<string, any>
Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:639

on

on<T>(events, handler): this
Subscribe to events
Type Parameters
- T = object
Parameters
- events: AllowArray<"comment" | CommentContextSubType>
- handler: AllowArray<Middleware<CommentContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:449
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"dialog_flags" | DialogFlagsContextSubType>
- handler: AllowArray<Middleware<DialogFlagsContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:454
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"dialog_notification_settings" | DialogNotificationSettingsContextSubType>
- handler: AllowArray<Middleware<DialogNotificationSettingsContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:459
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"group_member" | GroupMemberContextSubType>
- handler: AllowArray<Middleware<GroupMemberContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:465
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"group_update" | GroupUpdateContextSubType>
- handler: AllowArray<Middleware<GroupUpdateContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:470
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"group_user" | GroupUserContextSubType>
- handler: AllowArray<Middleware<GroupUserContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:475
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"message_subscription" | MessageSubscriptionContextSubType>
- handler: AllowArray<Middleware<MessageSubscriptionContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:480
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"message_flags" | MessageFlagsContextSubType>
- handler: AllowArray<Middleware<MessageFlagsContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:485
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"message_event">
- handler: AllowArray<Middleware<MessageEventContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:490
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"message" | MessageContextSubType>
- handler: AllowArray<Middleware<MessageContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:495
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"new_attachment" | NewAttachmentsContextSubType>
- handler: AllowArray<Middleware<NewAttachmentsContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:500
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"messages_read" | MessagesReadContextSubType>
- handler: AllowArray<Middleware<MessagesReadContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:505
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"dialog_messages" | "dialog_messages_delete">
- handler: AllowArray<Middleware<DialogMessagesContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:510
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"typing" | TypingContextSubType>
- handler: AllowArray<Middleware<TypingContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:515
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"friend_activity" | FriendActivityContextSubType>
- handler: AllowArray<Middleware<FriendActivityContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:520
on<T, P>(events, handler): this
Type Parameters
- T = object
- P extends Record<string, any> = object
Parameters
- events: AllowArray<"vk_app_event" | "app_payload">
- handler: AllowArray<Middleware<VKAppPayloadContext<ContextDefaultState, P> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:526
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"vk_pay_transaction" | "vkpay_transaction">
- handler: AllowArray<Middleware<VKPayTransactionContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:531
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"poll_vote_new" | "vote">
- handler: AllowArray<Middleware<VoteContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:536
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"wall_post" | WallPostContextSubType>
- handler: AllowArray<Middleware<WallPostContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:541
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"like" | LikeContextSubType>
- handler: AllowArray<Middleware<LikeContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:546
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"market_order" | MarketOrderContextSubType>
- handler: AllowArray<Middleware<MarketOrderContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:552
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"donut_subscription" | DonutSubscriptionContextSubType>
- handler: AllowArray<Middleware<DonutSubscriptionContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:557
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"donut_subscription_price_changed" | "donut_subscription_price">
- handler: AllowArray<Middleware<DonutSubscriptionPriceContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:562
on<T>(events, handler): this
Type Parameters
- T = object
Parameters
- events: AllowArray<"donut_withdraw" | DonutWithdrawContextSubType>
- handler: AllowArray<Middleware<DonutWithdrawContext<ContextDefaultState> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:567
on<T, P>(events, handler): this
Type Parameters
- T = object
- P extends Record<string, any> = object
Parameters
- events: AllowArray<"unsupported_event">
- handler: AllowArray<Middleware<UnsupportedEventContext<ContextDefaultState, P> & T>>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:573

`Protected` recompose

recompose(): void
Reloads middleware

Returns void
- Defined in packages/vk-io/src/updates/updates.ts:750

start

start(__namedParameters?): Promise<void>
Automatically determines the settings to run
Parameters
- __namedParameters: {
  webhook?: IWebhookTransportStartOptions;
  } = {}
  - Optional webhook?: IWebhookTransportStartOptions
Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:684

startPolling

startPolling(): Promise<void>
Starts to poll server

Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:660

startWebhook

startWebhook(options?): Promise<void>
Starts the webhook server
Parameters
- options: IWebhookTransportStartOptions = {}
Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:677

stop

stop(): Promise<void>
Stopping gets updates

Returns Promise<void>
- Defined in packages/vk-io/src/updates/updates.ts:719

use

use<T>(middleware): this
Added middleware
Type Parameters
- T = object
Parameters
- middleware: Middleware<Context<object, ContextDefaultState, string, string> & T>
Returns this
- Defined in packages/vk-io/src/updates/updates.ts:434

Class Updates

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: Partial<IUpdatesOptions> & { api: API; upload: Upload; }

Returns Updates

Properties

Private api

Private composed

Private composer

Private options

Private pollingTransport

Private upload

Private webhookTransport

Accessors

[toStringTag]

Returns string

isStarted

Returns boolean

Methods

dispatchMiddleware

Parameters

context: Context<object, ContextDefaultState, string, string>

Returns Promise<void>

getKoaWebhookMiddleware

Returns WebhookTransportKoaCallback

getWebhookCallback

Parameters

Optional path: string

Returns WebhookTransportCallback

handlePollingUpdate

Parameters

update: any[]

Returns Promise<void>

handleWebhookUpdate

Parameters

update: Record<string, any>

Returns Promise<void>

on

Type Parameters

T = object

Parameters

events: AllowArray<"comment" | CommentContextSubType>

handler: AllowArray<Middleware<CommentContext<ContextDefaultState> & T>>

Returns this

Type Parameters

T = object

Parameters

events: AllowArray<"dialog_flags" | DialogFlagsContextSubType>

handler: AllowArray<Middleware<DialogFlagsContext<ContextDefaultState> & T>>

Returns this

Type Parameters

T = object

Parameters

events: AllowArray<"dialog_notification_settings" | DialogNotificationSettingsContextSubType>

handler: AllowArray<Middleware<DialogNotificationSettingsContext<ContextDefaultState> & T>>

Returns this

Type Parameters

T = object

Parameters

events: AllowArray<"group_member" | GroupMemberContextSubType>

handler: AllowArray<Middleware<GroupMemberContext<ContextDefaultState> & T>>

Returns this

Type Parameters

T = object

Parameters

events: AllowArray<"group_update" | GroupUpdateContextSubType>

handler: AllowArray<Middleware<GroupUpdateContext<ContextDefaultState> & T>>

Returns this

Type Parameters

T = object

Parameters

events: AllowArray<"group_user" | GroupUserContextSubType>

handler: AllowArray<Middleware<GroupUserContext<ContextDefaultState> & T>>

Returns this

__namedParameters: Partial<IUpdatesOptions> & {
api: API;
upload: Upload;
}

`Private` api

`Private` composed

`Private` composer

`Private` options

`Private` pollingTransport

`Private` upload

`Private` webhookTransport

`Optional` path: string